NI Vision for LabVIEW

IMAQ Flat Field Parameters VI

  • Updated2023-02-21
  • 9 minute(s) read
Owning Palette: FPGA Utilities
Requires: NI Vision Development Module

Returns the median of the supplied image or images. Pass the resulting median image to the IMAQ FPGA Flat Field Correction VI.

Examples

IMAQ Flat Field Parameters - Flat Field Image Streaming

Returns the Median of the supplied image or images. If the Flat Field Image and Dark Field Image are connected, this VI returns the median of the Dark Field Image subtracted from the Flat Field Image. If only the Flat Field Image is connected, this VI returns the median of the Flat Field Image.

IMAQ Flat Field Parameters - Flat Field Image Streaming

cgenclasstagrefflat.gif

Flat Field Image is a flat field image.

cgenclasstagrefflat.gif

Dark Field Image is a dark field image.

cerrcodeclst.gif

error in (no error) describes the error status before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.

cbool.gif

status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.

ci32.gif

code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.

cstr.gif

source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.

ii32.gif

Median is the median intensity value of the reconstructed flat field image. Pass this parameter as an input to the IMAQ FPGA Flat Field Correction VI.

ierrcodeclst.gif

error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out indicator on the front panel and select Explain Error from the shortcut menu for more information about the error.

ibool.gif

status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.

ii32.gif

code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.

istr.gif

source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.

IMAQ Flat Field Parameters - Flat Field Image Estimation

Returns the Median of the Image Src and a set of polynomial Coefficients by fitting a mathematical model on the source image.

IMAQ Flat Field Parameters - Flat Field Image Estimation

cgenclasstagrefflat.gif

Image Src is a reference to the source image.

cgenclasstagrefflat.gif

Mask Image is the reference to the mask image. The mask image represents the background region on Image Src.

ccclst.gif

Surface Fit Options is a cluster of options used to determine the surface fit to construct the flat field image.

ci32.gif

Model specifies the surface fitting model to use.

Polynomial (0)

Uses a 2D polynomial mathematical model to determine the image.

cnclst.gif

Sampling Grid Size is a cluster specifying the size of the grid the VI uses when fitting the Model. The larger the grid size is, the more accurate the fit will be. The time to estimate the flat field image will increase the larger the grid size is.

ci32.gif

SizeX is the size of the window in the x-dimension.

ci32.gif

SizeY is the size of the window in the y-dimension.

ci32.gif

Polynomial Degree specifies the polynomial degree the algorithm uses to estimate the background of the image. The time to estimate the flat field image will increase the larger the degree is.

cerrcodeclst.gif

error in (no error) describes the error status before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.

cbool.gif

status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.

ci32.gif

code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.

cstr.gif

source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.

ccclst.gif

Background Estimation Options is a cluster of options used to estimate the background region of Image Src.

cbool.gif

Estimate Background? enables background estimation algorithm when set to TRUE.

ci32.gif

Method selects the method the algorithm uses to estimate the background of the model image.

Polynomial (0)

Uses a polynomial algorithm with a specified Polynomial Degree to estimate the background.

Background Correction (1)

Performs background correction to eliminate non-uniform lighting effects and then performs thresholding using the interclass variance thresholding algorithm.

NiBlack (2)

Computes thresholds for each pixel based on its local statistics using the NiBlack local thresholding algorithm.

ci32.gif

Polynomial Degree specifies the polynomial degree the algorithm uses to estimate the background of the image. The time to estimate the flat field image will increase the larger the degree is.

cnclst.gif

Window Size (32x32) is a cluster specifying the size of the window the VI uses when calculating a local threshold.

ci32.gif

SizeX is the size of the window in the x-dimension.

ci32.gif

SizeY is the size of the window in the y-dimension.

cdbl.gif

Niblack Deviation Factor (0.2) specifies the k constant used in the Niblack local thresholding algorithm, which determines the weight applied to the variance calculation. Valid k constants range from 0 to 1. The lower the Deviation Factor, the closer the pixel value must be to the mean value to be selected as part of a particle. Setting the Niblack Deviation Factor to 0 will increase the performance of the VI because the VI will not calculate the variance for any of the pixels.

iu16.gif

Median is the median intensity value of the reconstructed flat field image. Pass this parameter as an input to the IMAQ FPGA Flat Field Correction VI.

icclst.gif

Coefficients is a cluster with normalized Polynomial Coefficients and Image Size. Pass this parameter as an input to the IMAQ FPGA Generate Flat Field Image VI.

i1ddbl.gif

Polynomial Coefficients is an array of normalized polynomial coefficients to reconstruct the flat field image in FPGA.

inclst.gif

Image Size is a cluster that returns the image size of Image Src.

iu32.gif

Width returns the width of the image, in pixels.

iu32.gif

Height returns the height of the image, in pixels.

igenclasstagrefflat.gif

Image (duplicate) is a reference to the source image.

ierrcodeclst.gif

error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out indicator on the front panel and select Explain Error from the shortcut menu for more information about the error.

ibool.gif

status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.

ii32.gif

code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.

istr.gif

source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.

Examples

Refer to the following for an example that uses this VI.

  • LabVIEW\examples\Vision FPGA\Flat Field Correction

Log in to get a better experience