§
    ’©ºjø$  ã                   óÈ   — d dl mZ d dlmZmZmZmZ d dl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 d d
lmZmZ esdgZesddgZ G d„ de¦  «        ZdS )é    )ÚSequence)ÚAnyÚListÚOptionalÚUnion)ÚTensor)ÚLiteral)Ú!_spatial_distortion_index_computeÚ _spatial_distortion_index_update)ÚMetric)Úrank_zero_warn)Údim_zero_cat)Ú_MATPLOTLIB_AVAILABLEÚ_TORCHVISION_AVAILABLE)Ú_AX_TYPEÚ_PLOT_OUT_TYPEzSpatialDistortionIndex.plotÚSpatialDistortionIndexc                   óh  ‡ — 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<   d	Ze
ed
<   ee         ed<   ee         ed<   ee         ed<   ee         ed<   	 	 	 d dededed         deddf
ˆ fd„Zdedeeef         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 )"r   aÖ
  Compute Spatial Distortion Index (SpatialDistortionIndex_) also now as D_s.

    The metric is used to compare the spatial distortion between two images. A value of 0 indicates no distortion
    (optimal value) and corresponds to the case where the high resolution panchromatic image is equal to the low
    resolution panchromatic image. The metric is defined as:

    .. math::
        D_s = \\sqrt[q]{\frac{1}{L}\\sum_{l=1}^L|Q(\\hat{G_l}, P) - Q(\tilde{G}, \tilde{P})|^q}

    where :math:`Q` is the universal image quality index (see this
    :class:`~torchmetrics.image.UniversalImageQualityIndex` for more info), :math:`\\hat{G_l}` is the l-th band of the
    high resolution multispectral image, :math:`\tilde{G}` is the high resolution panchromatic image, :math:`P` is the
    high resolution panchromatic image, :math:`\tilde{P}` is the low resolution panchromatic image, :math:`L` is the
    number of bands and :math:`q` is the order of the norm applied on the difference.

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

    - ``preds`` (:class:`~torch.Tensor`): High resolution multispectral image of shape ``(N,C,H,W)``.
    - ``target`` (:class:`~Dict`): A dictionary containing the following keys:
        - ``ms`` (:class:`~torch.Tensor`): Low resolution multispectral image of shape ``(N,C,H',W')``.
        - ``pan`` (:class:`~torch.Tensor`): High resolution panchromatic image of shape ``(N,C,H,W)``.
        - ``pan_lr`` (:class:`~torch.Tensor`): Low resolution panchromatic image of shape ``(N,C,H',W')``.

    where H and W must be multiple of H' and W'.

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

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

    Args:
        norm_order: Order of the norm applied on the difference.
        window_size: Window size of the filter applied to degrade the high resolution panchromatic image.
        reduction: a method to reduce metric score over labels.

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

        kwargs: Additional keyword arguments, see :ref:`Metric kwargs` for more info.

    Example:
        >>> from torch import rand
        >>> from torchmetrics.image import SpatialDistortionIndex
        >>> preds = rand([16, 3, 32, 32])
        >>> target = {
        ...     'ms': rand([16, 3, 16, 16]),
        ...     'pan': rand([16, 3, 32, 32]),
        ... }
        >>> sdi = SpatialDistortionIndex()
        >>> sdi(preds, target)
        tensor(0.0090)

    FÚhigher_is_betterTÚis_differentiableÚfull_state_updateg        Úplot_lower_boundg      ð?Úplot_upper_boundÚpredsÚmsÚpanÚpan_lré   é   Úelementwise_meanÚ
norm_orderÚwindow_sizeÚ	reduction©r    ÚsumÚnoneÚkwargsÚreturnNc                 ó0  •—  t          ¦   «         j        di |¤Ž t          d¦  «         t          |t          ¦  «        r|dk    rt          d|› d�¦  «        ‚|| _        t          |t          ¦  «        r|dk    rt          d|› d�¦  «        ‚|| _        d}||vrt          d|› d|› �¦  «        ‚|| _        |  	                    d	g d
¬¦  «         |  	                    dg d
¬¦  «         |  	                    dg d
¬¦  «         |  	                    dg d
¬¦  «         d S )NzŒMetric `SpatialDistortionIndex` will save all targets and predictions in buffer. For large datasets this may lead to large memory footprint.r   z@Expected `norm_order` to be a positive integer. Got norm_order: ú.zBExpected `window_size` to be a positive integer. Got window_size: r$   z(Expected argument `reduction` be one of z	 but got r   Úcat)ÚdefaultÚdist_reduce_fxr   r   r   © )
ÚsuperÚ__init__r   Ú
isinstanceÚintÚ
ValueErrorr!   r"   r#   Ú	add_state)Úselfr!   r"   r#   r'   Úallowed_reductionsÚ	__class__s         €úf/root/private/project/pallet_detection_v2/.venv/lib/python3.11/site-packages/torchmetrics/image/d_s.pyr0   zSpatialDistortionIndex.__init__f   sX  ø€ ð 	�‰ŒÔÐ"Ð"˜6Ð"Ð"Ð"Ýð*ñ	
ô 	
ð 	
õ ˜*¥cÑ*Ô*ð 	o¨j¸Aªo¨oÝÐmÐ`jÐmÐmÐmÑnÔnÐnØ$ˆŒÝ˜+¥sÑ+Ô+ð 	r¨{¸aÒ/?Ð/?ÝÐpÐbmÐpÐpÐpÑqÔqÐqØ&ˆÔØ@ÐØÐ.Ð.Ð.ÝÐpÐHZÐpÐpÐenÐpÐpÑqÔqÐqØ"ˆŒØ�Š�w¨¸5ˆÑAÔAÐAØ�Š�t R¸ˆÑ>Ô>Ð>Ø�Š�u b¸ˆÑ?Ô?Ð?Ø�Š�x¨¸EˆÑBÔBÐBÐBÐBó    Útargetc                 ó"  — d|vr%t          d|                     ¦   «         › d�¦  «        ‚d|vr%t          d|                     ¦   «         › d�¦  «        ‚|d         }|d         }|                     d¦  «        }t          ||||¦  «        \  }}}}| j                             |¦  «         | j                             |d         ¦  «         | j                             |d         ¦  «         d|v r"| j                             |d         ¦  «         dS dS )aì  Update state with preds and target.

        Args:
            preds: High resolution multispectral image.
            target: A dictionary containing the following keys:

                - ``'ms'``: low resolution multispectral image.
                - ``'pan'``: high resolution panchromatic image.
                - ``'pan_lr'``: (optional) low resolution panchromatic image.

        Raises:
            ValueError:
                If ``target`` doesn't have ``ms`` and ``pan``.

        r   z0Expected `target` to have key `ms`. Got target: r*   r   z1Expected `target` to have key `pan`. Got target: r   N)	r3   ÚkeysÚgetr   r   Úappendr   r   r   )r5   r   r:   r   r   r   s         r8   ÚupdatezSpatialDistortionIndex.updateƒ   s"  € ð  �vÐÐÝÐ`ÐPV×P[ÒP[ÑP]ÔP]Ð`Ð`Ð`ÑaÔaÐaØ˜ÐÐÝÐaÐQW×Q\ÒQ\ÑQ^ÔQ^ÐaÐaÐaÑbÔbÐbØ�DŒ\ˆØ�UŒmˆØ—’˜HÑ%Ô%ˆÝ!AÀ%ÈÈSÐRXÑ!YÔ!YÑˆˆr�3˜ØŒ
×Ò˜%Ñ Ô Ð ØŒ�Š�v˜d”|Ñ$Ô$Ð$ØŒ�Š˜˜uœÑ&Ô&Ð&Ø�vÐÐØŒK×Ò˜v hÔ/Ñ0Ô0Ð0Ð0Ð0ð Ðr9   c           	      ó^  — t          | j        ¦  «        }t          | j        ¦  «        }t          | j        ¦  «        }t	          | j        ¦  «        dk    rt          | j        ¦  «        nd}||dœ}|                     |�d|ini ¦  «         t          ||||| j        | j	        | j
        ¦  «        S )z-Compute and returns spatial distortion index.r   N)r   r   r   )r   r   r   r   Úlenr   r?   r
   r!   r"   r#   )r5   r   r   r   r   r:   s         r8   ÚcomputezSpatialDistortionIndex.compute¡   s­   € å˜TœZÑ(Ô(ˆÝ˜$œ'Ñ"Ô"ˆÝ˜4œ8Ñ$Ô$ˆÝ.1°$´+Ñ.>Ô.>ÀÒ.BÐ.B•˜dœkÑ*Ô*Ð*ÈˆØ 3Ð'Ð'ˆØ�Š¨FÐ,>�x Ð(Ð(ÀBÑGÔGÐGÝ0Ø�2�s˜F D¤O°TÔ5EÀtÄ~ñ
ô 
ð 	
r9   Ú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
            >>> from torch import rand
            >>> from torchmetrics.image import SpatialDistortionIndex
            >>> preds = rand([16, 3, 32, 32])
            >>> target = {
            ...     'ms': rand([16, 3, 16, 16]),
            ...     'pan': rand([16, 3, 32, 32]),
            ... }
            >>> metric = SpatialDistortionIndex()
            >>> metric.update(preds, target)
            >>> fig_, ax_ = metric.plot()

        .. plot::
            :scale: 75

            >>> # Example plotting multiple values
            >>> from torch import rand
            >>> from torchmetrics.image import SpatialDistortionIndex
            >>> preds = rand([16, 3, 32, 32])
            >>> target = {
            ...     'ms': rand([16, 3, 16, 16]),
            ...     'pan': rand([16, 3, 32, 32]),
            ... }
            >>> metric = SpatialDistortionIndex()
            >>> values = [ ]
            >>> for _ in range(10):
            ...     values.append(metric(preds, target))
            >>> fig_, ax_ = metric.plot(values)

        )Ú_plot)r5   rC   rD   s      r8   ÚplotzSpatialDistortionIndex.plot­   s   € ðd �zŠz˜#˜rÑ"Ô"Ð"r9   )r   r   r    )NN)Ú__name__Ú
__module__Ú__qualname__Ú__doc__r   ÚboolÚ__annotations__r   r   r   Úfloatr   r   r   r2   r	   r   r0   ÚdictÚstrr?   rB   r   r   r   r   r   rG   Ú__classcell__)r7   s   @r8   r   r   #   sÒ  ø€ € € € € € ð5ð 5ðn #Ð�dÐ"Ð"Ñ"Ø"Ð�tÐ"Ð"Ñ"Ø#Ð�tÐ#Ð#Ñ#Ø!Ð�eÐ!Ð!Ñ!Ø!Ð�eÐ!Ð!Ñ!à�Œ<ÐÐÑØˆVŒÐÐÑØ	ˆfŒÐÐÑØ�ŒLÐÐÑð ØØ@Rð	Cð CàðCð ðCð Ð<Ô=ð	Cð
 ðCð 
ðCð Cð Cð Cð Cð Cð:1˜Fð 1¨D°°f°Ô,=ð 1À$ð 1ð 1ð 1ð 1ð<

˜ð 

ð 

ð 

ð 

ð _cð2#ð 2#Ø˜E &¨(°6Ô*:Ð":Ô;Ô<ð2#ØIQÐRZÔI[ð2#à	ð2#ð 2#ð 2#ð 2#ð 2#ð 2#ð 2#ð 2#r9   N)Úcollections.abcr   Útypingr   r   r   r   Útorchr   Útyping_extensionsr	   Ú!torchmetrics.functional.image.d_sr
   r   Útorchmetrics.metricr   Útorchmetrics.utilitiesr   Útorchmetrics.utilities.datar   Útorchmetrics.utilities.importsr   r   Útorchmetrics.utilities.plotr   r   Ú__doctest_skip__r   r.   r9   r8   ú<module>r]      sC  ðð %Ð $Ð $Ð $Ð $Ð $Ø -Ð -Ð -Ð -Ð -Ð -Ð -Ð -Ð -Ð -Ð -Ð -à Ð Ð Ð Ð Ð Ø %Ð %Ð %Ð %Ð %Ð %à qÐ qÐ qÐ qÐ qÐ qÐ qÐ qØ &Ð &Ð &Ð &Ð &Ð &Ø 1Ð 1Ð 1Ð 1Ð 1Ð 1Ø 4Ð 4Ð 4Ð 4Ð 4Ð 4Ø XÐ XÐ XÐ XÐ XÐ XÐ XÐ XØ @Ð @Ð @Ð @Ð @Ð @Ð @Ð @àð 7Ø5Ð6Ðàð QØ0Ð2OÐPÐð|#ð |#ð |#ð |#ð |#˜Vñ |#ô |#ð |#ð |#ð |#r9   