ptolemy.actor.lib.gui
Class ArrayPlotter

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.gui.PlotterBase
                              extended byptolemy.actor.lib.gui.Plotter
                                  extended byptolemy.actor.lib.gui.ArrayPlotter
All Implemented Interfaces:
ptolemy.actor.Actor, ptolemy.kernel.util.Changeable, java.lang.Cloneable, ptolemy.kernel.util.Configurable, 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, ptolemy.actor.gui.Placeable, SequenceActor, java.io.Serializable, ptolemy.actor.TypedActor
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,v 1.9 2004/04/13 03:05:55 cxh Exp $
Author:
Edward A. Lee
See Also:
SequenceScope, Serialized Form
Accepted Rating:
Red (cxh)
Proposed Rating:
Yellow (eal)

Nested Class Summary
 
Nested classes inherited from class ptolemy.actor.lib.gui.PlotterBase
PlotterBase.PlotterPlotFrame, PlotterBase.PlotWindowTableau
 
Nested classes inherited from class ptolemy.kernel.Entity
ptolemy.kernel.Entity.ContainedObjectsIterator
 
Field Summary
protected  double _xInit
          Start of the X axis counter.
protected  double _xUnit
          Increment of the X axis counter.
 ptolemy.actor.TypedIOPort input
          Input port, which receives an array of doubles.
 ptolemy.data.expr.Parameter iterationsPerUpdate
          The number of iterations between updates of the display on the screen.
 ptolemy.data.expr.Parameter xInit
          The start point of the X axis.
 ptolemy.data.expr.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, _text, _windowProperties, fillOnWrapup, legend, plot
 
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
ArrayPlotter(ptolemy.kernel.CompositeEntity container, java.lang.String name)
          Construct an actor with the given container and name.
 
Method Summary
 void attributeChanged(ptolemy.kernel.util.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
 
Methods inherited from class ptolemy.actor.TypedAtomicActor
_addPort, attributeTypeChanged, clone, newPort, typeConstraintList
 
Methods inherited from class ptolemy.actor.AtomicActor
_createReceivers, connectionsChanged, fire, getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, iterate, newReceiver, outputPortList, prefire, pruneDependencies, removeDependency, stop, stopFire, terminate
 
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, _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, _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
fire, iterate, prefire, stop, stopFire, terminate
 
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

input

public ptolemy.actor.TypedIOPort input
Input port, which receives an array of doubles.


iterationsPerUpdate

public ptolemy.data.expr.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 ptolemy.data.expr.Parameter xUnit
The increment of the X axis.


xInit

public ptolemy.data.expr.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.

Constructor Detail

ArrayPlotter

public ArrayPlotter(ptolemy.kernel.CompositeEntity container,
                    java.lang.String name)
             throws ptolemy.kernel.util.IllegalActionException,
                    ptolemy.kernel.util.NameDuplicationException
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
Notification that an attribute has changed.

Overrides:
attributeChanged in class Plotter
Throws:
ptolemy.kernel.util.IllegalActionException - If the expression of the attribute cannot be parsed or cannot be evaluated.

initialize

public void initialize()
                throws ptolemy.kernel.util.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 ptolemy.actor.Executable
Overrides:
initialize in class Plotter
Throws:
ptolemy.kernel.util.IllegalActionException - If the parent class throws it.

postfire

public boolean postfire()
                 throws ptolemy.kernel.util.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 ptolemy.actor.Executable
Returns:
True if it is OK to continue.
Throws:
ptolemy.kernel.util.IllegalActionException - If there is no director, or if the base class throws it.

wrapup

public void wrapup()
            throws ptolemy.kernel.util.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 ptolemy.actor.Executable
Overrides:
wrapup in class PlotterBase
Throws:
ptolemy.kernel.util.IllegalActionException - If the superclass throws it.