Back to Aurora Vision Library Lite website

You are here: Start » Image » Image Combinators » CorrectFlatField

CorrectFlatField


Header: AVL.h
Namespace: avl

Performs flat-field correction on an image to compensate for non-uniform sensor response and illumination.

Applications: Shading correction, vignetting removal, line-scan camera calibration.

Syntax

C++
Python
 
void avl::CorrectFlatField
(
	const avl::Image& inImage,
	const avl::Image& inFlatField,
	atl::Optional<const avl::Image&> inDarkFrame,
	atl::Optional<const avl::Region&> inRoi,
	float inOutputMaxValue,
	avl::Image& outImage
)

Parameters

Name Type Default Description
Input value inImage const Image& Raw captured image
Input value inFlatField const Image& Averaged flat-field reference image
Input value inDarkFrame Optional<const Image&> NIL Averaged dark frame; when set, dark signal is subtracted from both images before division
Input value inRoi Optional<const Region&> NIL Range of pixels to be processed
Input value inOutputMaxValue float 255.0f Target white level after correction (e.g. 255 for UInt8)
Output value outImage Image& Output image

Errors

List of possible exceptions:

Error type Description
DomainError Image and dark frame formats are not the same in CorrectFlatField.
DomainError Image and dark frame sizes are not equal in CorrectFlatField.
DomainError Image and flat-field formats are not the same in CorrectFlatField.
DomainError Image and flat-field sizes are not equal in CorrectFlatField.
DomainError Region exceeds an input image in CorrectFlatField.