Table Of Contents

Get Set Remote Display Options (G Dataflow)

Last Modified: March 26, 2019

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. Get Set 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 Get Set Flatten Image Options node instead.

connector_pane_image
datatype_icon

compression type in

Method of compression to use when flattening the image to a byte array.

The following values are valid:

Name Value Description
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.

datatype_icon

quality in

Quality of the images that you transfer to your host machine for display.

quality in 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 in value, you increase the amount of loss that occurs during compression. The quality in parameter is only used when you select JPEG compression.

Default: 750

datatype_icon

get/set?

Boolean value that specifies whether you want to get or set the remote image display options.

True Set the remote image display options
False Get the remote image display options

Default: True (Set)

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

compression type out

Method of compression used for remote display.

datatype_icon

quality out

Quality of the compression method used for remote display.

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