Source code for skvideo.measure.mae

from ..utils import *
import numpy as np
import scipy.ndimage



[docs]
def mae(referenceVideoData, distortedVideoData):
    """Computes mean absolute error (MAE).

    Both video inputs are compared frame-by-frame to obtain T
    MAE measurements.

    Parameters
    ----------
    referenceVideoData : ndarray
        Reference video, ndarray of dimension (T, M, N, C), (T, M, N), (M, N, C), or (M, N),
        where T is the number of frames, M is the height, N is width,
        and C is number of channels.

    distortedVideoData : ndarray
        Distorted video, ndarray of dimension (T, M, N, C), (T, M, N), (M, N, C), or (M, N),
        where T is the number of frames, M is the height, N is width,
        and C is number of channels.

    Returns
    -------
    mae_array : ndarray
        The mae results, ndarray of dimension (T,), where T
        is the number of frames

    """

    referenceVideoData = vshape(referenceVideoData)
    distortedVideoData = vshape(distortedVideoData)

    if referenceVideoData.shape != distortedVideoData.shape:
        raise ValueError("reference and distorted videos must have the same shape; got %s vs %s" % (referenceVideoData.shape, distortedVideoData.shape))

    T, M, N, C = referenceVideoData.shape

    if not (C == 1):
        raise ValueError("mae called with videos containing %d channels. Please supply only the luminance channel" % (C,))

    scores = np.zeros(T, dtype=np.float32)
    for t in range(T):
        referenceFrame = referenceVideoData[t].astype(np.float32)
        distortedFrame = distortedVideoData[t].astype(np.float32)

        mae = np.mean(np.abs(referenceFrame - distortedFrame))

        scores[t] = mae

    return scores