BEAST v2.7.8 Documentation: feast.parameter.TimeParameter

BEASTObject that performs calculations based on the State.
A node that can be part of the state.
A parameter represents a value in the state space that can be changed by operators.
A real-valued parameter represents a value (or array of values if the dimension is larger than one) in the state space that can be changed by operators.
RealParameter with a constructor that sets initial values based on formatted dates converted to ages relative to the most recent sample on the tree.

Logable: yes, this can be used in a log.

Inputs:

timeFormat, time, timeEarlier, timeLater, mostRecentSampleTime, lower, upper, value, dimension, minordimension, keys, estimate

 

timeFormat
type: java.lang.String
The time format to be parsed, e.g. dd/M/yyyy
Optional input

 

time
type: java.lang.String
One or more (space-delimited) times to be used in initializing parameter
Required input

 

timeEarlier
type: java.lang.String
Time to be converted into an upper bound on the parameter value, in format specified by timeFormat
Optional input

 

timeLater
type: java.lang.String
Time to be converted into an lower bound on the parameter value, in format specified by timeFormat
Optional input

 

mostRecentSampleTime
type: java.lang.String
Time of the most recent sample, in format specified by timeFormat
Required input

 

lower
type: java.lang.Double
lower value for this parameter (default -infinity)
Optional input

 

upper
type: java.lang.Double
upper value for this parameter (default +infinity)
Optional input

 

value
type: java.lang.Double***
start value(s) for this parameter. If multiple values are specified, they should be separated by whitespace.
Optional input

 

dimension
type: java.lang.Integer
dimension of the parameter (default 1, i.e scalar)
Optional input. Default: 1

 

minordimension
type: java.lang.Integer
minor-dimension when the parameter is interpreted as a matrix (default 1)
Optional input. Default: 1

 

keys
type: java.lang.String
the keys (unique dimension names) for the dimensions of this parameter
Optional input

 

estimate
type: java.lang.Boolean
whether to estimate this item or keep constant to its initial value
Optional input. Default: true