o yi@spddlmZmZddlmZddlmZddlmZm Z ddl m Z ddl m Z ddlmZGdd d e Zd S) )AnyList)Tensor)Literal)"_spectral_distortion_index_compute!_spectral_distortion_index_update)Metric)rank_zero_warn) dim_zero_catc seZdZUdZdZeed<dZeed<dZeed<e e ed<e e ed< dd e d e d de ddffdd Zde de ddfddZde fddZZS)SpectralDistortionIndexa|Computes Spectral Distortion Index (SpectralDistortionIndex_) also now as D_lambda is used to compare the spectral distortion between two images. As input to ``forward`` and ``update`` the metric accepts the following input - ``preds`` (:class:`~torch.Tensor`): Low resolution multispectral image of shape ``(N,C,H,W)`` - ``target``(:class:`~torch.Tensor`): High resolution fused image of shape ``(N,C,H,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: p: Large spectral differences 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: >>> import torch >>> _ = torch.manual_seed(42) >>> from torchmetrics import SpectralDistortionIndex >>> preds = torch.rand([16, 3, 16, 16]) >>> target = torch.rand([16, 3, 16, 16]) >>> sdi = SpectralDistortionIndex() >>> sdi(preds, target) tensor(0.0234) Thigher_is_betteris_differentiableFfull_state_updatepredstargetelementwise_meanp reductionrsumnonekwargsreturnNc stjd i|tdt|tr|dkrtd|d||_d}||vr1td|d|||_|jdgd d |jd gd d dS) NzMetric `SpectralDistortionIndex` will save all targets and predictions in buffer. For large datasets this may lead to large memory footprint.rz.Expected `p` to be a positive integer. Got p: .rz(Expected argument `reduction` be one of z but got rcat)defaultdist_reduce_fxr) super__init__r isinstanceint ValueErrorrr add_state)selfrrrALLOWED_REDUCTION __class__rO/home/ubuntu/.local/lib/python3.10/site-packages/torchmetrics/image/d_lambda.pyr Csz SpectralDistortionIndex.__init__cCs*t||\}}|j||j|dS)z#Update state with preds and target.N)rrappendrr%rrrrr)updateWs zSpectralDistortionIndex.updatecCs&t|j}t|j}t|||j|jS)z/Computes and returns spectral distortion index.)r rrrrrr+rrr)compute]s  zSpectralDistortionIndex.compute)rr)__name__ __module__ __qualname____doc__r bool__annotations__r rrrr"rrr r,r- __classcell__rrr'r)r s&  "    r N)typingrrtorchrtyping_extensionsr&torchmetrics.functional.image.d_lambdarrtorchmetrics.metricrtorchmetrics.utilitiesr torchmetrics.utilities.datar r rrrr)s