SAM and ERGAS for images with zero-value pixels

[maciejzj]

Hi, I am using SAM and ERGAS from TorchMetrics with images that happen to be padded with zero values (which is quite common in remote sensing). The pixels with value zero cause the metrics to (maybe?) break. SAM becomes nan and EGAS inf. The cause of this lies in the math formulas (zero divisions) so theoretically speaking the functions work correctly.

However, this is rather inconvenient. Would you consider letting the behavior of these functions change so they can handle pixels with zero value? I think it can be fixed with changing torch.sum and torch.mean to torch.nansum and torch.nanmean in several places. I am not sure what is the approach you have for the edge cases like this in the metrics.

Example of this problem in Python REPL:

>>> import torch
>>> from torchmetrics.functional.image.sam import spectral_angle_mapper as sam
>>> preds = torch.rand([16, 8, 16, 16], generator=torch.manual_seed(42))
>>> sam(preds, preds)
tensor(9.1714e-05)
>>> preds[:, :, :, 5:] = 0
>>> sam(preds, preds)
tensor(nan)

This can be easily mitigated on the user side for SAM (sam(pred, target, reduction=None).nanmean()), but I am not so sure about ERGAS.

[maciejzj]

Also, adding EPS to the divider may be a solution too.