o yi@sddlmZmZmZddlZddlmZmZddlmZddl m Z m Z   dded ed ed e d ed def ddZ ddededeeeeedffdeeeffddZ    ddeded ee d e d ed deeeeedffdefddZdS))OptionalTupleUnionN)Tensortensor)Literal)rank_zero_warnreduce$@elementwise_meansum_squared_errorn_obs data_rangebase reduction)r sumnoneNreturncCs>dt|t||}|dtt|}t||dS)aComputes peak signal-to-noise ratio. Args: sum_squared_error: Sum of square of errors over all observations n_obs: Number of predictions or observations data_range: the range of the data. If None, it is determined from the data (max - min). ``data_range`` must be given when ``dim`` is not None. 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 Example: >>> preds = torch.tensor([[0.0, 1.0], [2.0, 3.0]]) >>> target = torch.tensor([[3.0, 2.0], [1.0, 0.0]]) >>> data_range = target.max() - target.min() >>> sum_squared_error, n_obs = _psnr_update(preds, target) >>> _psnr_compute(sum_squared_error, n_obs, data_range) tensor(2.5527)  )r)torchlogrr )r r rrr psnr_base_e psnr_valsrV/home/ubuntu/.local/lib/python3.10/site-packages/torchmetrics/functional/image/psnr.py _psnr_computes rpredstargetdim.cCs|durtt||d}t||jd}||fS||}tj|||d}t|tr2|g}nt|}|sEt||jd}||fSt| |jd| }| |}||fS)a[Updates and returns variables required to compute peak signal-to-noise ratio. Args: preds: Predicted tensor target: Ground truth tensor 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. Nr)devicer) rrpowrnumelr isinstanceintlistsizeprod expand_as)rrrr r diffdim_listrrr _psnr_update:s  r,cCsz|dur|dkrtd|d|dur%|durtd||}ntt|}t|||d\}}t|||||dS)aComputes the peak signal-to-noise ratio. Args: preds: estimated signal target: groun truth signal data_range: the range of the data. If None, it is determined from the data (max - min). ``data_range`` must be given when ``dim`` is not None. 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. Return: Tensor with PSNR score Raises: ValueError: If ``dim`` is not ``None`` and ``data_range`` is not provided. Example: >>> from torchmetrics.functional import peak_signal_noise_ratio >>> pred = torch.tensor([[0.0, 1.0], [2.0, 3.0]]) >>> target = torch.tensor([[3.0, 2.0], [1.0, 0.0]]) >>> peak_signal_noise_ratio(pred, target) tensor(2.5527) .. note:: Half precision is only support on GPU for this metric Nr zThe `reduction=z.` will not have any effect when `dim` is None.z6The `data_range` must be given when `dim` is not None.r!)rr)r ValueErrormaxminrfloatr,r)rrrrrrr r rrrpeak_signal_noise_ratio]s+ r1)r r )N)Nr r N)typingrrrrrrtyping_extensionsrtorchmetrics.utilitiesrr r0rr%r,r1rrrrsb   &  &