IMAQ Write String VI

NI Vision 2019 for LabVIEW Help

Edition Date: March 2019

Part Number: 370281AG-01

»View Product Info
Vision Developoment Module 2019 Help
Vision Development Module 2020 Help
Owning Palette: Files
Requires: NI Vision Development Module

Returns a string that contains the entire contents of the image encoded as an image file. The string can be saved to file, or, for example, transferred to a remote computer using FTP.

Use the pull-down menu to select an instance of this VI.

IMAQ Write BMP String

Returns a string that contains the entire contents of the image encoded as a BMP image file.

Supported Image Types

8-bit unsigned grayscale 32-bit RGB

IMAQ Write BMP String

/images/reference/en-XX/help/370281AG-01/c1dnclst.gif

Color Palette is used to apply a color palette to an image. Color Palette is an array of clusters constructed by the user or supplied by the IMAQ GetPalette VI. This palette is composed of 256 elements for each of the three color planes (red, green, and blue). A specific color is the result of applying a value between 0 and 255 to each of the three color planes. If the three planes have identical values, a gray level is obtained (0 specifies black and 255 specifies white). If the image type requires a color palette and it is not supplied, a grayscale color palette is generated and written.

/images/reference/en-XX/help/370281AG-01/cu8.gif

Red is the value of the red color plane.

/images/reference/en-XX/help/370281AG-01/cu8.gif

Green is the value of the green color plane.

/images/reference/en-XX/help/370281AG-01/cu8.gif

Blue is the value of the blue color plane.

/images/reference/en-XX/help/370281AG-01/cgenclasstagrefflat.gif

Image is a reference to the image structure to write as an image file.

/images/reference/en-XX/help/370281AG-01/cbool.gif

Compress? (N) designates whether to compress the BMP file. By default, the image file is not compressed (FALSE). If it is compressed, it uses the Run Length Encoded compression type.

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/igenclasstagrefflat.gif

Image Out (duplicate) is a reference to Image. This VI does not modify the image connected to the Image input.

/images/reference/en-XX/help/370281AG-01/istr.gif

File String Out is a string that contains the entire contents of the encoded image file. The string can then be saved to disk using binary file writing VIs, or transmitted to another computer.

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/ibool.gif

status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/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.

IMAQ Write JPEG String

Returns a string that contains the entire contents of the image encoded as a JPEG image file.

Supported Image Types

8-bit unsigned grayscale 16-bit unsigned grayscale 32-bit RGB

IMAQ Write JPEG String

/images/reference/en-XX/help/370281AG-01/c1dnclst.gif

Color Palette is used to apply a color palette to an image. Color Palette is an array of clusters constructed by the user or supplied by the IMAQ GetPalette VI. This palette is composed of 256 elements for each of the three color planes (red, green, and blue). A specific color is the result of applying a value between 0 and 255 to each of the three color planes. If the three planes have identical values, a gray level is obtained (0 specifies black and 255 specifies white). If the image type requires a color palette and it is not supplied, a grayscale color palette is generated and written.

/images/reference/en-XX/help/370281AG-01/cu8.gif

Red is the value of the red color plane.

/images/reference/en-XX/help/370281AG-01/cu8.gif

Green is the value of the green color plane.

/images/reference/en-XX/help/370281AG-01/cu8.gif

Blue is the value of the blue color plane.

/images/reference/en-XX/help/370281AG-01/cgenclasstagrefflat.gif

Image is a reference to the image structure to write as an image file.

/images/reference/en-XX/help/370281AG-01/cu32.gif

Image Quality specifies the amount of compression applied to the image. Image Quality can range from 0 to 1000. The default value is 750. The higher the value, the less compression the VI applies.

Note  JPEG compression is lossy, which means that the lower the quality specified, the more loss takes place during the compression. Also, a small amount of loss can occur even when the quality is 1000.
/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/igenclasstagrefflat.gif

Image Out (duplicate) is a reference to Image. This VI does not modify the image connected to the Image input.

/images/reference/en-XX/help/370281AG-01/istr.gif

FileString is a string that contains the entire contents of the encoded image file. The string can then be saved to disk using binary file writing VIs, or transmitted to another computer.

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/ibool.gif

status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/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.

IMAQ Write PNG String

Returns a string that contains the entire contents of the image encoded as a PNG image file.

Supported Image Types

8-bit unsigned grayscale 16-bit unsigned grayscale 32-bit RGB 16-bit signed grayscale 64-bit RGB

IMAQ Write PNG String

/images/reference/en-XX/help/370281AG-01/c1dnclst.gif

Color Palette is used to apply a color palette to an image. Color Palette is an array of clusters constructed by the user or supplied by the IMAQ GetPalette VI. This palette is composed of 256 elements for each of the three color planes (red, green, and blue). A specific color is the result of applying a value between 0 and 255 to each of the three color planes. If the three planes have identical values, a gray level is obtained (0 specifies black and 255 specifies white). If the image type requires a color palette and it is not supplied, a grayscale color palette is generated and written.

/images/reference/en-XX/help/370281AG-01/cu8.gif

Red is the value of the red color plane.

/images/reference/en-XX/help/370281AG-01/cu8.gif

Green is the value of the green color plane.

/images/reference/en-XX/help/370281AG-01/cu8.gif

Blue is the value of the blue color plane.

/images/reference/en-XX/help/370281AG-01/cgenclasstagrefflat.gif

Image is a reference to the image structure to write as an image file.

/images/reference/en-XX/help/370281AG-01/cu32.gif

Image Quality specifies the amount of compression applied to the image. Image Quality can range from 0 to 1000. The default value is 750. The higher the value, the less compression the VI applies.

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/cbool.gif

Use bit depth? (false) When saving a signed 16-bit image to a PNG file, NI Vision must convert the data to an unsigned format and shift the data so that most significant bit is always the leftmost bit. Set this parameter to TRUE to use the bit depth information attached to the image to perform these conversions. Set this parameter to FALSE to bias the image by adding a constant value to all the pixels in the image such that the lowest negative pixel value in the image maps to zero, and then shifting the image data based on the highest pixel value in the image. The default is FALSE.

/images/reference/en-XX/help/370281AG-01/igenclasstagrefflat.gif

Image Out (duplicate) is a reference to Image. This VI does not modify the image connected to the Image input.

/images/reference/en-XX/help/370281AG-01/istr.gif

FileString is a string that contains the entire contents of the encoded image file. The string can then be saved to disk using binary file writing VIs, or transmitted to another computer.

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/ibool.gif

status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/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.

IMAQ Write Image And Vision Info String

Writes an image, along with extra vision information associated with the image, to a PNG file. This extra vision information includes overlay information, pattern matching template information, and calibration information.

Note  The extra vision information can only be saved with the PNG file format.

Supported Image Types

8-bit unsigned grayscale 16-bit unsigned grayscale 32-bit RGB 16-bit signed grayscale 64-bit RGB 32-bit HSL

IMAQ Write Image And Vision Info String

/images/reference/en-XX/help/370281AG-01/c1dnclst.gif

Color Palette is used to apply a color palette to an image. Color Palette is an array of clusters constructed by the user or supplied by the IMAQ GetPalette VI. This palette is composed of 256 elements for each of the three color planes (red, green, and blue). A specific color is the result of applying a value between 0 and 255 to each of the three color planes. If the three planes have identical values, a gray level is obtained (0 specifies black and 255 specifies white). If the image type requires a color palette and it is not supplied, a grayscale color palette is generated and written.

/images/reference/en-XX/help/370281AG-01/cu8.gif

Red is the value of the red color plane.

/images/reference/en-XX/help/370281AG-01/cu8.gif

Green is the value of the green color plane.

/images/reference/en-XX/help/370281AG-01/cu8.gif

Blue is the value of the blue color plane.

/images/reference/en-XX/help/370281AG-01/cgenclasstagrefflat.gif

Image is a reference to the image structure to write as an image file.

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/igenclasstagrefflat.gif

Image Out (duplicate) is a reference to Image. This VI does not modify the image connected to the Image input.

/images/reference/en-XX/help/370281AG-01/istr.gif

File String Out is a string that contains the entire contents of the encoded image file. The string can then be saved to disk using binary file writing VIs, or transmitted to another computer.

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/ibool.gif

status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/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.

IMAQ Write TIFF String

Returns a string that contains the entire contents of the image encoded as a TIFF image file.

Note  16-bit monochrome images and 64-bit RGB images are nonstandard extensions of the TIFF standard. Most third-party applications cannot read 16-bit monochrome or 64-bit RGB TIFF files. For compatibility with most applications, write 16-bit monochrome images or 64-bit RGB images into PNG files.

Supported Image Types

8-bit unsigned grayscale 16-bit unsigned grayscale 32-bit RGB 16-bit signed grayscale 64-bit RGB

IMAQ Write TIFF String

/images/reference/en-XX/help/370281AG-01/c1dnclst.gif

Color Palette is used to apply a color palette to an image. Color Palette is an array of clusters constructed by the user or supplied by the IMAQ GetPalette VI. This palette is composed of 256 elements for each of the three color planes (red, green, and blue). A specific color is the result of applying a value between 0 and 255 to each of the three color planes. If the three planes have identical values, a gray level is obtained (0 specifies black and 255 specifies white). If the image type requires a color palette and it is not supplied, a grayscale color palette is generated and written.

/images/reference/en-XX/help/370281AG-01/cu8.gif

Red is the value of the red color plane.

/images/reference/en-XX/help/370281AG-01/cu8.gif

Green is the value of the green color plane.

/images/reference/en-XX/help/370281AG-01/cu8.gif

Blue is the value of the blue color plane.

/images/reference/en-XX/help/370281AG-01/cgenclasstagrefflat.gif

Image is a reference to the image structure to write as an image file.

/images/reference/en-XX/help/370281AG-01/cnclst.gif

TIFF Options is a cluster of optional values that you can use to set TIFF options. This cluster consists of the following elements:

/images/reference/en-XX/help/370281AG-01/ci32.gif

Rows Per Strip designates the number of rows you want to designate per strip of data. The default value of 0 specifies to write the entire data as one strip.

/images/reference/en-XX/help/370281AG-01/ci32.gif

Photometric designates whether to interpret white or black as a zero value.

WhiteIsZero (0)

Designates white as the zero value

BlackIsZero (1)

Designates black as the zero value

/images/reference/en-XX/help/370281AG-01/ci32.gif

Compression Type determines the compression type. By default, no compression is used. Choose from the following options:

Note  The JPEG compression type is not valid for 16-bit monochrome or 64-bit RGB images.
Note  If you select the JPEG compression type, the VI ignores the Color Palette.
None (0)

No compression is used on the image

JPEG (1)

JPEG compression is used on the image

Run Length Encoded (2)

Run Length Encoding is used on the image

Zip (3)

Zip compression is used on the image

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/igenclasstagrefflat.gif

Image Out (duplicate) is a reference to Image. This VI does not modify the image connected to the Image input.

/images/reference/en-XX/help/370281AG-01/istr.gif

FileString is a string that contains the entire contents of the encoded image file. The string can then be saved to disk using binary file writing VIs, or transmitted to another computer.

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/ibool.gif

status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.

/images/reference/en-XX/help/370281AG-01/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.

/images/reference/en-XX/help/370281AG-01/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.

WAS THIS ARTICLE HELPFUL?

Not Helpful