larvaworld.lib.reg.parDB
========================

.. py:module:: larvaworld.lib.reg.parDB

.. autoapi-nested-parse::

   Larvaworld parameter database



Attributes
----------

.. autoapisummary::

   larvaworld.lib.reg.parDB.output_dict
   larvaworld.lib.reg.parDB.output_keys


Classes
-------

.. autoapisummary::

   larvaworld.lib.reg.parDB.ParamClass
   larvaworld.lib.reg.parDB.ParamRegistry


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

.. py:data:: output_dict
   :type:  larvaworld.lib.util.AttrDict

.. py:data:: output_keys
   :type:  list[str]

.. py:class:: ParamClass

   Parameter database for storing and managing Larvaworld parameters.

   Provides a comprehensive database of all parameters used in larvaworld simulations,
   including physical parameters, behavioral parameters, and configuration options.
   Supports parameter lookup, unit management, and symbolic notation.

   Attributes:
       dict: Dictionary of parameter definitions
       ks: List of parameter keys
       kdict: Flattened parameter dictionary for quick lookup

   Example:
       >>> pclass = ParamClass()
       >>> pclass.dict['length']
       {'p': 'body_length', 'k': 'l', 'd': 'Body length', ...}


   .. py:attribute:: func_dict


   .. py:attribute:: k_ops


   .. py:method:: update_kdict(ks: list[str]) -> None

      Update the kdict with the parameters in the ks list



   .. py:method:: finalize() -> None

      Finalize the parameter database



   .. py:property:: dkeys
      :type: larvaworld.lib.util.SuperList



   .. py:property:: pkeys
      :type: larvaworld.lib.util.SuperList



   .. py:property:: ks
      :type: larvaworld.lib.util.SuperList



   .. py:method:: build() -> None


   .. py:method:: add(**kwargs: Any) -> None


   .. py:method:: build_initial() -> None


   .. py:method:: add_rate(k0: Optional[str] = None, k_time: str = 't', p: Optional[str] = None, k: Optional[str] = None, d: Optional[str] = None, sym: Optional[str] = None, k_num: Optional[str] = None, k_den: Optional[str] = None, **kwargs: Any) -> None


   .. py:method:: add_operators(k0: str) -> None


   .. py:method:: add_chunk(pc: str, kc: str, func: Any = None, required_ks: list[str] = []) -> None


   .. py:method:: add_chunk_track(kc: str, k: str, pc: Optional[str] = None) -> None


   .. py:method:: add_velNacc(k0: str, p_v: Optional[str] = None, k_v: Optional[str] = None, d_v: Optional[str] = None, sym_v: Optional[str] = None, disp_v: Optional[str] = None, p_a: Optional[str] = None, k_a: Optional[str] = None, d_a: Optional[str] = None, sym_a: Optional[str] = None, disp_a: Optional[str] = None, func_v: Any = None) -> None


   .. py:method:: add_scaled(k0: str, **kwargs: Any) -> None


   .. py:method:: add_unwrap(k0: str, **kwargs: Any) -> None


   .. py:method:: add_dst(point: str = '', **kwargs: Any) -> None


   .. py:method:: add_freq(k0: str, **kwargs: Any) -> None


   .. py:method:: add_phi(k0: str, **kwargs: Any) -> None


   .. py:method:: add_dsp(range: tuple[int, int] = (0, 40)) -> None


   .. py:method:: add_tor(dur: int) -> None


   .. py:method:: build_angular() -> None


   .. py:method:: build_spatial() -> None


   .. py:method:: build_chunks() -> None


   .. py:method:: build_sim_pars() -> None


   .. py:method:: build_deb_pars() -> None


.. py:class:: ParamRegistry

   Bases: :py:obj:`ParamClass`


   Extended parameter registry with computation and display functionality.

   Extends ParamClass with methods for parameter computation from datasets,
   performance index (PI) tracking, and parameter display utilities. Used
   as the central registry for all larvaworld parameter operations.

   Attributes:
       PI: AttrDict for storing Performance Index calculations

   Example:
       >>> preg = ParamRegistry()
       >>> preg.get('l', dataset)  # Get body length parameter
       >>> preg.compute(ks=['vel', 'acc'], d=dataset)


   .. py:attribute:: PI


   .. py:method:: get(k: str, d: Any, compute: bool = True)


   .. py:method:: compute(k: str, d: Any) -> None


   .. py:method:: getPar(k: Optional[str] = None, p: Optional[str | list[str]] = None, d: Optional[str | list[str]] = None, to_return: str | list[str] = 'd')

      Retrieve the values of specific keys from a given parameter entry.
      Takes as argument the key by which to look up the parameter entry in the parameter database.

      Args:
          k (optional): Look up by short-key.
          p (optional): Look up by natural-language name.
          d (optional): Look up by dataset-based name.
          to_return (str, optional): Specifies the keys for which to return the values. Defaults to 'd'.

      Returns:
          The values associated with the selected keys from the parameter entry.




   .. py:method:: runtime_pars() -> list[str]


   .. py:method:: auto_load(ks: list[str], datasets: list[Any]) -> larvaworld.lib.util.AttrDict


   .. py:method:: df_to_pint(df)

      Method to convert a pandas dataframe to a pint-pandas dataframe by assigning a pint unit to every column (parameter).
      The pint-pandas readable pint unit is a string formatted by the unit registered in the parameter class (check "upint" property of the LarvaworldParam class in lib.util.data_aux)




   .. py:method:: output_reporters(ks: list[str], agents: list[Any]) -> larvaworld.lib.util.AttrDict


   .. py:method:: get_reporters(agents: list[Any], cs: Optional[list[str]] = None) -> larvaworld.lib.util.AttrDict


   .. py:method:: select_output(pref: str) -> larvaworld.lib.util.AttrDict


   .. py:property:: brain_output
      :type: larvaworld.lib.util.AttrDict