NI Vision for LabVIEW

IMAQ SSIM VI

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

Determines the quality of a Test Image by comparing it to a Reference Image. SSIM evaluates characteristics that are perceptible to the human eye.

Examples

IMAQ Fast SSIM

Determines the structural similarity of a Test Image by comparing it to a Reference Image. SSIM evaluates characteristics that are perceptible to the human eye. Fast SSIM uses gradient information for an entire local window to reduce computational complexity. Choose Fast SSIM when the image contains clear structural information, such as strong edges.

Supported Image Types

8-bit unsigned grayscale

IMAQ Fast SSIM

ci32.gif

Window Size specifies the size of the local window.

cgenclasstagrefflat.gif

Test Image is a reference to the image whose quality you want to determine by comparing it with Reference Image.

cgenclasstagrefflat.gif

Reference Image specifies an image against which the quality of Test Image is checked.

cgenclasstagrefflat.gif

SSIM Image In is a reference to the destination image for the result SSIM 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.

inclst.gif

SSIM Components is a cluster that returns the Luminance and Contrast & Structural terms of the SSIM, averaged over all local windows. Refer to the NI Vision Concepts Help for more information about the luminance, contrast, and structural terms of SSIM.

idbl.gif

Luminance specifies a constant which ensures that the denominator for luminance is non-zero.

idbl.gif

Contrast & Structural specifies a constant which ensures that the denominators for contrast and structural are non-zero.

igenclasstagrefflat.gif

Test Image Out (dup) is a reference to the image whose quality you want to determine by comparing it with Reference Image.

idbl.gif

Mean SSIM specifies the mean SSIM for all local windows.

igenclasstagrefflat.gif

SSIM Image Out is a reference to the destination image for the result SSIM image.

ierrcodeclst.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.

ibool.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.

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 Normal SSIM

Determines the quality of a Test Image by comparing it to a Reference Image. SSIM evaluates characteristics that are perceptible to the human eye. Choose Normal SSIM when the image has low contrast or does not contain clear structural information; for example, when the image is a texture sample.

Supported Image Types

8-bit unsigned grayscale

IMAQ Normal SSIM

ci32.gif

Window Size specifies the size of the local window.

cgenclasstagrefflat.gif

Test Image is a reference to the image whose quality you want to determine by comparing it with Reference Image.

cgenclasstagrefflat.gif

Reference Image specifies an image against which the quality of Test Image is checked.

cgenclasstagrefflat.gif

SSIM Image In is a reference to the destination image for the result SSIM 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.

inclst.gif

SSIM Components is a cluster that returns the Luminance and Contrast & Structural terms of the SSIM, averaged over all local windows. Refer to the NI Vision Concepts Help for more information about the luminance, contrast, and structural terms of SSIM.

idbl.gif

Luminance specifies a constant which ensures that the denominator for luminance is non-zero.

idbl.gif

Contrast & Structural specifies a constant which ensures that the denominators for contrast and structural are non-zero.

igenclasstagrefflat.gif

Test Image Out (dup) is a reference to the image whose quality you want to determine by comparing it with Reference Image.

idbl.gif

Mean SSIM specifies the mean SSIM for all local windows.

igenclasstagrefflat.gif

SSIM Image Out is a reference to the destination image for the result SSIM image.

ierrcodeclst.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.

ibool.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.

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 examples that use this VI.

  • LabVIEW\examples\Vision\Analysis\SSIM.vi