IMAQ Flatten Image Options VI

LabView NI Vision

previous page next page

IMAQ Flatten Image Options VI

Owning Palette: Image ManagementInstalled With: NI Vision Development Module

Sets or gets the image compression options for flattening an image to string. These compression options affect images flattened using the LabVIEW Flatten To String primitive.

Note Values specified for Compression and Quality also affect the remote display options for the Image Display control in versions of LabVIEW prior to LabVIEW 8.0. In LabVIEW 8.0 and later, the options for flattening and displaying images using the Image Display control can be specified separately. Use the IMAQ Remote Display Options VI to set the remote display options.

IMAQ Flatten Image Options

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.

Quality (750) specifies the quality of the images that will be stored when flattening an image to a string. 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.

Type of Flatten (Image and Vision Info) specifies what type of data to store in the string. The following values are valid:

Image (0)	Stores the image pixel data and overlay information in the string.
Image and Vision Info (1)	(Default) Stores the image pixel data and Vision Extra Information, such as calibration, overlay, template, and custom data information, in the image string.
Reference to Image (2)	Stores only a reference to the image in the string. Unflattening the string will return another reference to the same image. You will not be able to unflatten the string if the original image has been disposed.

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.

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

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

Compression returns the compression method used to flatten images to string.

Quality returns the quality of the compression method used to flatten images to string.

Type of Flatten returns the type of data to store when flattening an image to string.

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.

	status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
	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.
	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.

previous page start next page