Functional Interface
====================

Full Reference Metrics
----------------------
Peak Signal-to-Noise Ratio (PSNR)
'''''''''''''''''''''''''''''''''
.. autofunction:: piq.psnr

Structural Similarity (SSIM)
''''''''''''''''''''''''''''
.. autofunction:: piq.ssim

Multi-Scale Structural Similarity (MS-SSIM)
'''''''''''''''''''''''''''''''''''''''''''
.. autofunction:: piq.multi_scale_ssim

Information Content Weighted Structural Similarity (IW-SSIM)
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
.. autofunction:: piq.information_weighted_ssim

Visual Information Fidelity (VIFp)
''''''''''''''''''''''''''''''''''
.. autofunction:: piq.vif_p

Feature Similarity Index Measure (FSIM)
'''''''''''''''''''''''''''''''''''''''
.. autofunction:: piq.fsim

Spectral Residual based Similarity (SR-SIM)
'''''''''''''''''''''''''''''''''''''''''''
.. autofunction:: piq.srsim

Gradient Magnitude Similarity Deviation (GMSD)
''''''''''''''''''''''''''''''''''''''''''''''
.. autofunction:: piq.gmsd

Multi-Scale Gradient Magnitude Similarity Deviation (MS-GMSD)
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
.. autofunction:: piq.multi_scale_gmsd

Visual Saliency-induced Index (VSI)
'''''''''''''''''''''''''''''''''''
.. autofunction:: piq.vsi

DCT Subband Similarity (DSS)
''''''''''''''''''''''''''''
.. autofunction:: piq.dss

Haar Perceptual Similarity Index (HaarPSI)
''''''''''''''''''''''''''''''''''''''''''
.. autofunction:: piq.haarpsi

Mean Deviation Similarity Index (MDSI)
''''''''''''''''''''''''''''''''''''''
.. autofunction:: piq.mdsi

No Reference Metrics
--------------------
Total Variation
'''''''''''''''
.. autofunction:: piq.total_variation

Blind/Referenceless Image Spatial Quality Evaluator (BRISQUE)
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
.. autofunction:: piq.brisque

Feature Metrics
---------------
Inception Score (IS)
''''''''''''''''''''
.. autofunction:: piq.inception_score
