a  d@sddlmZmZmZmZddlZddlmZmZddlm Z m Z ddl m Z ddl mZddlmZmZesrdgZGd d d e ZdS) )AnyOptionalSequenceUnionN)Tensortensor)_psnrb_compute _psnrb_update)Metric)_MATPLOTLIB_AVAILABLE)_AX_TYPE_PLOT_OUT_TYPE*PeakSignalNoiseRatioWithBlockedEffect.plotcseZdZUdZdZeed<dZeed<dZeed<e ed<e ed<e ed <e ed <de e d d fdd Z e e d dddZ e dddZdeee ee feeedddZZS)%PeakSignalNoiseRatioWithBlockedEffectaComputes `Peak Signal to Noise Ratio With Blocked Effect`_ (PSNRB). .. math:: \text{PSNRB}(I, J) = 10 * \log_{10} \left(\frac{\max(I)^2}{\text{MSE}(I, J)-\text{B}(I, J)}\right) Where :math:`\text{MSE}` denotes the `mean-squared-error`_ function. This metric is a modified version of PSNR that better supports evaluation of images with blocked artifacts, that oftens occur in compressed images. .. note:: Metric only supports grayscale images. If you have RGB images, please convert them to grayscale first. As input to ``forward`` and ``update`` the metric accepts the following input - ``preds`` (:class:`~torch.Tensor`): Predictions from model of shape ``(N,1,H,W)`` - ``target`` (:class:`~torch.Tensor`): Ground truth values of shape ``(N,1,H,W)`` As output of `forward` and `compute` the metric returns the following output - ``psnrb`` (:class:`~torch.Tensor`): float scalar tensor with aggregated PSNRB value Args: block_size: integer indication the block size kwargs: Additional keyword arguments, see :ref:`Metric kwargs` for more info. Example: >>> import torch >>> from torchmetrics.image import PeakSignalNoiseRatioWithBlockedEffect >>> metric = PeakSignalNoiseRatioWithBlockedEffect() >>> _ = torch.manual_seed(42) >>> preds = torch.rand(2, 1, 10, 10) >>> target = torch.rand(2, 1, 10, 10) >>> metric(preds, target) tensor(7.2893) Tis_differentiablehigher_is_betterFfull_state_updatesum_squared_errortotalbef data_rangeN) block_sizekwargsreturnc stjfi|t|ts,|dkr,td||_|jdtddd|jdtddd|jd tddd|jd tdd ddS) Nz4Argument ``block_size`` should be a positive integerrgsum)defaultZdist_reduce_fxrrrrmax)super__init__ isinstanceint ValueErrorrZ add_stater)selfrr __class__a/var/www/html/stable-diffusion-webui/venv/lib/python3.9/site-packages/torchmetrics/image/psnrb.pyr Isz.PeakSignalNoiseRatioWithBlockedEffect.__init__)predstargetrcCsdt|||jd\}}}|j|7_|j|7_|j|7_t|jt|t ||_dS)z*Update state with predictions and targets.)rN) r rrrrtorchmaximumrrmin)r$r)r*rrZn_obsr'r'r(updateXs z,PeakSignalNoiseRatioWithBlockedEffect.update)rcCst|j|j|j|jS)z.Compute peak signal-to-noise ratio over state.)rrrrr)r$r'r'r(compute`sz-PeakSignalNoiseRatioWithBlockedEffect.compute)valaxrcCs |||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 PeakSignalNoiseRatioWithBlockedEffect >>> metric = PeakSignalNoiseRatioWithBlockedEffect() >>> metric.update(torch.rand(2, 1, 10, 10), torch.rand(2, 1, 10, 10)) >>> fig_, ax_ = metric.plot() .. plot:: :scale: 75 >>> # Example plotting multiple values >>> import torch >>> from torchmetrics.image import PeakSignalNoiseRatioWithBlockedEffect >>> metric = PeakSignalNoiseRatioWithBlockedEffect() >>> values = [ ] >>> for _ in range(10): ... values.append(metric(torch.rand(2, 1, 10, 10), torch.rand(2, 1, 10, 10))) >>> fig_, ax_ = metric.plot(values) )Z_plot)r$r0r1r'r'r(plotds(r)r)NN)__name__ __module__ __qualname____doc__rbool__annotations__rrrr"rr r.r/rrrr r r2 __classcell__r'r'r%r(rs* #   r)typingrrrrr+rrZ#torchmetrics.functional.image.psnrbrr Ztorchmetrics.metricr Ztorchmetrics.utilities.importsr Ztorchmetrics.utilities.plotr r Z__doctest_skip__rr'r'r'r(s