get_mean_raw_contrast

hcipy.metrics.get_mean_raw_contrast(img, mask, ref_img)

Get the mean raw contrast in a masked region of interest.

Parameters

imgField or array_like

The focal-plane image.

maskField or array_like

A binary array describing the region of interest.

img_refField or array_like

A reference focal-plane image without aberrations. This is used to determine the Strehl ratio.

Returns

scalar

The mean raw contrast in the region of interest.