Package org.ptolemy.machineLearning.hsmm

Class HSMMTimeAwareMultinomialEstimatorWithCodegen

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.machineLearning.hmm.ParameterEstimator

org.ptolemy.machineLearning.hsmm.HSMMParameterEstimator

org.ptolemy.machineLearning.hsmm.HSMMMultinomialEstimator

org.ptolemy.machineLearning.hsmm.HSMMTimeAwareMultinomialEstimator

org.ptolemy.machineLearning.hsmm.HSMMTimeAwareMultinomialEstimatorWithCodegen

All Implemented Interfaces:

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

public class HSMMTimeAwareMultinomialEstimatorWithCodegen
extends HSMMTimeAwareMultinomialEstimator

A parameter estimator for a Hidden Semi-Markov Model with Multinomial Emissions and code generation. The transition probability matrix is estimated on an hourly basis.

Since:

Ptolemy II 11.0

Version:

$Id$

Author:

Ilge Akkaya

Pt.AcceptedRating:

Red (cxh)

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
protected static java.lang.String	_eol	The line separator.
FilePortParameter	filename	The name of the file to write to.
static java.lang.String	INDENT1	The level 1 index prefix.
static java.lang.String	INDENT2	The level 2 index prefix.
Parameter	minPowerThreshold	The minimum power threshold.
Parameter	modelChecking	If set to true, PRISM will be used to model check defined model properties.
Parameter	optimize	If set to true, model will be parameterized and parameter synthesis will be carried out using PRISM.
Parameter	optStep	The maximum number of function evaluations before terminating.
TypedIOPort	optvals	An output port of type double that contains optional values.
FilePortParameter	propertyFile	The property file.
Parameter	testPreset	The default value is true.

Fields inherited from class org.ptolemy.machineLearning.hsmm.HSMMTimeAwareMultinomialEstimator

_hourOfDay, At, Atlearned, empiricalStartTimes, FORCE_SELF, FORCE_ZERO, incompleteCategories, INTERPOLATE, NO_ACTION, NUM_CATEGORIES, SELF_AND_ZERO, timestamps, transitionMatrixEstimationMethod

Fields inherited from class org.ptolemy.machineLearning.hsmm.HSMMMultinomialEstimator

_B, _nCategories, clusters, emissionEstimates, nCategories, observationDimension, observationProbabilities, prior_new

Fields inherited from class org.ptolemy.machineLearning.hsmm.HSMMParameterEstimator

_D, _D0, _dPriors0, _durationPriors, _etaDimension, _likelihoodHistory, _maxDuration, clusterAssignments, D_new, durationEstimates, durationPriorEstimates, durationProbabilities, maxStateDuration, priorDurationDistribution

Fields inherited from class org.ptolemy.machineLearning.hmm.ParameterEstimator

_A0, _likelihood, _likelihoodThreshold, _nIterations, _nStates, _obsDimension, _observations, _priorIn, _priors, _randomize, _transitionMatrix, A0, input, likelihood, likelihoodOut, likelihoodThreshold, maxIterations, newEstimates, nStates, priorDistribution, priorEstimates, randomizeGuessVectors, transitionMatrix

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
HSMMTimeAwareMultinomialEstimatorWithCodegen(CompositeEntity container, java.lang.String name)	Construct an actor with the given container and name.

Method Summary

Modifier and Type	Method	Description
void	_sendEmpiricalMatrix()	Send the learned matrix to the output.
void	attributeChanged(Attribute attribute)	React to a change in an attribute.
java.lang.Object	clone(Workspace workspace)	Clone the actor into the specified workspace.
void	fire()	Do nothing.
void	initialize()	Initialize this actor.
void	wrapup()	Do nothing except invoke the wrapup() methods of any objects that have been registered with addInitializable().

Methods inherited from class org.ptolemy.machineLearning.hsmm.HSMMTimeAwareMultinomialEstimator

_calculateTransitionScheme, _learnAt

Methods inherited from class org.ptolemy.machineLearning.hsmm.HSMMMultinomialEstimator

_checkForConvergence, _initializeEMParameters, _iterateEM, _updateEstimates, durationProbability, emissionProbability

Methods inherited from class org.ptolemy.machineLearning.hsmm.HSMMParameterEstimator

_EMParameterEstimation, _initializeArrays, HSMMAlphaBetaRecursion, preinitialize

Methods inherited from class org.ptolemy.machineLearning.hmm.ParameterEstimator

HMMAlphaBetaRecursion

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

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

_addPort, _description, _exportMoMLContents, _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, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _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

isFireFunctional, isStrict, iterate, postfire, 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, setName

Field Detail

filename

public FilePortParameter filename

The name of the file to write to. By default, this parameter contains an empty string, which is interpreted to mean that output should be directed to the standard output. See FilePortParameter for details about relative path names.

propertyFile

public FilePortParameter propertyFile

The property file.

optStep

public Parameter optStep

The maximum number of function evaluations before terminating. The default value is 10.

optimize

public Parameter optimize

If set to true, model will be parameterized and parameter synthesis will be carried out using PRISM.

modelChecking

public Parameter modelChecking

If set to true, PRISM will be used to model check defined model properties.

testPreset

public Parameter testPreset

The default value is true.

optvals

public TypedIOPort optvals

An output port of type double that contains optional values.

minPowerThreshold

public Parameter minPowerThreshold

The minimum power threshold. The inital defaultis an integer with a value 0.

_eol

protected static final java.lang.String _eol

The line separator.

INDENT1

public static final java.lang.String INDENT1

The level 1 index prefix.

INDENT2

public static final java.lang.String INDENT2

The level 2 index prefix.

Constructor Detail

HSMMTimeAwareMultinomialEstimatorWithCodegen

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

initialize

public void initialize()
                throws IllegalActionException

Description copied from class: AtomicActor

Initialize this actor. Derived classes override this method to perform actions that should occur once at the beginning of an execution, but after type resolution. Derived classes can produce output data and schedule events.

Specified by:

initialize in interface Initializable

Overrides:

initialize in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - If a derived class throws it.

wrapup

public void wrapup()

Description copied from class: AtomicActor

Do nothing except invoke the wrapup() methods of any objects that have been registered with addInitializable(). Derived classes override this method to define operations to be performed exactly once at the end of a complete execution of an application. It typically closes files, displays final results, etc.

Specified by:

wrapup in interface Initializable

Overrides:

wrapup in class AtomicActor<TypedIOPort>

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

Description copied from class: NamedObj

React to a change in an attribute. This method is called by a contained attribute when its value changes. In this base class, the method does nothing. In derived classes, this method may throw an exception, indicating that the new attribute value is invalid. It is up to the caller to restore the attribute to a valid value if an exception is thrown.

Overrides:

attributeChanged in class HSMMTimeAwareMultinomialEstimator

Parameters:

attribute - The attribute that changed.

Throws:

IllegalActionException - If the change is not acceptable to this container (not thrown in this base class).

clone

public java.lang.Object clone(Workspace workspace)
                       throws java.lang.CloneNotSupportedException

Description copied from class: TypedAtomicActor

Clone the actor into the specified workspace.

Overrides:

clone in class HSMMTimeAwareMultinomialEstimator

Parameters:

workspace - The workspace for the new object.

Returns:

A new actor.

Throws:

java.lang.CloneNotSupportedException - If a derived class contains an attribute that cannot be cloned.

See Also:

NamedObj.exportMoML(Writer, int, String), NamedObj.setDeferringChangeRequests(boolean)

fire

public void fire()
          throws IllegalActionException

Description copied from class: AtomicActor

Do nothing. Derived classes override this method to define their primary run-time action.

Specified by:

fire in interface Executable

Overrides:

fire in class HSMMTimeAwareMultinomialEstimator

Throws:

IllegalActionException - Not thrown in this base class.

_sendEmpiricalMatrix

public void _sendEmpiricalMatrix()

Description copied from class: HSMMTimeAwareMultinomialEstimator

Send the learned matrix to the output.

Overrides:

_sendEmpiricalMatrix in class HSMMTimeAwareMultinomialEstimator