MultiTACAnalysisMixin
======================================================

.. py:class:: petpal.utils.time_activity_curve.MultiTACAnalysisMixin(input_tac_path: str, tacs_dir: str)

   A mixin class providing utilities for handling multiple analysis of Time Activity Curves (TACs)
   in a directory.

   :ivar input_tac_path: Path to the input TAC file.
   :vartype input_tac_path: str
   :ivar tacs_dir: Directory containing TAC files.
   :vartype tacs_dir: str
   :ivar tacs_files_list: List of TAC file paths.
   :vartype tacs_files_list: list[str]
   :ivar num_of_tacs: Number of TACs found in the directory.
   :vartype num_of_tacs: int
   :ivar inferred_seg_labels: List of inferred segmentation labels for TACs.

   :vartype inferred_seg_labels: list[str]

   Initializes the MultiTACAnalysisMixin with paths and initializes analysis properties.

   :param input_tac_path: Path to the input TAC file.
   :type input_tac_path: str
   :param tacs_dir: Directory containing TAC files.
   :type tacs_dir: str


   .. py:property:: input_tac_path

      Gets the input TAC file path.


   .. py:property:: tacs_dir

      Gets the TAC directory path.


   .. py:property:: reference_tac_path

      Gets the reference TAC file path.


   .. py:method:: is_valid_tacs_dir(tacs_dir: str)

      Validates the TAC directory by checking for TAC files.

      :param tacs_dir: Directory to validate.
      :type tacs_dir: str

      :returns: *bool* -- True if valid, otherwise False.



   .. py:method:: get_tacs_list_from_dir(tacs_dir: str) -> list[str]
      :staticmethod:


      Retrieves a sorted list of TAC file paths from a directory.

      :param tacs_dir: Directory from which to retrieve TAC files.
      :type tacs_dir: str

      :returns: *list[str]* -- Sorted list of TAC file paths.



   .. py:method:: get_tacs_objects_dict_from_files_list(tacs_files_list: list[str])
      :staticmethod:


      Creates a dict of TAC objects from a list of file paths.

      :param tacs_files_list: List of TAC file paths.
      :type tacs_files_list: list[str]

      :returns: *dict* -- Dictionary of region name-TAC object pairs.



   .. py:method:: get_tacs_objects_dict_from_dir(tacs_dir: str) -> dict
      :staticmethod:


      Creates a dict of TAC objects from a directory of TAC files.

      :param tacs_dir: A directory of TAC files.
      :type tacs_dir: str

      :returns: *dict* -- Dictionary of region name-TAC object pairs.



   .. py:method:: get_tacs_objects_list_from_files_list(tacs_files_list: list[str])
      :staticmethod:


      Creates a list of TAC objects from a list of file paths.

      :param tacs_files_list: List of TAC file paths.
      :type tacs_files_list: list[str]

      :returns: *list[TimeActivityCurve]* -- List of TAC objects.



   .. py:method:: get_tacs_vals_from_objs_list(tacs_objects_list: list[TimeActivityCurve])
      :staticmethod:


      Extracts TAC values from a list of TAC objects.

      :param tacs_objects_list: List of TAC objects.
      :type tacs_objects_list: list[TimeActivityCurve]

      :returns: *list* -- List of TAC values.



   .. py:method:: get_tacs_vals_from_dir(tacs_dir: str)

      Retrieves TAC values from files in a specified directory.

      :param tacs_dir: Directory containing TAC files.
      :type tacs_dir: str

      :returns: *list* -- List of TAC values.



   .. py:method:: capitalize_first_char_of_str(input_str: str)
      :staticmethod:


      Capitalize only the first character of a string, leaving the remainder unchanged.

      :param input_str: The string to capitalize the first character of.
      :type input_str: str

      :returns: *output_str (str)* -- The string with only the first character capitalized.



   .. py:method:: infer_segmentation_label_from_tac_path(tac_path: str, tac_id: int)
      :staticmethod:


      Infers a segmentation label from a TAC file path by analyzing the filename.

      This method extracts a segment label from the filename of a TAC file. It checks the presence
      of a `seg-` marker in the filename, which is followed by the segment name. This segment name
      is then formatted with each part capitalized. If no segment label is found,
      a default unknown label is generated using the TAC's ID.

      :param tac_path: Path of the TAC file.
      :type tac_path: str
      :param tac_id: ID of the TAC.
      :type tac_id: int

      :returns: *str* -- Inferred segmentation label.



   .. py:method:: infer_segmentation_labels_for_tacs()

      Infers segmentation labels for TACs.

      :returns: *list[str]* -- List of inferred segmentation labels.

      .. seealso:: :meth:`infer_segmentation_label_from_tac_path`