IMAQ Flatten Image to String VI

LabView NI Vision

IMAQ Flatten Image to String VI

Owning Palette: Image ManagementInstalled With: NI Vision Development Module

Returns the string representation of an image using the provided options.

IMAQ Flatten Image to String

cgenclasstagrefflat.gif

Image is a reference to the source image.

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

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.

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.

ci32.gif

Quality (750) specifies the quality of the image stored in the 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.
istr.gif

Data String is the LabVIEW string containing the string representation of the image. Use the Unflatten from String LabVIEW primitive to convert this string back to an image. If an image has the same name as the flattened image in memory, when the string is unflattened, the contents of the flattened image string are copied to the image. Otherwise, a new image with a unique name is created that contains the contents of the flattened image string.

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.