Class Interface
===============

Full Reference Metrics
----------------------
Structural Similarity (SSIM)
''''''''''''''''''''''''''''
.. autoclass:: piq.SSIMLoss
    :members:

Multi-Scale Structural Similarity (MS-SSIM)
'''''''''''''''''''''''''''''''''''''''''''
.. autoclass:: piq.MultiScaleSSIMLoss
    :members:

Information Content Weighted Structural Similarity (IW-SSIM)
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
.. autoclass:: piq.InformationWeightedSSIMLoss
    :members:

Visual Information Fidelity (VIFp)
''''''''''''''''''''''''''''''''''
.. autoclass:: piq.VIFLoss
    :members:

Feature Similarity Index Measure (FSIM)
'''''''''''''''''''''''''''''''''''''''
.. autoclass:: piq.FSIMLoss
    :members:

Spectral Residual based Similarity Measure (SR-SIM)
'''''''''''''''''''''''''''''''''''''''''''''''''''
.. autoclass:: piq.SRSIMLoss
    :members:

Gradient Magnitude Similarity Deviation (GMSD)
''''''''''''''''''''''''''''''''''''''''''''''
.. autoclass:: piq.GMSDLoss
    :members:

Multi-Scale Gradient Magnitude Similarity Deviation (MS-GMSD)
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
.. autoclass:: piq.MultiScaleGMSDLoss
    :members:

Visual Saliency-induced Index (VSI)
'''''''''''''''''''''''''''''''''''
.. autoclass:: piq.VSILoss
    :members:

DCT Subband Similarity Index (DSS)
'''''''''''''''''''''''''''''''''''
.. autoclass:: piq.DSSLoss
    :members:

Haar Perceptual Similarity Index (HaarPSI)
''''''''''''''''''''''''''''''''''''''''''
.. autoclass:: piq.HaarPSILoss
    :members:

Mean Deviation Similarity Index (MDSI)
''''''''''''''''''''''''''''''''''''''
.. autoclass:: piq.MDSILoss
    :members:

Learned Perceptual Image Patch Similarity (LPIPS)
'''''''''''''''''''''''''''''''''''''''''''''''''
.. autoclass:: piq.LPIPS
    :members:

Perceptual Image-Error Assessment through Pairwise Preference(PieAPP)
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
.. autoclass:: piq.PieAPP
    :members:

Deep Image Structure and Texture Similarity(DISTS)
''''''''''''''''''''''''''''''''''''''''''''''''''
.. autoclass:: piq.DISTS
    :members:

Style Score
'''''''''''
.. autoclass:: piq.StyleLoss
    :members:

Content Score
'''''''''''''
.. autoclass:: piq.ContentLoss
    :members:


No Reference Metrics
--------------------
Total Variation
'''''''''''''''
.. autoclass:: piq.TVLoss
    :members:

Blind/Referenceless Image Spatial Quality Evaluator (BRISQUE)
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
.. autoclass:: piq.BRISQUELoss
    :members:

CLIP-IQA
''''''''
.. autoclass:: piq.CLIPIQA
    :members:


Feature Metrics
---------------
Inseption Score (IS)
''''''''''''''''''''
.. autoclass:: piq.IS
    :members:

Frechet Inception Distance (FID)
''''''''''''''''''''''''''''''''
.. autoclass:: piq.FID
    :members:

Geometry Score (GS)
'''''''''''''''''''
.. autoclass:: piq.GS
    :members:

Kernel Inception Distance (KID)
'''''''''''''''''''''''''''''''
.. autoclass:: piq.KID
    :members:

Multi-Scale Intrinsic Distance (MSID)
'''''''''''''''''''''''''''''''''''''
.. autoclass:: piq.MSID
    :members:

Improved Precision and Recall (P&R)
'''''''''''''''''''''''''''''''''''
.. autoclass:: piq.PR
    :members:
