Cli Tac Interpolation
=====================

.. py:module:: petpal.cli.cli_tac_interpolation

.. autoapi-nested-parse::

   Command-line interface (CLI) for interpolating Time-Activity Curves (TACs).

   This module provides a CLI to interpolate TACs, enabling the conversion of these curves to a desired time scale. It uses
   argparse to handle command-line arguments.

   The user must provide:
       * Input TAC file path
       * Interpolation interval in minutes
       * Output TAC file path

   This script uses functionalities from :mod:'petpal.tac_interpolation' module to interpolate the TAC based on the
   specified interval, or number of samples before the maximum value, and save the interpolated TAC to a specified output
   file.

   An option to print the interpolated TAC to screen is also provided for visual inspection of the results.

   Example usage:
       Using :class:`petpal.cli_tac_interpolation.EvenlyInterpolate`:
           .. code-block:: bash

               petpal-tac-interpolation --input-tac-path /path/to/input.tac --output-tac-path /path/to/output.tac --delta-time 0.1

       Using :class:`petpal.cli_tac_interpolation.EvenlyInterpolateWithMax`:
           .. code-block:: bash

               petpal-tac-interpolation --input-tac-path /path/to/input.tac --output-tac-path /path/to/output.tac --samples-before-max 4

   .. seealso:: :mod:`tac_interpolation <petpal.tac_interpolation>` - module for performing interpolation on PET TACs.

   .. todo:: * Refactor the reading and writing of TACs when IO module is mature.




Functions
---------

.. toctree::
   :hidden:

   /autoapi/petpal/cli/cli_tac_interpolation/_safe_write_tac
   /autoapi/petpal/cli/cli_tac_interpolation/_print_tac_to_screen

.. autoapisummary::
   :nosignatures:

   petpal.cli.cli_tac_interpolation._safe_write_tac
   petpal.cli.cli_tac_interpolation._print_tac_to_screen