IMAQ Remote Display Options VI

LabView NI Vision

IMAQ Remote Display Options VI

Owning Palette: Vision RTInstalled With: NI Vision Development Module

Sets or gets the image compression options for remote display. These compression options affect remotely acquired images that are transferred and displayed on a host machine.

Note  IMAQ Remote Display Options will not affect the remote display options for the Image Display control in versions of LabVIEW prior to LabVIEW 8.0. Use the IMAQ Flatten Image Options VI instead.

IMAQ Remote Display Options

ci32.gif

Compression (None) specifies the compression method to use when flattening the image to a string. The following values are valid:

None (0)

Performs no image compression on the image.

JPEG (1)

Performs lossy JPEG image compression on the image. JPEG compression may cause data degradation in the flattened image.

PACKED BINARY (2)

Performs lossless binary packing on the image. This setting is ideal for preserving data integrity when you are compressing binary images. Do not use this setting for nonbinary images.

ci32.gif

Quality (750) specifies the quality of the images that you transfer to your host machine for display. The default value is 750. Quality is a measure of the compression method, such that a lower compression factor results in higher image quality. The allowable range for Quality is 0 to 1000. As you lower the Quality value, you increase the amount of loss that occurs during compression.

Note  The Quality parameter is only used when you select JPEG compression.
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.

cbool.gif

Get/Set Status? (Set) specifies whether you want to get or set the remote image display options. The default value is TRUE (Set).

ii32.gif

Compression returns the compression method used for remote display.

ii32.gif

Quality returns the quality of the compression method used for remote display.

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.