Tac Fitting
===========

.. py:module:: petpal.kinetic_modeling.tac_fitting

.. autoapi-nested-parse::

   This module provides functionalities for fitting Tissue Compartment Models (TCM) to Time Activity Curves (TAC)
   using various methods.

   It includes classes that handle different parts of the TAC fitting process:
       - :class:`TACFitter`: The primary class for fitting TCMs to TACs. It provides utility methods to prepare data,
         set up fitting parameters, and perform the curve fitting. This class allows fitting based on various TCM functions
         such as one-tissue compartment model (1TCM), 2TCM, and others.
       - :class:`TACFitterWithoutBloodVolume`: A subclass of TACFitter designed for scenarios when there is no signal
         contribution from blood volume in the TAC. It utilises the functionalities of :class:`TACFitter` and modifies
         certain methods to exclude the blood volume parameter.

   Functions and methods in this module use :mod:`numpy` and :mod:`scipy` packages for data manipulation and optimization
   of the fitting process.

   Please refer to the documentation of each class for more detailed information.

   .. seealso::

      * :mod:`petpal.kinetic_modeling.tcms_as_convolutions`
      * :mod:`petpal.input_function.blood_input`




Attributes
----------

.. autoapisummary::

   petpal.kinetic_modeling.tac_fitting._CONV_TCM_MODELS_CONFIGS
   petpal.kinetic_modeling.tac_fitting._FRAME_AVGD_TCM_CONFIGS


Classes
-------

.. toctree::
   :hidden:

   /autoapi/petpal/kinetic_modeling/tac_fitting/TcmModelConfig
   /autoapi/petpal/kinetic_modeling/tac_fitting/ConvTcmModelConfig
   /autoapi/petpal/kinetic_modeling/tac_fitting/TACFitter
   /autoapi/petpal/kinetic_modeling/tac_fitting/TACFitterWithoutBloodVolume
   /autoapi/petpal/kinetic_modeling/tac_fitting/TCMAnalysis
   /autoapi/petpal/kinetic_modeling/tac_fitting/MultiTACTCMAnalysis
   /autoapi/petpal/kinetic_modeling/tac_fitting/FrameAvgdTcmModelConfig
   /autoapi/petpal/kinetic_modeling/tac_fitting/FrameAveragedTACFitter
   /autoapi/petpal/kinetic_modeling/tac_fitting/FrameAveragedTCMAnalysis
   /autoapi/petpal/kinetic_modeling/tac_fitting/FrameAveragedMultiTACTCMAnalysis

.. autoapisummary::

   petpal.kinetic_modeling.tac_fitting.TcmModelConfig
   petpal.kinetic_modeling.tac_fitting.ConvTcmModelConfig
   petpal.kinetic_modeling.tac_fitting.TACFitter
   petpal.kinetic_modeling.tac_fitting.TACFitterWithoutBloodVolume
   petpal.kinetic_modeling.tac_fitting.TCMAnalysis
   petpal.kinetic_modeling.tac_fitting.MultiTACTCMAnalysis
   petpal.kinetic_modeling.tac_fitting.FrameAvgdTcmModelConfig
   petpal.kinetic_modeling.tac_fitting.FrameAveragedTACFitter
   petpal.kinetic_modeling.tac_fitting.FrameAveragedTCMAnalysis
   petpal.kinetic_modeling.tac_fitting.FrameAveragedMultiTACTCMAnalysis


Functions
---------

.. toctree::
   :hidden:

   /autoapi/petpal/kinetic_modeling/tac_fitting/_get_fitting_params_for_tcm_func
   /autoapi/petpal/kinetic_modeling/tac_fitting/_get_number_of_fit_params_for_tcm_func

.. autoapisummary::
   :nosignatures:

   petpal.kinetic_modeling.tac_fitting._get_fitting_params_for_tcm_func
   petpal.kinetic_modeling.tac_fitting._get_number_of_fit_params_for_tcm_func


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

.. py:data:: _CONV_TCM_MODELS_CONFIGS

.. py:data:: _FRAME_AVGD_TCM_CONFIGS