ptolemy.backtrack.automatic.ptolemy.actor.lib
Class PhaseUnwrap
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.backtrack.automatic.ptolemy.actor.lib.PhaseUnwrap
- 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 PhaseUnwrap
- extends Transformer
- implements Rollbackable
This actor unwraps a phase plot, removing discontinuities of
magnitude 2*PI. The input is assumed to be a sequence of phases in
radians in the range [-PI, PI]. The input and output types
are double. This actor assumes that the phase never
changes by more than PI in one sample period. This is not a very
sophisticated phase unwrapper, but for many applications, it does
the job.
- Since:
- Ptolemy II 1.0
- Version:
- $Id: PhaseUnwrap.java 57040 2010-01-27 20:52:32Z cxh $
- Author:
- Joe Buck and Edward A. Lee and Elaine Cheong
- See Also:
- Serialized Form
- Accepted Rating:
- Proposed Rating:
Fields inherited from class ptolemy.kernel.util.NamedObj |
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS |
Constructor Summary |
PhaseUnwrap(CompositeEntity container,
java.lang.String name)
Construct an actor with the given container and name. |
Method Summary |
private double |
$ASSIGN$_previousPhaseInput(double newValue)
|
private double |
$ASSIGN$_previousPhaseOutput(double newValue)
|
private double |
$ASSIGN$_tempPreviousPhaseInput(double newValue)
|
private double |
$ASSIGN$_tempPreviousPhaseOutput(double newValue)
|
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 |
fire()
Consume at most one input token and output a value that
represents the same angle, but differs from the previous output
(or from 0.0, if this is the first output), by less than 2*PI. |
void |
initialize()
Reset the state of the actor to assume the most recently seen
phase is zero. |
boolean |
postfire()
Record the final value of the most recent value of the input,
for use in the next phase. |
Methods inherited from class ptolemy.actor.AtomicActor |
_actorFiring, _actorFiring, addActorFiringListener, addInitializable, clone, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, prefire, 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.util.NamedObj |
_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _recordDecoratedAttributes, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeChanged, 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 |
$CHECKPOINT
protected transient Checkpoint $CHECKPOINT
_previousPhaseInput
private double _previousPhaseInput
_tempPreviousPhaseInput
private double _tempPreviousPhaseInput
_previousPhaseOutput
private double _previousPhaseOutput
_tempPreviousPhaseOutput
private double _tempPreviousPhaseOutput
$RECORD$$CHECKPOINT
protected transient CheckpointRecord $RECORD$$CHECKPOINT
$RECORD$_previousPhaseInput
private transient FieldRecord $RECORD$_previousPhaseInput
$RECORD$_tempPreviousPhaseInput
private transient FieldRecord $RECORD$_tempPreviousPhaseInput
$RECORD$_previousPhaseOutput
private transient FieldRecord $RECORD$_previousPhaseOutput
$RECORD$_tempPreviousPhaseOutput
private transient FieldRecord $RECORD$_tempPreviousPhaseOutput
$RECORDS
private transient FieldRecord[] $RECORDS
PhaseUnwrap
public PhaseUnwrap(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.
fire
public void fire()
throws IllegalActionException
- Consume at most one input token and output a value that
represents the same angle, but differs from the previous output
(or from 0.0, if this is the first output), by less than 2*PI.
If there is no input token, then no output is produced.
- Specified by:
fire
in interface Executable
- Overrides:
fire
in class AtomicActor
- Throws:
IllegalActionException
- If there is no director.
initialize
public void initialize()
throws IllegalActionException
- Reset the state of the actor to assume the most recently seen
phase is zero.
- Specified by:
initialize
in interface Initializable
- Overrides:
initialize
in class AtomicActor
- Throws:
IllegalActionException
- If the parent class throws it.
postfire
public boolean postfire()
throws IllegalActionException
- Record the final value of the most recent value of the input,
for use in the next phase.
- Specified by:
postfire
in interface Executable
- Overrides:
postfire
in class AtomicActor
- Returns:
- True if execution can continue into the next iteration.
- Throws:
IllegalActionException
- If the base class throws it.
$ASSIGN$_previousPhaseInput
private final double $ASSIGN$_previousPhaseInput(double newValue)
$ASSIGN$_tempPreviousPhaseInput
private final double $ASSIGN$_tempPreviousPhaseInput(double newValue)
$ASSIGN$_previousPhaseOutput
private final double $ASSIGN$_previousPhaseOutput(double newValue)
$ASSIGN$_tempPreviousPhaseOutput
private final double $ASSIGN$_tempPreviousPhaseOutput(double newValue)
$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)