Package org.ptolemy.ssm

Class GaussianMeasurementModel

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity<T>

ptolemy.actor.AtomicActor<TypedIOPort>

ptolemy.actor.TypedAtomicActor

org.ptolemy.ssm.MirrorDecorator

org.ptolemy.ssm.MeasurementModel

org.ptolemy.ssm.GaussianMeasurementModel

All Implemented Interfaces:

java.lang.Cloneable, GaussianModel, StateSpaceActor, TrainableGaussianModel, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Decorator, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

public class GaussianMeasurementModel
extends MeasurementModel
implements TrainableGaussianModel

A special decorator that defines a Gaussian measurement model.

Since:

Ptolemy II 11.0

Version:

$Id$

Author:

Ilge Akkaya

Pt.AcceptedRating:

Pt.ProposedRating:

Red (ilgea)

Nested Class Summary

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

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field	Description
Parameter	noiseCovariance	The noise covariance.
Parameter	noiseMean	The noise mean.

Fields inherited from class org.ptolemy.ssm.MeasurementModel

z, zParameter

Fields inherited from class org.ptolemy.ssm.MirrorDecorator

_addedParameters, _addedPortNames, _addedPortParameterNames, _decoratedObjects, _decoratedObjectsVersion, _listeners

Fields inherited from class ptolemy.actor.TypedAtomicActor

_typesValid

Fields inherited from class ptolemy.actor.AtomicActor

_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _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

Constructors

Constructor	Description
GaussianMeasurementModel(CompositeEntity container, java.lang.String name)	Construct a GaussianMeasurementModel.

Method Summary

Modifier and Type	Method	Description
double[][]	getCovariance()	Get the coveriance.
double[]	getMean()	Get the mean.
boolean	validDecoratorAssociationExists()	Return true if a valid decorator association exists.

Methods inherited from class org.ptolemy.ssm.MeasurementModel

createDecoratorAttributes, decoratedObjects, getMeasurementParameterPostfix

Methods inherited from class org.ptolemy.ssm.MirrorDecorator

_addAttribute, _addPort, _removeAttribute, _removePort, attributeChanged, clone, getAddedParameters, getAddedPortNames, getAddedPortParameterNames, isGlobalDecorator, registerListener, sendParameterEvent, sendPortEvent, setContainer

Methods inherited from class ptolemy.actor.TypedAtomicActor

_containedTypeConstraints, _customTypeConstraints, _defaultTypeConstraints, _fireAt, _fireAt, attributeTypeChanged, clone, isBackwardTypeInferenceEnabled, newPort, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, _declareDelayDependency, addActorFiringListener, addInitializable, connectionsChanged, createReceivers, declareDelayDependency, fire, getCausalityInterface, getDirector, getExecutiveDirector, getManager, initialize, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, postfire, prefire, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, 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, _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

_adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeDeleted, attributeList, attributeList, decorators, 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, notifyOfNameChange, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, 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.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Methods inherited from interface ptolemy.actor.Executable

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

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, initialize, preinitialize, removeInitializable, wrapup

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getDisplayName, getFullName, getName, getName, setName

Field Detail

noiseMean

public Parameter noiseMean

The noise mean.

noiseCovariance

public Parameter noiseCovariance

The noise covariance.

Constructor Detail

GaussianMeasurementModel

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

Construct a GaussianMeasurementModel.

Parameters:

container - The container.

name - The name of this actor.

Throws:

IllegalActionException - If the container is incompatible with this actor.

NameDuplicationException - If the name coincides with an actor already in the container.

Method Detail

getMean

public double[] getMean()

Get the mean.

Specified by:

getMean in interface GaussianModel

Returns:

the mean.

getCovariance

public double[][] getCovariance()

Get the coveriance.

Specified by:

getCovariance in interface GaussianModel

Returns:

the coveriance.

validDecoratorAssociationExists

public boolean validDecoratorAssociationExists()
                                        throws IllegalActionException

Description copied from interface: StateSpaceActor

Return true if a valid decorator association exists.

Specified by:

validDecoratorAssociationExists in interface StateSpaceActor

Overrides:

validDecoratorAssociationExists in class MeasurementModel

Returns:

true if a valid decorator association exists.

Throws:

IllegalActionException