bam.parameter
=============

.. py:module:: bam.parameter


Classes
-------

.. autoapisummary::

   bam.parameter.Parameter


Module Contents
---------------

.. py:class:: 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 :class:`~bam.model.Model` by
   :meth:`~bam.model.Model.set_actuator` and collected by
   :meth:`~bam.model.Model.get_parameters` for optimization.

   :param value: Initial value.
   :param min: Lower bound used by the optimizer.
   :param max: Upper bound used by the optimizer.
   :param optimize: If ``False`` the parameter is held fixed during fitting.


   .. py:attribute:: value
      :type:  float


   .. py:attribute:: min
      :type:  float


   .. py:attribute:: max
      :type:  float


   .. py:attribute:: optimize
      :type:  bool
      :value: True