BEAST v2.7.8 Documentation: beastlabs.core.util.ParameterConstrainer

BEASTObject that performs calculations based on the State.
Class to constrain a multi-dimensional parameter to have a certain value (like 0) at a certain time range

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

Inputs:

tree, orig_root, constraintValue, startTime, endTime, constrainedParameter, baseParameter

 

tree
type: beast.base.evolution.tree.Tree
the phylogenetic tree to provide tree height
Required input

 

orig_root
type: beast.base.inference.parameter.RealParameter
The origin of infection x0
Required input

 

constraintValue
type: java.lang.Double
The value to be used from startTime to time endTime
Required input

 

startTime
type: java.lang.Double
The startTime from when to constrain on, (in forward time)
Required input

 

endTime
type: java.lang.Double
The endTime until when to constrain, (in forward time)
Required input

 

constrainedParameter
type: beast.base.inference.parameter.RealParameter
parameter to be constrained
Required input

 

baseParameter
type: beast.base.inference.parameter.RealParameter
the unconstrained base parameter
Required input