Source code for nrefocus.metrics.mt_rms_contrast

from .._ndarray_backend import xp



[docs]
def metric_rms_contrast(rfi, distance, roi=None, **kwargs):
    """Compute RMS contrast of the phase

    Notes
    -----
    The negative angle of the field is used for contrast estimation.
    """
    data = -xp.angle(rfi.propagate(distance))
    av = xp.average(data, *kwargs)
    mal = 1 / (data.shape[0] * data.shape[1])
    if roi is not None:
        data = data[roi]
    return xp.sqrt(mal * xp.sum((data - av)**2))