menus.params_viewer
===================

.. py:module:: menus.params_viewer


Classes
-------

.. autoapisummary::

   menus.params_viewer.ParamView
   menus.params_viewer.SolverParamsViewer


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

.. py:class:: ParamView(param_name: str, solver_params: motile_tracker.motile.backend.SolverParams)

   Bases: :py:obj:`qtpy.QtWidgets.QWidget`


   .. py:attribute:: param_name


   .. py:attribute:: dtype


   .. py:attribute:: title


   .. py:attribute:: param_label


   .. py:attribute:: param_value


   .. py:method:: update_from_params(params: motile_tracker.motile.backend.SolverParams)

      Updates the current parameter value displayed in self.param_value,
      or hides the whole row if the value is None.

      Args:
          params (SolverParams): The solver parameters we use to update
              the UI. This object uses self.param_name to know which value
              to retrieve.



.. py:class:: SolverParamsViewer

   Bases: :py:obj:`qtpy.QtWidgets.QWidget`


   Widget for viewing SolverParams. To update for a backend change to
   SolverParams, emit the new_params signal, which each parameter label
   will connect to and use to update the UI.


   .. py:attribute:: new_params


   .. py:attribute:: solver_params


   .. py:attribute:: param_categories


   .. py:method:: _params_group(title: str, param_category: str) -> qtpy.QtWidgets.QGroupBox

      A helper function to create a group of parameters in the UI.
      Also connects each parameter to the self.new_params signal so the
      values can be updated when new parameters are viewed.

      Args:
          title (str): The title to put at the top of the group
          param_category (str): A key of self.param_categories used to
              get the list of parameters in this group.

      Returns:
          QGroupBox: A widget containing all the parameters in the group,
              with static titles and values that can be updated via emitting
              the self.new_params signal.