ptolemy.actor.lib
Class Rician

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.Source
                              extended byptolemy.actor.lib.RandomSource
                                  extended byptolemy.actor.lib.Rician
All Implemented Interfaces:
Actor, Changeable, java.lang.Cloneable, Debuggable, DebugListener, Derivable, Executable, Instantiable, ModelErrorHandler, MoMLExportable, Nameable, java.io.Serializable, TypedActor

public class Rician
extends RandomSource

Produce a random sequence with a Rician distribution. A Rician random variable is defined as follows: Let Z = sqrt(X2 + Y2), where X and Y are statistically independent Gaussian random variables with means given by parameters xMean and yMean respectively, and common variance given by parameter standardDeviation.

The default values of xMean and yMean are both set to be zero, in which the distribution is also called a Rayleigh distribution. Hence, the actor is by default a Rayleigh random generator.

On each iteration, a new random number is produced. The output port is of type DoubleToken. The values that are generated are independent and identically distributed with the means and the standard deviation given by parameters. In addition, the seed can be specified as a parameter to control the sequence that is generated.

Since:
Ptolemy II 3.0
Version:
$Id: Rician.java,v 1.12 2004/04/13 03:04:09 cxh Exp $
Author:
Rachel Zhou
See Also:
Serialized Form
Accepted Rating:
Green (bilung)
Proposed Rating:
Green (eal)

Nested Class Summary
 
Nested classes inherited from class ptolemy.kernel.Entity
Entity.ContainedObjectsIterator
 
Field Summary
 Parameter standardDeviation
          The standard deviation of the random number.
 Parameter xMean
          The mean of the random number along the X-axis.
 Parameter yMean
          The mean of the random number along the Y-axis.
 
Fields inherited from class ptolemy.actor.lib.RandomSource
_random, seed
 
Fields inherited from class ptolemy.actor.lib.Source
output, trigger
 
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
Rician(CompositeEntity container, java.lang.String name)
          Construct an actor with the given container and name.
 
Method Summary
 void fire()
          Send a random number with a Rician distribution to the output.
 boolean prefire()
          Calculate the next random number.
 
Methods inherited from class ptolemy.actor.lib.RandomSource
clone, initialize
 
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, postfire, 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, attributeChanged, 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, postfire, 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

xMean

public Parameter xMean
The mean of the random number along the X-axis. This parameter contains a DoubleToken, initially with value 0.0.


yMean

public Parameter yMean
The mean of the random number along the Y-axis. This parameter contains a DoubleToken, initially with value 0.0.


standardDeviation

public Parameter standardDeviation
The standard deviation of the random number. This parameter contains a DoubleToken, initially with value 1.0.

Constructor Detail

Rician

public Rician(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

fire

public void fire()
          throws IllegalActionException
Send a random number with a Rician distribution to the output. This number is only changed in the prefire() method, so it will remain constant throughout an iteration.

Specified by:
fire in interface Executable
Overrides:
fire in class Source
Throws:
IllegalActionException - If there is no director.

prefire

public boolean prefire()
                throws IllegalActionException
Calculate the next random number.

Specified by:
prefire in interface Executable
Overrides:
prefire in class AtomicActor
Returns:
True if it is ok to continue.
Throws:
IllegalActionException - If the base class throws it.