:py:mod:`gnn_tracking.utils.nomenclature`
=========================================

.. py:module:: gnn_tracking.utils.nomenclature


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

Classes
~~~~~~~

.. autoapisummary::

   gnn_tracking.utils.nomenclature.Variable
   gnn_tracking.utils.nomenclature.VariableManager



Functions
~~~~~~~~~

.. autoapisummary::

   gnn_tracking.utils.nomenclature.denote_pt
   gnn_tracking.utils.nomenclature.random_trial_name



Attributes
~~~~~~~~~~

.. autoapisummary::

   gnn_tracking.utils.nomenclature.variable_manager


.. py:function:: denote_pt(inpt, pt_min=0.0) -> Any

   Append suffix to designate pt threshold.
   If string is given, return string.
   If dict is given, modify all keys.


.. py:function:: random_trial_name(print=True) -> str

   Generate a random trial name.

   :param print: Whether to print the name


.. py:class:: Variable(name: str, latex: str = '')


   Variable with latex expressions etc. To be used
   for VariableManager

   .. py:property:: latex
      :type: str


   .. py:method:: __str__() -> str

      Return str(self).



.. py:class:: VariableManager


   Keep track of variables and their latex expressions etc.

   .. py:method:: __getitem__(name: str) -> Variable


   .. py:method:: add(other: list | Variable | tuple) -> None

      Add more variables to the manager



.. py:data:: variable_manager