Table Of Contents

Flat Field Correction (G Dataflow)

Last Modified: June 25, 2019

Corrects image intensity using flat field and dark field images and returns a corrected image.

Recreate the flat field image whenever the imaging setup changes. Use the Compute Average Image node or the Compute Median Image node to create the image for the flat field image in input.

connector_pane_image
datatype_icon

ROI descriptor

Region of interest (ROI) within which the flat field operation is computed.

datatype_icon

global rectangle

Coordinates of the bounding rectangle.

datatype_icon

contours

Individual shapes that define an ROI.

datatype_icon

ID

Object specifying if contour is the external or internal edge of an ROI.

datatype_icon

Type

Shape type of the contour.

datatype_icon

Coordinates

Relative position of the contour.

datatype_icon

image src

Reference to the source image.

datatype_icon

image dst

Reference to destination flat field image.

datatype_icon

flat field image in

Input used to correct image src.

datatype_icon

dark field image

Input used to correct image src.

You can create a dark field image by covering the camera lens and capturing an image.

datatype_icon

error in

Error conditions that occur before this node runs.

The node responds to this input according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Default: No error

datatype_icon

correction options

Cluster of options that affect how the node creates the flat field image.

datatype_icon

line scan image?

Boolean used to specify if image src is a line scan image.

If image src is a line scan image, set this parameter to True.

Default: False

datatype_icon

correction factor

Mean bias computed from the flat field image.

Typically this parameter ranges from 1 to 1.5. Increasing this value will brighten image dst out.

datatype_icon

optimize correction

Pre-computation of flat field images.

When enabled, the node consumes more memory to speed up the correction of subsequent images.

datatype_icon

image dst out

Corrected image result.

datatype_icon

flat field image out

Duplicate reference to the flat field image.

Contains the computation table for faster correction if optimize correction is enabled.

datatype_icon

error out

Error information.

The node produces this output according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Where This Node Can Run:

Desktop OS: Windows

FPGA: Not supported

Web Server: Not supported in VIs that run in a web application


Recently Viewed Topics