ptolemy.actor.lib.gui
Class ArrayPlotter

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.gui.PlotterBase
                              ptolemy.actor.lib.gui.Plotter
                                  ptolemy.actor.lib.gui.ArrayPlotter

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Actor, Executable, FiringsRecordable, Placeable, Initializable, SequenceActor, TypedActor, Changeable, Configurable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

Direct Known Subclasses:

BarGraph

public class ArrayPlotter
extends Plotter
implements SequenceActor

A plotter that plots a sequence of arrays of doubles. This plotter contains an instance of the Plot class from the Ptolemy plot package as a public member. Data at the input, which can consist of any number of channels, are plotted on this instance. Each input channel is plotted as a separate data set. Each input token is an array of doubles.

The iterationsPerUpdate parameter can be used to fine tune the display. It can be quite expensive to generate the display, and by default, this actor generates it on every firing. If iterationsPerUpdate is set to some integer greater than one, then it specifies how many iterations should be executed between updates. Thus, if iterationsPerUpdate = 2, then every second time this actor fires, it will update the display. That is, it will update its display on the first firing, the third, the fifth, etc. It will, however, consume its inputs on every firing. The plot is always updated in the wrapup() method.

Note that this can be used to generate live plots, like SequenceScope, but it has fewer drawing artifacts than SequenceScope since it does not use XOR drawing mode.

Since:

Ptolemy II 3.0

Version:

$Id: ArrayPlotter.java 57040 2010-01-27 20:52:32Z cxh $

Author:

Edward A. Lee

See Also:

SequenceScope, Serialized Form

Accepted Rating:

Red (cxh)

Proposed Rating:

Yellow (eal)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.actor.lib.gui.PlotterBase

PlotterBase.PlotWindowTableau

Nested classes/interfaces inherited from class ptolemy.kernel.Entity

Entity.ContainedObjectsIterator

Field Summary

private int	_iteration
private int	_offset
private ArrayToken[]	_tokens
protected double	_xInit Start of the X axis counter.
protected double	_xUnit Increment of the X axis counter.
TypedIOPort	input Input port, which receives an array of doubles.
Parameter	iterationsPerUpdate The number of iterations between updates of the display on the screen.
Parameter	xInit The start point of the X axis.
Parameter	xUnit The increment of the X axis.

Fields inherited from class ptolemy.actor.lib.gui.Plotter

startingDataset

Fields inherited from class ptolemy.actor.lib.gui.PlotterBase

_base, _container, _frame, _plotSize, _source, _tableau, _text, _windowProperties, automaticRescale, fillOnWrapup, legend, plot

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

ArrayPlotter(CompositeEntity container, java.lang.String name)
Construct an actor with the given container and name.

Method Summary

void	attributeChanged(Attribute attribute) Notification that an attribute has changed.
void	initialize() If the plot has not already been created, create it.
boolean	postfire() Read at most one token from each input channel and plot it as a function of the iteration number, scaled by xUnit.
void	wrapup() Update the plot with the most recently read data.

Methods inherited from class ptolemy.actor.lib.gui.PlotterBase

_exportMoMLContents, _implementDeferredConfigurations, _newPlot, _propagateValue, clone, configure, getConfigureSource, getConfigureText, place, preinitialize, setContainer, setDisplayName, setName

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, fire, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, prefire, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, stop, stopFire, terminate

Methods inherited from class ptolemy.kernel.ComponentEntity

_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence

Methods inherited from class ptolemy.kernel.Entity

_description, _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, _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, 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

fire, isFireFunctional, isStrict, iterate, prefire, stop, stopFire, terminate

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, removeInitializable

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getDisplayName, getFullName, getName, getName

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Field Detail

input

public TypedIOPort input

Input port, which receives an array of doubles.

iterationsPerUpdate

public Parameter iterationsPerUpdate

The number of iterations between updates of the display on the screen. This parameter has type IntToken, with default value 1. Its value must be non-negative.

xUnit

public Parameter xUnit

The increment of the X axis.

xInit

public Parameter xInit

The start point of the X axis.

_xInit

protected double _xInit

Start of the X axis counter.

_xUnit

protected double _xUnit

Increment of the X axis counter.

_iteration

private int _iteration

_offset

private int _offset

_tokens

private ArrayToken[] _tokens

Constructor Detail

ArrayPlotter

public ArrayPlotter(CompositeEntity container,
                    java.lang.String name)
             throws IllegalActionException,
                    NameDuplicationException

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

Notification that an attribute has changed.

Overrides:

attributeChanged in class Plotter

Parameters:

attribute - The attribute that changed.

Throws:

IllegalActionException - If the expression of the attribute cannot be parsed or cannot be evaluated.

initialize

public void initialize()
                throws IllegalActionException

If the plot has not already been created, create it. If configurations specified by a call to configure() have not yet been processed, process them. This overrides the base class to also start counting iterations, so that the iterationsPerUpdate parameter works.

Specified by:

initialize in interface Initializable

Overrides:

initialize in class Plotter

Throws:

IllegalActionException - If the parent class throws it.

postfire

public boolean postfire()
                 throws IllegalActionException

Read at most one token from each input channel and plot it as a function of the iteration number, scaled by xUnit. The first point is plotted at the horizontal position given by xInit. The increments on the position are given by xUnit. The input data are plotted in postfire() to ensure that the data have settled.

Specified by:

postfire in interface Executable

Overrides:

postfire in class AtomicActor

Returns:

True if it is OK to continue.

Throws:

IllegalActionException - If there is no director, or if the base class throws it.

wrapup

public void wrapup()
            throws IllegalActionException

Update the plot with the most recently read data. If the fillOnWrapup parameter is true, rescale the plot so that all the data is visible.

Specified by:

wrapup in interface Initializable

Overrides:

wrapup in class PlotterBase

Throws:

IllegalActionException - If the superclass throws it.