TacUncertainty
======================================================

.. py:class:: petpal.kinetic_modeling.tac_uncertainty.TacUncertainty(time_activity_curve: petpal.utils.time_activity_curve.TimeActivityCurve)

   Set uncertainty for kinetic modeling. Includes options for constant,
   calculated, or preset uncertainty.

   Initialize TacUncertainty with provided arguments.

   :param time_activity_curve: The time activity curve used to determine
                               uncertainties to pass onto the kinetic model.
   :type time_activity_curve: TimeActivityCurve


   .. py:property:: constant_uncertainty
      :type: numpy.ndarray


      Get constant uncertainty for the TAC.


   .. py:property:: tac_uncertainty
      :type: numpy.ndarray


      Get uncertainty stored in the TAC itself to pass on to the kinetic model.

      :raises ValueError: If the supplied TAC uncertainty has any NaN values.

      :returns: *uncertainty_from_tac (np.ndarray)* -- Uncertainty stored in the supplied TAC.


   .. py:property:: calculated_uncertainty
      :abstractmethod:


      The calculated uncertainty for the TAC.

      Currently placeholder function.


   .. py:method:: __call__(uncertainty_method: str = 'constant') -> numpy.ndarray

      Get the tac uncertainty corresponding to the identified method.

      :param uncertainty_method: Uncertainty type to apply to the tac. Default
                                 'constant'.
      :type uncertainty_method: str

      :returns: *uncertainty (np.ndarray)* -- The uncertainty applied to each time frame in the TAC.

      :raises ValueError: If `uncertainty_method` is not one of: 'constant', 'calculated', or
          'tac'.