Tcms As Convolutions
====================

.. py:module:: petpal.kinetic_modeling.tcms_as_convolutions

.. autoapi-nested-parse::

   This module contains a collection of functions to compute Time-Activity Curves (TACs) for common Tissue Compartment
   Models (TCMs). These models are commonly used for kinetic analysis of PET TACs.

   .. note::

      All response functions in this module are decorated with :func:`numba.jit`. It compiles the function to
      machine code at runtime (Just-In-Time compilation), which usually provides a significant speed-up.

   Requires:
       The module relies on the :doc:`numpy <numpy:index>` and :doc:`numba <numba:index>` modules.

   .. todo:: Add the derivations of the solutions to the Tissue Compartment Models in the module docstring.




Functions
---------

.. toctree::
   :hidden:

   /autoapi/petpal/kinetic_modeling/tcms_as_convolutions/calc_convolution_with_check
   /autoapi/petpal/kinetic_modeling/tcms_as_convolutions/discrete_convolution_with_exponential
   /autoapi/petpal/kinetic_modeling/tcms_as_convolutions/response_function_1tcm_c1
   /autoapi/petpal/kinetic_modeling/tcms_as_convolutions/response_function_2tcm_with_k4zero_c1
   /autoapi/petpal/kinetic_modeling/tcms_as_convolutions/response_function_2tcm_with_k4zero_c2
   /autoapi/petpal/kinetic_modeling/tcms_as_convolutions/response_function_serial_2tcm_c1
   /autoapi/petpal/kinetic_modeling/tcms_as_convolutions/response_function_serial_2tcm_c2
   /autoapi/petpal/kinetic_modeling/tcms_as_convolutions/gen_tac_1tcm_cpet_from_tac
   /autoapi/petpal/kinetic_modeling/tcms_as_convolutions/generate_tac_2tcm_with_k4zero_c1_from_tac
   /autoapi/petpal/kinetic_modeling/tcms_as_convolutions/generate_tac_2tcm_with_k4zero_c2_from_tac
   /autoapi/petpal/kinetic_modeling/tcms_as_convolutions/gen_tac_2tcm_with_k4zero_cpet_from_tac
   /autoapi/petpal/kinetic_modeling/tcms_as_convolutions/generate_tac_serial_2tcm_c1_from_tac
   /autoapi/petpal/kinetic_modeling/tcms_as_convolutions/generate_tac_serial_2tcm_c2_from_tac
   /autoapi/petpal/kinetic_modeling/tcms_as_convolutions/gen_tac_2tcm_cpet_from_tac
   /autoapi/petpal/kinetic_modeling/tcms_as_convolutions/model_serial_1tcm_frame_avgd
   /autoapi/petpal/kinetic_modeling/tcms_as_convolutions/model_serial_2tcm_frame_avgd

.. autoapisummary::
   :nosignatures:

   petpal.kinetic_modeling.tcms_as_convolutions.calc_convolution_with_check
   petpal.kinetic_modeling.tcms_as_convolutions.discrete_convolution_with_exponential
   petpal.kinetic_modeling.tcms_as_convolutions.response_function_1tcm_c1
   petpal.kinetic_modeling.tcms_as_convolutions.response_function_2tcm_with_k4zero_c1
   petpal.kinetic_modeling.tcms_as_convolutions.response_function_2tcm_with_k4zero_c2
   petpal.kinetic_modeling.tcms_as_convolutions.response_function_serial_2tcm_c1
   petpal.kinetic_modeling.tcms_as_convolutions.response_function_serial_2tcm_c2
   petpal.kinetic_modeling.tcms_as_convolutions.gen_tac_1tcm_cpet_from_tac
   petpal.kinetic_modeling.tcms_as_convolutions.generate_tac_2tcm_with_k4zero_c1_from_tac
   petpal.kinetic_modeling.tcms_as_convolutions.generate_tac_2tcm_with_k4zero_c2_from_tac
   petpal.kinetic_modeling.tcms_as_convolutions.gen_tac_2tcm_with_k4zero_cpet_from_tac
   petpal.kinetic_modeling.tcms_as_convolutions.generate_tac_serial_2tcm_c1_from_tac
   petpal.kinetic_modeling.tcms_as_convolutions.generate_tac_serial_2tcm_c2_from_tac
   petpal.kinetic_modeling.tcms_as_convolutions.gen_tac_2tcm_cpet_from_tac
   petpal.kinetic_modeling.tcms_as_convolutions.model_serial_1tcm_frame_avgd
   petpal.kinetic_modeling.tcms_as_convolutions.model_serial_2tcm_frame_avgd