IMAQ SSIM VI
- Updated2023-02-21
- 9 minute(s) read
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.
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

![]() |
Window Size specifies the size of the local window. |
||||||
![]() |
Test Image is a reference to the image whose quality you want to determine by comparing it with Reference Image. |
||||||
![]() |
Reference Image specifies an image against which the quality of Test Image is checked. |
||||||
![]() |
SSIM Image In is a reference to the destination image for the result SSIM image. |
||||||
![]() |
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.
|
||||||
![]() |
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.
|
||||||
![]() |
Test Image Out (dup) is a reference to the image whose quality you want to determine by comparing it with Reference Image. |
||||||
![]() |
Mean SSIM specifies the mean SSIM for all local windows. |
||||||
![]() |
SSIM Image Out is a reference to the destination image for the result SSIM image. |
||||||
![]() |
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.
|
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

![]() |
Window Size specifies the size of the local window. |
||||||
![]() |
Test Image is a reference to the image whose quality you want to determine by comparing it with Reference Image. |
||||||
![]() |
Reference Image specifies an image against which the quality of Test Image is checked. |
||||||
![]() |
SSIM Image In is a reference to the destination image for the result SSIM image. |
||||||
![]() |
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.
|
||||||
![]() |
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.
|
||||||
![]() |
Test Image Out (dup) is a reference to the image whose quality you want to determine by comparing it with Reference Image. |
||||||
![]() |
Mean SSIM specifies the mean SSIM for all local windows. |
||||||
![]() |
SSIM Image Out is a reference to the destination image for the result SSIM image. |
||||||
![]() |
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.
|
Examples
Refer to the following for examples that use this VI.
- LabVIEW\examples\Vision\Analysis\SSIM.vi











