viqa.fr_metrics.fsim.FSIM

class viqa.fr_metrics.fsim.FSIM(data_range=255, normalize=False, **kwargs)

Calculate the feature similarity (FSIM) between two images.

score_val

FSIM score value of the last calculation.

Type:

float

parameters

Dictionary containing the parameters for FSIM calculation.

Type:

dict

Parameters:

• data_range ({1, 255, 65535}, default=255) – Data range of the returned data in data loading. Is used for image loading when normalize is True and for the FSIM calculation. Passed to viqa.utils.load_data() and __call__().

• normalize (bool, default=False) – If True, the input images are normalized to the data_range argument.

• **kwargs (optional) – Additional parameters for data loading. The keyword arguments are passed to viqa.utils.load_data().

• chromatic (bool, default False) – If True, the input images are expected to be RGB images and FSIMc is calculated. See [1]. Passed to piq.fsim(). See the documentation under [2].

Raises:

ValueError – If data_range is not set.

Warning

This metric is not yet tested. The metric should be only used for experimental purposes.

Notes

For more information on the FSIM metric, see [1].

References

[1] (1,2)

Zhang, L., Zhang, L., Mou, X., & Zhang, D. (2011). FSIM: A feature similarity index for image quality assessment. IEEE Transactions on Image Processing, 20(8). https://doi.org/10.1109/TIP.2011.2109730

[2]

https://piq.readthedocs.io/en/latest/functions.html#piq.fsim

export_results(path, filename)

Export the score to a csv file.

Parameters:

• path (str) – The path where the csv file should be saved.

• filename (str) – The name of the csv file.

Notes

The arguments get passed to viqa.utils.export_results().

load_images(img_r, img_m)

Load the images and perform checks.

Parameters:

• img_r (np.ndarray, viqa.ImageArray, torch.Tensor, str or os.PathLike) – The reference image.

• img_m (np.ndarray, viqa.ImageArray, torch.Tensor, str or os.PathLike) – The modified image.

Returns:

• img_r (viqa.ImageArray) – The loaded reference image as an viqa.utils.ImageArray.

• img_m (viqa.ImageArray) – The loaded modified image as an viqa.utils.ImageArray.

print_score(decimals=2)

Print the FSIM score value of the last calculation.

Parameters:

decimals (int, default=2) – Number of decimal places to print the score value.

Warns:

RuntimeWarning – If score_val is not available.

score(*args, **kwargs)

Calculate the score.

Deprecated since version 3.0.0: Call the metric directly instead, e.g. metric(img_m, img_r). score will be removed in the future. For full-reference metrics.