Package org.ptolemy.machineLearning.particleFilter

Class AbstractStateSpaceSimulator

    • Field Detail

      • state

        public TypedIOPort state
        State estimate output. A record token with one field per state variable.

      • initialState

        public Parameter initialState
        An ordered array of initial state values.

      • t

        public Parameter t
        The value of current time. This parameter is not visible in the expression screen except in expert mode. Its value initially is just 0.0, a double, but upon each firing, it is given a value equal to the current time as reported by the director.

      • resetOnEachRun

        public SharedParameter resetOnEachRun
        Boolean parameter to determine whether seeds are reset on each run.

      • seed

        public SharedParameter seed
        The seed to be used for random token generation, to evaluate probabilistic transitions between states.

      • _upToDate

        protected boolean _upToDate
        Flag indicating whether the contained model is up to date.

      • _stateNames

        protected ArrayToken _stateNames
        Cached State variable names

      • _stateLabels

        protected java.lang.String[] _stateLabels
        Labels of states

      • _stateTypes

        protected Type[] _stateTypes
        Types of each state dimension

      • MAX_TRIALS

        protected int MAX_TRIALS
        Maximum number of allowable trials to propagate state given map constraints.

      • STATE_VARIABLE_NAMES

        protected static final java.lang.String STATE_VARIABLE_NAMES
        See Also:
        Constant Field Values

    • Constructor Detail

      • AbstractStateSpaceSimulator

        public AbstractStateSpaceSimulator​(Workspace workspace)
                            throws IllegalActionException,
                                   NameDuplicationException
        Construct an actor in the specified workspace with no container and an empty string as a name. You can then change the name with setName(). If the workspace argument is null, then use the default workspace.
        Parameters:
        workspace - The workspace that will list the actor.
        Throws:
        IllegalActionException - If the name has a period in it, or the director is not compatible with the specified container.
        NameDuplicationException - If the container already contains an entity with the specified name.

    • Method Detail

      • attributeChanged

        public void attributeChanged​(Attribute attribute)
                      throws IllegalActionException
        If the argument is any parameter other than stateVariableNames t, or any parameter matching an input port, then request reinitialization.
        Overrides:
        attributeChanged in class TypedCompositeActor
        Parameters:
        attribute - The attribute that changed.
        Throws:
        IllegalActionException - If the numerator and the denominator matrix is not a row vector.

      • fire

        public void fire()
          throws IllegalActionException
        Override the base class to first set the value of the parameter t to match current time, then to set the local parameters that mirror input values, and then to fire the contained actors.
        Specified by:
        fire in interface Executable
        Overrides:
        fire in class CompositeActor
        Throws:
        IllegalActionException - If there is no director, or if the director's fire() method throws it, or if the actor is not opaque.

      • getUserDefinedParameterExpression

        protected java.lang.String getUserDefinedParameterExpression​(java.lang.String parameterName)
                                                      throws IllegalActionException
        Return the expression for a user-defined parameter.
        Parameters:
        parameterName - Name of parameter
        Returns:
        parameter expression
        Throws:
        IllegalActionException

      • getUserDefinedParameter

        protected abstract Parameter getUserDefinedParameter​(java.lang.String parameterName)
                                              throws IllegalActionException
        Return the Parameter that is part of a state space model.
        Parameters:
        parameterName - Name of parameter
        Returns:
        Parameter object
        Throws:
        IllegalActionException