bam.parameter

Classes

Parameter

A scalar model parameter with bounds and an optimization flag.

Module Contents

class bam.parameter.Parameter(value: float, min: float, max: float, optimize: bool = True)

A scalar model parameter with bounds and an optimization flag.

Parameters are attached to a Model by set_actuator() and collected by get_parameters() for optimization.

Parameters:

• value – Initial value.

• min – Lower bound used by the optimizer.

• max – Upper bound used by the optimizer.

• optimize – If False the parameter is held fixed during fitting.

value: float

min: float

max: float

optimize: bool = True