CorrectFlatField
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
def CorrectFlatField( inImage: Image, inFlatField: Image, inOutputMaxValue: float, outImage: Image, /, *, inDarkFrame: Image | None = None, inRoi: Region | None = None ) -> None
Parameters
| Name | Type | Default | Description | |
|---|---|---|---|---|
![]() |
inImage | Image | Raw captured image | |
![]() |
inFlatField | Image | Averaged flat-field reference image | |
![]() |
inDarkFrame | Image | None | None | Averaged dark frame; when set, dark signal is subtracted from both images before division |
![]() |
inRoi | Region | None | None | Range of pixels to be processed |
![]() |
inOutputMaxValue | float | Target white level after correction (e.g. 255 for UInt8) | |
![]() |
outImage | Image | Output image |


