o
    Ñôj`  ã                   @   sª   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 d d
lmZmZ esKdgZG dd„ deƒZdS )é    )ÚSequence)ÚAnyÚListÚOptionalÚUnion)ÚTensor)ÚLiteral)Ú_ergas_computeÚ_ergas_update)ÚMetric)Úrank_zero_warn)Údim_zero_cat)Ú_MATPLOTLIB_AVAILABLE)Ú_AX_TYPEÚ_PLOT_OUT_TYPEú.ErrorRelativeGlobalDimensionlessSynthesis.plotc                	       sØ   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 ed	< ee ed
< 		dde
ded deddf‡ fdd„Zd	ed
eddfdd„Zdefdd„Z	ddeeeee f  dee defdd„Z‡  ZS )Ú)ErrorRelativeGlobalDimensionlessSynthesisaš  Calculate the `Error relative global dimensionless synthesis`_  (ERGAS) metric.

    This metric is used to calculate the accuracy of Pan sharpened image considering normalized average error of each
    band of the result image. It is defined as:

    .. math::
        ERGAS = \frac{100}{r} \cdot \sqrt{\frac{1}{N} \sum_{k=1}^{N} \frac{RMSE(B_k)^2}{\mu_k^2}}

    where :math:`r=h/l` denote the ratio in spatial resolution (pixel size) between the high and low resolution images.
    :math:`N` is the number of spectral bands, :math:`RMSE(B_k)` is the root mean square error of the k-th band between
    low and high resolution images, and :math:`\\mu_k` is the mean value of the k-th band of the reference image.

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

    - ``preds`` (:class:`~torch.Tensor`): Predictions from model
    - ``target`` (:class:`~torch.Tensor`): Ground truth values

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

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

    Args:
        ratio: ratio of high resolution to low resolution.
        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

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

    Example:
        >>> from torch import rand
        >>> from torchmetrics.image import ErrorRelativeGlobalDimensionlessSynthesis
        >>> preds = rand([16, 1, 16, 16])
        >>> target = preds * 0.75
        >>> ergas = ErrorRelativeGlobalDimensionlessSynthesis()
        >>> ergas(preds, target).round()
        tensor(10.)

    FÚhigher_is_betterTÚis_differentiableÚfull_state_updateg        Úplot_lower_boundÚpredsÚtargeté   Úelementwise_meanÚratioÚ	reduction)r   ÚsumÚnoneNÚkwargsÚreturnNc                    sJ   t ƒ jdi |¤Ž tdƒ | jdg dd� | jdg dd� || _|| _d S )Nz�Metric `UniversalImageQualityIndex` will save all targets and predictions in buffer. For large datasets this may lead to large memory footprint.r   Úcat)ÚdefaultÚdist_reduce_fxr   © )ÚsuperÚ__init__r   Ú	add_stater   r   )Úselfr   r   r   ©Ú	__class__r$   úk/var/www/html/academy/tools/voices/clone/cosy-venv/lib/python3.10/site-packages/torchmetrics/image/ergas.pyr&   T   s   ÿ
z2ErrorRelativeGlobalDimensionlessSynthesis.__init__c                 C   s*   t ||ƒ\}}| j |¡ | j |¡ dS )z*Update state with predictions and targets.N)r
   r   Úappendr   ©r(   r   r   r$   r$   r+   Úupdatef   s   z0ErrorRelativeGlobalDimensionlessSynthesis.updatec                 C   s&   t | jƒ}t | jƒ}t||| j| jƒS )z&Compute explained variance over state.)r   r   r   r	   r   r   r-   r$   r$   r+   Úcomputel   s   

z1ErrorRelativeGlobalDimensionlessSynthesis.computeÚvalÚaxc                 C   s   |   ||¡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 ErrorRelativeGlobalDimensionlessSynthesis
            >>> preds = rand([16, 1, 16, 16])
            >>> target = preds * 0.75
            >>> metric = ErrorRelativeGlobalDimensionlessSynthesis()
            >>> metric.update(preds, target)
            >>> fig_, ax_ = metric.plot()

        .. plot::
            :scale: 75

            >>> # Example plotting multiple values
            >>> from torch import rand
            >>> from torchmetrics.image import ErrorRelativeGlobalDimensionlessSynthesis
            >>> preds = rand([16, 1, 16, 16])
            >>> target = preds * 0.75
            >>> metric = ErrorRelativeGlobalDimensionlessSynthesis()
            >>> values = [ ]
            >>> for _ in range(10):
            ...     values.append(metric(preds, target))
            >>> fig_, ax_ = metric.plot(values)

        )Ú_plot)r(   r0   r1   r$   r$   r+   Úplotr   s   ,r   )r   r   )NN)Ú__name__Ú
__module__Ú__qualname__Ú__doc__r   ÚboolÚ__annotations__r   r   r   Úfloatr   r   r   r   r&   r.   r/   r   r   r   r   r   r3   Ú__classcell__r$   r$   r)   r+   r       s:   
 +ýþýüûÿÿÿþr   N)Úcollections.abcr   Útypingr   r   r   r   Útorchr   Útyping_extensionsr   Ú#torchmetrics.functional.image.ergasr	   r
   Útorchmetrics.metricr   Útorchmetrics.utilitiesr   Útorchmetrics.utilities.datar   Útorchmetrics.utilities.importsr   Útorchmetrics.utilities.plotr   r   Ú__doctest_skip__r   r$   r$   r$   r+   Ú<module>   s   