§
    ’©ºj@!  ã                   óÀ   — d dl mZ d dlmZ d dlmZmZmZ d dlZd dlm	Z	m
Z
 d dlmZ d dlmZmZ d dlmZ d d	lmZ d d
lmZ d dlmZmZ esdgZ G d„ de¦  «        ZdS )é    )ÚSequence)Úpartial)ÚAnyÚOptionalÚUnionN)ÚTensorÚtensor)ÚLiteral)Ú_psnr_computeÚ_psnr_update)ÚMetric)Úrank_zero_warn)Ú_MATPLOTLIB_AVAILABLE)Ú_AX_TYPEÚ_PLOT_OUT_TYPEzPeakSignalNoiseRatio.plotc                   óL  ‡ — e Zd ZU dZdZeed<   dZeed<   dZeed<   dZ	e
ed<   eed	<   	 	 	 dd	ee
ee
e
f         f         de
ded         deeeeedf         f                  deddfˆ fd„Zdededdfd„Zdefd„Z	 ddeeeee         f                  dee         defd„Zˆ xZS )ÚPeakSignalNoiseRatioa4  `Compute Peak Signal-to-Noise Ratio`_ (PSNR).

    .. math:: \text{PSNR}(I, J) = 10 * \log_{10} \left(\frac{\max(I)^2}{\text{MSE}(I, J)}\right)

    Where :math:`\text{MSE}` denotes the `mean-squared-error`_ function.

    As input to ``forward`` and ``update`` the metric accepts the following input

    - ``preds`` (:class:`~torch.Tensor`): Predictions from model of shape ``(N,C,H,W)``
    - ``target`` (:class:`~torch.Tensor`): Ground truth values of shape ``(N,C,H,W)``

    As output of `forward` and `compute` the metric returns the following output

    - ``psnr`` (:class:`~torch.Tensor`): if ``reduction!='none'`` returns float scalar tensor with average PSNR value
      over sample else returns tensor of shape ``(N,)`` with PSNR values per sample

    Args:
        data_range:
            the range of the data. If a tuple is provided, then the range is calculated as the difference and
            input is clamped between the values.
        base: a base of a logarithm to use.
        reduction: a method to reduce metric score over labels.

            - ``'elementwise_mean'``: takes the mean (default)
            - ``'sum'``: takes the sum
            - ``'none'`` or ``None``: no reduction will be applied

        dim:
            Dimensions to reduce PSNR scores over, provided as either an integer or a list of integers. Default is
            None meaning scores will be reduced across all dimensions and all batches.
        kwargs: Additional keyword arguments, see :ref:`Metric kwargs` for more info.

    Example:
        >>> from torchmetrics.image import PeakSignalNoiseRatio
        >>> psnr = PeakSignalNoiseRatio(data_range=3.0)
        >>> preds = torch.tensor([[0.0, 1.0], [2.0, 3.0]])
        >>> target = torch.tensor([[3.0, 2.0], [1.0, 0.0]])
        >>> psnr(preds, target)
        tensor(2.5527)

    TÚis_differentiableÚhigher_is_betterFÚfull_state_updateç        Úplot_lower_boundÚ
data_rangeç      $@Úelementwise_meanNÚbaseÚ	reduction)r   ÚsumÚnoneNÚdim.ÚkwargsÚreturnc                 ó<  •—  t          ¦   «         j        di |¤Ž |€|dk    rt          d|› d�¦  «         |€K|                      dt	          d¦  «        d¬¦  «         |                      dt	          d	¦  «        d¬¦  «         n0|                      dg d
¬¦  «         |                      dg d
¬¦  «         d | _        t          |t          ¦  «        rb|                      dt	          |d         |d	         z
  ¦  «        d¬¦  «         t          t          j
        |d	         |d         ¬¦  «        | _        n2|                      dt	          t          |¦  «        ¦  «        d¬¦  «         || _        || _        t          |t          ¦  «        rt          |¦  «        n|| _        d S )Nr   zThe `reduction=z.` will not have any effect when `dim` is None.Úsum_squared_errorr   r   )ÚdefaultÚdist_reduce_fxÚtotalr   Úcatr   é   Úmean)ÚminÚmax© )ÚsuperÚ__init__r   Ú	add_stater	   Úclamping_fnÚ
isinstanceÚtupler   ÚtorchÚclampÚfloatr   r   r   r    )Úselfr   r   r   r    r!   Ú	__class__s         €úg/root/private/project/pallet_detection_v2/.venv/lib/python3.11/site-packages/torchmetrics/image/psnr.pyr/   zPeakSignalNoiseRatio.__init__Q   s�  ø€ ð 	�‰ŒÔÐ"Ð"˜6Ð"Ð"Ð"àˆ;˜9Ð(:Ò:Ð:ÝÐf¨YÐfÐfÐfÑgÔgÐgàˆ;Ø�NŠNÐ.½¸s¹¼ÐTYˆNÑZÔZÐZØ�NŠN˜7­F°1©I¬IÀeˆNÑLÔLÐLÐLà�NŠNÐ.¸È5ˆNÑQÔQÐQØ�NŠN˜7¨B¸uˆNÑEÔEÐEàˆÔÝ�j¥%Ñ(Ô(ð 	cØ�NŠN˜<µ¸
À1¼È
ÐSTÌÑ8UÑ1VÔ1VÐgmˆNÑnÔnÐnÝ&¥u¤{¸
À1¼È:ÐVWÌ=ÐYÑYÔYˆDÔÐà�NŠN˜<µ½¸jÑ8IÔ8IÑ1JÔ1JÐ[aˆNÑbÔbÐbàˆŒ	Ø"ˆŒÝ!+¨CµÑ!:Ô!:ÐC•5˜‘:”:�:ÀˆŒˆˆó    ÚpredsÚtargetc                 óF  — | j         �*|                       |¦  «        }|                       |¦  «        }t          ||| j        ¬¦  «        \  }}| j        €žt          | j        t
          ¦  «        s$t          dt          | j        ¦  «        › �¦  «        ‚t          | j        t
          ¦  «        s$t          dt          | j        ¦  «        › �¦  «        ‚| xj        |z  c_        | xj        |z  c_        dS t          | j        t          ¦  «        s$t          dt          | j        ¦  «        › �¦  «        ‚t          | j        t          ¦  «        s$t          dt          | j        ¦  «        › �¦  «        ‚| j         
                    |¦  «         | j         
                    |¦  «         dS )z*Update state with predictions and targets.N)r    z:Expected `self.sum_squared_error` to be a Tensor, but got z.Expected `self.total` to be a Tensor, but got z8Expected `self.sum_squared_error` to be a list, but got z,Expected `self.total` to be a list, but got )r1   r   r    r2   r$   r   Ú	TypeErrorÚtyper'   ÚlistÚappend)r7   r;   r<   r$   Únum_obss        r9   ÚupdatezPeakSignalNoiseRatio.updatep   s¤  € àÔÐ'Ø×$Ò$ UÑ+Ô+ˆEØ×%Ò% fÑ-Ô-ˆFå%1°%¸ÀTÄXÐ%NÑ%NÔ%NÑ"Ð˜7ØŒ8ÐÝ˜dÔ4µfÑ=Ô=ð ÝØoÕQUÐVZÔVlÑQmÔQmÐoÐoñô ð õ ˜dœj­&Ñ1Ô1ð eÝÐ cÕQUÐVZÔV`ÑQaÔQaÐ cÐ cÑdÔdÐdàÐ"Ô"Ð&7Ñ7Ð"Ô"ØˆJŒJ˜'Ñ!ˆJŒJˆJˆJå˜dÔ4µdÑ;Ô;ð ÝØmÍtÐTXÔTjÑOkÔOkÐmÐmñô ð õ ˜dœj­$Ñ/Ô/ð cÝÐ aÍtÐTXÔT^ÑO_ÔO_Ð aÐ aÑbÔbÐbØÔ"×)Ò)Ð*;Ñ<Ô<Ð<ØŒJ×Ò˜gÑ&Ô&Ð&Ð&Ð&r:   c                 ó  — t          | j        t          j        ¦  «        r| j        }nMt          | j        t          ¦  «        r$t          j        d„ | j        D ¦   «         ¦  «        }nt          d¦  «        ‚t          | j        t          j        ¦  «        r| j        }nMt          | j        t          ¦  «        r$t          j        d„ | j        D ¦   «         ¦  «        }nt          d¦  «        ‚t          ||| j	        | j
        | j        ¬¦  «        S )z.Compute peak signal-to-noise ratio over state.c                 ó6   — g | ]}|                      ¦   «         ‘ŒS r-   ©Úflatten©Ú.0Úvalues     r9   ú
<listcomp>z0PeakSignalNoiseRatio.compute.<locals>.<listcomp>�   s    € Ð*_Ð*_Ð*_¸u¨5¯=ª=©?¬?Ð*_Ð*_Ð*_r:   z>Expected sum_squared_error to be a Tensor or a list of Tensorsc                 ó6   — g | ]}|                      ¦   «         ‘ŒS r-   rF   rH   s     r9   rK   z0PeakSignalNoiseRatio.compute.<locals>.<listcomp>—   s    € ÐGÐGÐG°5˜uŸ}š}™œÐGÐGÐGr:   z2Expected total to be a Tensor or a list of Tensors)r   r   )r2   r$   r4   r   r@   r(   r>   r'   r   r   r   r   )r7   r$   r'   s      r9   ÚcomputezPeakSignalNoiseRatio.compute‹   sø   € å�dÔ,­e¬lÑ;Ô;ð 	^Ø $Ô 6ÐÐÝ˜Ô.µÑ5Ô5ð 	^Ý %¤	Ð*_Ð*_ÈÔH^Ð*_Ñ*_Ô*_Ñ `Ô `ÐÐåÐ\Ñ]Ô]Ð]å�d”j¥%¤,Ñ/Ô/ð 	RØ”JˆEˆEÝ˜œ
¥DÑ)Ô)ð 	RÝ”IÐGÐG¸D¼JÐGÑGÔGÑHÔHˆEˆEåÐPÑQÔQÐQåÐ.°°t´ÈTÌYÐbfÔbpÐqÑqÔqÐqr:   ÚvalÚaxc                 ó.   — |                       ||¦  «        S )a
  Plot a single or multiple values from the metric.

        Args:
            val: Either a single result from calling `metric.forward` or `metric.compute` or a list of these results.
                If no value is provided, will automatically call `metric.compute` and plot that result.
            ax: An matplotlib axis object. If provided will add plot to that axis

        Returns:
            Figure and Axes object

        Raises:
            ModuleNotFoundError:
                If `matplotlib` is not installed

        .. plot::
            :scale: 75

            >>> # Example plotting a single value
            >>> import torch
            >>> from torchmetrics.image import PeakSignalNoiseRatio
            >>> metric = PeakSignalNoiseRatio(data_range=1.0)
            >>> preds = torch.tensor([[0.0, 1.0], [2.0, 3.0]])
            >>> target = torch.tensor([[3.0, 2.0], [1.0, 0.0]])
            >>> metric.update(preds, target)
            >>> fig_, ax_ = metric.plot()

        .. plot::
            :scale: 75

            >>> # Example plotting multiple values
            >>> import torch
            >>> from torchmetrics.image import PeakSignalNoiseRatio
            >>> metric = PeakSignalNoiseRatio(data_range=1.0)
            >>> preds = torch.tensor([[0.0, 1.0], [2.0, 3.0]])
            >>> target = torch.tensor([[3.0, 2.0], [1.0, 0.0]])
            >>> values = [ ]
            >>> for _ in range(10):
            ...     values.append(metric(preds, target))
            >>> fig_, ax_ = metric.plot(values)

        )Ú_plot)r7   rN   rO   s      r9   ÚplotzPeakSignalNoiseRatio.plot�   s   € ðX �zŠz˜#˜rÑ"Ô"Ð"r:   )r   r   N)NN)Ú__name__Ú
__module__Ú__qualname__Ú__doc__r   ÚboolÚ__annotations__r   r   r   r6   r   r   r3   r
   r   Úintr   r/   rC   rM   r   r   r   rR   Ú__classcell__)r8   s   @r9   r   r       s¾  ø€ € € € € € ð(ð (ðT #Ð�tÐ"Ð"Ñ"Ø!Ð�dÐ!Ð!Ñ!Ø#Ð�tÐ#Ð#Ñ#Ø!Ð�eÐ!Ð!Ñ!ØÐÐÑð
 ØFXØ59ðDð Dà˜%  u¨e |Ô!4Ð4Ô5ðDð ðDð ÐBÔCð	Dð
 �e˜C  s¨C x¤Ð0Ô1Ô2ðDð ðDð 
ðDð Dð Dð Dð Dð Dð>'˜Fð '¨Fð '°tð 'ð 'ð 'ð 'ð6r˜ð rð rð rð rð& _cð,#ð ,#Ø˜E &¨(°6Ô*:Ð":Ô;Ô<ð,#ØIQÐRZÔI[ð,#à	ð,#ð ,#ð ,#ð ,#ð ,#ð ,#ð ,#ð ,#r:   r   )Úcollections.abcr   Ú	functoolsr   Útypingr   r   r   r4   r   r	   Útyping_extensionsr
   Ú"torchmetrics.functional.image.psnrr   r   Útorchmetrics.metricr   Útorchmetrics.utilitiesr   Útorchmetrics.utilities.importsr   Útorchmetrics.utilities.plotr   r   Ú__doctest_skip__r   r-   r:   r9   ú<module>re      s1  ðð %Ð $Ð $Ð $Ð $Ð $Ø Ð Ð Ð Ð Ð Ø 'Ð 'Ð 'Ð 'Ð 'Ð 'Ð 'Ð 'Ð 'Ð 'à €€€Ø  Ð  Ð  Ð  Ð  Ð  Ð  Ð  Ø %Ð %Ð %Ð %Ð %Ð %à JÐ JÐ JÐ JÐ JÐ JÐ JÐ JØ &Ð &Ð &Ð &Ð &Ð &Ø 1Ð 1Ð 1Ð 1Ð 1Ð 1Ø @Ð @Ð @Ð @Ð @Ð @Ø @Ð @Ð @Ð @Ð @Ð @Ð @Ð @àð 5Ø3Ð4Ðði#ð i#ð i#ð i#ð i#˜6ñ i#ô i#ð i#ð i#ð i#r:   