IMAQ ImageToEDVR 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: Pixel Manipulation
Requires: NI Vision Development Module

Returns an External Data Value Reference (EDVR) array with the specified data type and dimensionality for the requested region of the source image. Refer to the Storing Data and Reducing Data Copies with Data Value References topic in the NI LabVIEW Help for general information on using External Data Value References.

Note  This VI is available only with LabVIEW 2012 or later.

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

Examples

IMAQ ImageToEDVR 2D U8

Returns a 2-D U8 External Data Value Reference (EDVR) array for the requested region of the source image.

Supported Image Types

8-bit unsigned grayscale 16-bit unsigned grayscale 32-bit RGB 16-bit signed grayscale 64-bit RGB floating point grayscale 64-bit complex 32-bit HSL

IMAQ ImageToEDVR 2D U8

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

Optional Rectangle defines a four-element array that contains the left, top, right, and bottom coordinates of the region to include in the external data value reference array. The right and bottom values are exclusive and lie outside the region. The operation applies to the entire image if the input is empty or not connected.

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

Image is a reference to the source image.

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

Include Border Pixels (F) determines whether to include the border pixels surrounding the region specified by the Optional Rectangle input in the external data value reference array. The default value is FALSE.

The size of the border included in the EDVR array is the same as the size of the border on the source Image. If this input is TRUE, all of the border pixels surrounding the region specified by the Optional Rectangle input are included. If this input is FALSE or unconnected, the border pixels are not included. For 1-D EDVR array types, the left border, right border, and alignment padding pixels are always included regardless of the input value of this control.

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

Step Sizes is a cluster containing information about the X and Y step sizes to apply to the source Image.

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

X Step Size is the vertical sampling step, which defines the columns from the source Image to be included in the external data value reference array (the horizontal reduction ratio). For example, with an X Step Size of 3, one out of every three columns is included from the source Image in the external data value reference array. Each column is included if the default value of 1 is used.

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

Y Step Size is the horizontal sampling step, which defines the lines from the source Image to be included in the external data value reference array (the vertical reduction ratio). For example, with a Y Step Size of 3, one out of every three rows is included from the source Image in the external data value reference array. Each row is included if the default value of 1 is used.

/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/irn.gif

EDVR 2D U8 is an external data value reference array which refers to the requested pixels of the source Image.

This external data value reference must be deleted before the source Image can be resized or completely disposed. Use the Delete Data Value Reference VI on the Memory Control Functions palette to delete the external data value reference. For 1-D array types, the resulting EDVR contains all of the lines concatenated together, starting with the top line and ending with the bottom line. Each line always consists of the left border, image data, right border, and padding pixels. Inspect the Line Info cluster for the width of each segment. For 3-D array types, the 3rd dimension represents the individual components of aggregate pixel types. The RGB type is broken down into blue, green, red, and alpha components. The HSL type is broken down into luminance, saturation, hue, and alpha components. The Complex type is broken down into real and imaginary components.

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

Line Info is a cluster containing information about the composition of the resulting external data value reference array. All values are in units of array elements and not source Image pixels. For 2-D and 3-D EDVR arrays, the Line Info values apply to the 2nd dimension of the EDVR array. For 1-D EDVR arrays, the Line Info values apply to a single line segment in the EDVR array. A line segment represents a single line of data from the source Image and the EDVR array consists of multiple concatenated line segments. A given line starts with the Left Border elements and is followed in order by the Image Data elements, the Right Border elements, and the Padding elements.

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

Total Width is the number of elements in the external data value reference array that represent a single line of data from the source Image. For 2-D and 3-D EDVR arrays this is equal to the size of the 2nd dimension of the EDVR array. For 1-D EDVR arrays this is the length of a single line segment of the array. Advancing the 1-D EDVR array offset by Total Width will move the offset to the next line. Total Width is equal to the sum of the Left Border, Image Data, Right Border, and Padding values in the Line Info cluster.

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

Left Border is the number of elements in the EDVR array that represent the border on the left side of the image for each line of image data.

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

Image Data is the number of elements in the EDVR array that represent the actual image data within the region specified by the Optional Rectangle input for each line of image data.

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

Right Border is the number of elements in the EDVR array that represent the border on the right side of the image for each line of image data.

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

Padding is the number of elements in the EDVR array that represent the alignment padding at the end of each line of image data.

/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 ImageToEDVR 2D I16

Returns a 2-D I16 External Data Value Reference (EDVR) array for the requested region of the source image.

Supported Image Types

8-bit unsigned grayscale 16-bit unsigned grayscale 32-bit RGB 16-bit signed grayscale 64-bit RGB floating point grayscale 64-bit complex 32-bit HSL

IMAQ ImageToEDVR 2D I16

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

Optional Rectangle defines a four-element array that contains the left, top, right, and bottom coordinates of the region to include in the external data value reference array. The right and bottom values are exclusive and lie outside the region. The operation applies to the entire image if the input is empty or not connected.

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

Image is a reference to the source image.

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

Include Border Pixels (F) determines whether to include the border pixels surrounding the region specified by the Optional Rectangle input in the external data value reference array. The default value is FALSE.

The size of the border included in the EDVR array is the same as the size of the border on the source Image. If this input is TRUE, all of the border pixels surrounding the region specified by the Optional Rectangle input are included. If this input is FALSE or unconnected, the border pixels are not included. For 1-D EDVR array types, the left border, right border, and alignment padding pixels are always included regardless of the input value of this control.

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

Step Sizes is a cluster containing information about the X and Y step sizes to apply to the source Image.

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

X Step Size is the vertical sampling step, which defines the columns from the source Image to be included in the external data value reference array (the horizontal reduction ratio). For example, with an X Step Size of 3, one out of every three columns is included from the source Image in the external data value reference array. Each column is included if the default value of 1 is used.

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

Y Step Size is the horizontal sampling step, which defines the lines from the source Image to be included in the external data value reference array (the vertical reduction ratio). For example, with a Y Step Size of 3, one out of every three rows is included from the source Image in the external data value reference array. Each row is included if the default value of 1 is used.

/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/irn.gif

EDVR 2D I16 is an external data value reference array which refers to the requested pixels of the source Image.

This external data value reference must be deleted before the source Image can be resized or completely disposed. Use the Delete Data Value Reference VI on the Memory Control Functions palette to delete the external data value reference. For 1-D array types, the resulting EDVR contains all of the lines concatenated together, starting with the top line and ending with the bottom line. Each line always consists of the left border, image data, right border, and padding pixels. Inspect the Line Info cluster for the width of each segment. For 3-D array types, the 3rd dimension represents the individual components of aggregate pixel types. The RGB type is broken down into blue, green, red, and alpha components. The HSL type is broken down into luminance, saturation, hue, and alpha components. The Complex type is broken down into real and imaginary components.

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

Line Info is a cluster containing information about the composition of the resulting external data value reference array. All values are in units of array elements and not source Image pixels. For 2-D and 3-D EDVR arrays, the Line Info values apply to the 2nd dimension of the EDVR array. For 1-D EDVR arrays, the Line Info values apply to a single line segment in the EDVR array. A line segment represents a single line of data from the source Image and the EDVR array consists of multiple concatenated line segments. A given line starts with the Left Border elements and is followed in order by the Image Data elements, the Right Border elements, and the Padding elements.

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

Total Width is the number of elements in the external data value reference array that represent a single line of data from the source Image. For 2-D and 3-D EDVR arrays this is equal to the size of the 2nd dimension of the EDVR array. For 1-D EDVR arrays this is the length of a single line segment of the array. Advancing the 1-D EDVR array offset by Total Width will move the offset to the next line. Total Width is equal to the sum of the Left Border, Image Data, Right Border, and Padding values in the Line Info cluster.

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

Left Border is the number of elements in the EDVR array that represent the border on the left side of the image for each line of image data.

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

Image Data is the number of elements in the EDVR array that represent the actual image data within the region specified by the Optional Rectangle input for each line of image data.

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

Right Border is the number of elements in the EDVR array that represent the border on the right side of the image for each line of image data.

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

Padding is the number of elements in the EDVR array that represent the alignment padding at the end of each line of image data.

/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 ImageToEDVR 2D U16

Returns a 2-D U16 External Data Value Reference (EDVR) array for the requested region of the source image.

Supported Image Types

8-bit unsigned grayscale 16-bit unsigned grayscale 32-bit RGB 16-bit signed grayscale 64-bit RGB floating point grayscale 64-bit complex 32-bit HSL

IMAQ ImageToEDVR 2D U16

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

Optional Rectangle defines a four-element array that contains the left, top, right, and bottom coordinates of the region to include in the external data value reference array. The right and bottom values are exclusive and lie outside the region. The operation applies to the entire image if the input is empty or not connected.

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

Image is a reference to the source image.

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

Include Border Pixels (F) determines whether to include the border pixels surrounding the region specified by the Optional Rectangle input in the external data value reference array. The default value is FALSE.

The size of the border included in the EDVR array is the same as the size of the border on the source Image. If this input is TRUE, all of the border pixels surrounding the region specified by the Optional Rectangle input are included. If this input is FALSE or unconnected, the border pixels are not included. For 1-D EDVR array types, the left border, right border, and alignment padding pixels are always included regardless of the input value of this control.

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

Step Sizes is a cluster containing information about the X and Y step sizes to apply to the source Image.

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

X Step Size is the vertical sampling step, which defines the columns from the source Image to be included in the external data value reference array (the horizontal reduction ratio). For example, with an X Step Size of 3, one out of every three columns is included from the source Image in the external data value reference array. Each column is included if the default value of 1 is used.

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

Y Step Size is the horizontal sampling step, which defines the lines from the source Image to be included in the external data value reference array (the vertical reduction ratio). For example, with a Y Step Size of 3, one out of every three rows is included from the source Image in the external data value reference array. Each row is included if the default value of 1 is used.

/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/irn.gif

EDVR 2D U16 is an external data value reference array which refers to the requested pixels of the source Image.

This external data value reference must be deleted before the source Image can be resized or completely disposed. Use the Delete Data Value Reference VI on the Memory Control Functions palette to delete the external data value reference. For 1-D array types, the resulting EDVR contains all of the lines concatenated together, starting with the top line and ending with the bottom line. Each line always consists of the left border, image data, right border, and padding pixels. Inspect the Line Info cluster for the width of each segment. For 3-D array types, the 3rd dimension represents the individual components of aggregate pixel types. The RGB type is broken down into blue, green, red, and alpha components. The HSL type is broken down into luminance, saturation, hue, and alpha components. The Complex type is broken down into real and imaginary components.

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

Line Info is a cluster containing information about the composition of the resulting external data value reference array. All values are in units of array elements and not source Image pixels. For 2-D and 3-D EDVR arrays, the Line Info values apply to the 2nd dimension of the EDVR array. For 1-D EDVR arrays, the Line Info values apply to a single line segment in the EDVR array. A line segment represents a single line of data from the source Image and the EDVR array consists of multiple concatenated line segments. A given line starts with the Left Border elements and is followed in order by the Image Data elements, the Right Border elements, and the Padding elements.

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

Total Width is the number of elements in the external data value reference array that represent a single line of data from the source Image. For 2-D and 3-D EDVR arrays this is equal to the size of the 2nd dimension of the EDVR array. For 1-D EDVR arrays this is the length of a single line segment of the array. Advancing the 1-D EDVR array offset by Total Width will move the offset to the next line. Total Width is equal to the sum of the Left Border, Image Data, Right Border, and Padding values in the Line Info cluster.

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

Left Border is the number of elements in the EDVR array that represent the border on the left side of the image for each line of image data.

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

Image Data is the number of elements in the EDVR array that represent the actual image data within the region specified by the Optional Rectangle input for each line of image data.

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

Right Border is the number of elements in the EDVR array that represent the border on the right side of the image for each line of image data.

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

Padding is the number of elements in the EDVR array that represent the alignment padding at the end of each line of image data.

/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 ImageToEDVR 2D U32

Returns a 2-D U32 External Data Value Reference (EDVR) array for the requested region of the source image.

Supported Image Types

8-bit unsigned grayscale 16-bit unsigned grayscale 32-bit RGB 16-bit signed grayscale 64-bit RGB floating point grayscale 64-bit complex 32-bit HSL

IMAQ ImageToEDVR 2D U32

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

Optional Rectangle defines a four-element array that contains the left, top, right, and bottom coordinates of the region to include in the external data value reference array. The right and bottom values are exclusive and lie outside the region. The operation applies to the entire image if the input is empty or not connected.

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

Image is a reference to the source image.

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

Include Border Pixels (F) determines whether to include the border pixels surrounding the region specified by the Optional Rectangle input in the external data value reference array. The default value is FALSE.

The size of the border included in the EDVR array is the same as the size of the border on the source Image. If this input is TRUE, all of the border pixels surrounding the region specified by the Optional Rectangle input are included. If this input is FALSE or unconnected, the border pixels are not included. For 1-D EDVR array types, the left border, right border, and alignment padding pixels are always included regardless of the input value of this control.

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

Step Sizes is a cluster containing information about the X and Y step sizes to apply to the source Image.

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

X Step Size is the vertical sampling step, which defines the columns from the source Image to be included in the external data value reference array (the horizontal reduction ratio). For example, with an X Step Size of 3, one out of every three columns is included from the source Image in the external data value reference array. Each column is included if the default value of 1 is used.

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

Y Step Size is the horizontal sampling step, which defines the lines from the source Image to be included in the external data value reference array (the vertical reduction ratio). For example, with a Y Step Size of 3, one out of every three rows is included from the source Image in the external data value reference array. Each row is included if the default value of 1 is used.

/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/irn.gif

EDVR 2D U32 is an external data value reference array which refers to the requested pixels of the source Image.

This external data value reference must be deleted before the source Image can be resized or completely disposed. Use the Delete Data Value Reference VI on the Memory Control Functions palette to delete the external data value reference. For 1-D array types, the resulting EDVR contains all of the lines concatenated together, starting with the top line and ending with the bottom line. Each line always consists of the left border, image data, right border, and padding pixels. Inspect the Line Info cluster for the width of each segment. For 3-D array types, the 3rd dimension represents the individual components of aggregate pixel types. The RGB type is broken down into blue, green, red, and alpha components. The HSL type is broken down into luminance, saturation, hue, and alpha components. The Complex type is broken down into real and imaginary components.

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

Line Info is a cluster containing information about the composition of the resulting external data value reference array. All values are in units of array elements and not source Image pixels. For 2-D and 3-D EDVR arrays, the Line Info values apply to the 2nd dimension of the EDVR array. For 1-D EDVR arrays, the Line Info values apply to a single line segment in the EDVR array. A line segment represents a single line of data from the source Image and the EDVR array consists of multiple concatenated line segments. A given line starts with the Left Border elements and is followed in order by the Image Data elements, the Right Border elements, and the Padding elements.

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

Total Width is the number of elements in the external data value reference array that represent a single line of data from the source Image. For 2-D and 3-D EDVR arrays this is equal to the size of the 2nd dimension of the EDVR array. For 1-D EDVR arrays this is the length of a single line segment of the array. Advancing the 1-D EDVR array offset by Total Width will move the offset to the next line. Total Width is equal to the sum of the Left Border, Image Data, Right Border, and Padding values in the Line Info cluster.

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

Left Border is the number of elements in the EDVR array that represent the border on the left side of the image for each line of image data.

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

Image Data is the number of elements in the EDVR array that represent the actual image data within the region specified by the Optional Rectangle input for each line of image data.

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

Right Border is the number of elements in the EDVR array that represent the border on the right side of the image for each line of image data.

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

Padding is the number of elements in the EDVR array that represent the alignment padding at the end of each line of image data.

/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 ImageToEDVR 2D SGL

Returns a 2-D SGL External Data Value Reference (EDVR) array for the requested region of the source image.

Supported Image Types

8-bit unsigned grayscale 16-bit unsigned grayscale 32-bit RGB 16-bit signed grayscale 64-bit RGB floating point grayscale 64-bit complex 32-bit HSL

IMAQ ImageToEDVR 2D SGL

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

Optional Rectangle defines a four-element array that contains the left, top, right, and bottom coordinates of the region to include in the external data value reference array. The right and bottom values are exclusive and lie outside the region. The operation applies to the entire image if the input is empty or not connected.

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

Image is a reference to the source image.

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

Include Border Pixels (F) determines whether to include the border pixels surrounding the region specified by the Optional Rectangle input in the external data value reference array. The default value is FALSE.

The size of the border included in the EDVR array is the same as the size of the border on the source Image. If this input is TRUE, all of the border pixels surrounding the region specified by the Optional Rectangle input are included. If this input is FALSE or unconnected, the border pixels are not included. For 1-D EDVR array types, the left border, right border, and alignment padding pixels are always included regardless of the input value of this control.

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

Step Sizes is a cluster containing information about the X and Y step sizes to apply to the source Image.

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

X Step Size is the vertical sampling step, which defines the columns from the source Image to be included in the external data value reference array (the horizontal reduction ratio). For example, with an X Step Size of 3, one out of every three columns is included from the source Image in the external data value reference array. Each column is included if the default value of 1 is used.

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

Y Step Size is the horizontal sampling step, which defines the lines from the source Image to be included in the external data value reference array (the vertical reduction ratio). For example, with a Y Step Size of 3, one out of every three rows is included from the source Image in the external data value reference array. Each row is included if the default value of 1 is used.

/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/irn.gif

EDVR 2D SGL is an external data value reference array which refers to the requested pixels of the source Image.

This external data value reference must be deleted before the source Image can be resized or completely disposed. Use the Delete Data Value Reference VI on the Memory Control Functions palette to delete the external data value reference. For 1-D array types, the resulting EDVR contains all of the lines concatenated together, starting with the top line and ending with the bottom line. Each line always consists of the left border, image data, right border, and padding pixels. Inspect the Line Info cluster for the width of each segment. For 3-D array types, the 3rd dimension represents the individual components of aggregate pixel types. The RGB type is broken down into blue, green, red, and alpha components. The HSL type is broken down into luminance, saturation, hue, and alpha components. The Complex type is broken down into real and imaginary components.

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

Line Info is a cluster containing information about the composition of the resulting external data value reference array. All values are in units of array elements and not source Image pixels. For 2-D and 3-D EDVR arrays, the Line Info values apply to the 2nd dimension of the EDVR array. For 1-D EDVR arrays, the Line Info values apply to a single line segment in the EDVR array. A line segment represents a single line of data from the source Image and the EDVR array consists of multiple concatenated line segments. A given line starts with the Left Border elements and is followed in order by the Image Data elements, the Right Border elements, and the Padding elements.

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

Total Width is the number of elements in the external data value reference array that represent a single line of data from the source Image. For 2-D and 3-D EDVR arrays this is equal to the size of the 2nd dimension of the EDVR array. For 1-D EDVR arrays this is the length of a single line segment of the array. Advancing the 1-D EDVR array offset by Total Width will move the offset to the next line. Total Width is equal to the sum of the Left Border, Image Data, Right Border, and Padding values in the Line Info cluster.

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

Left Border is the number of elements in the EDVR array that represent the border on the left side of the image for each line of image data.

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

Image Data is the number of elements in the EDVR array that represent the actual image data within the region specified by the Optional Rectangle input for each line of image data.

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

Right Border is the number of elements in the EDVR array that represent the border on the right side of the image for each line of image data.

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

Padding is the number of elements in the EDVR array that represent the alignment padding at the end of each line of image data.

/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 ImageToEDVR 2D U64

Returns a 2-D U64 External Data Value Reference (EDVR) array for the requested region of the source image.

Supported Image Types

8-bit unsigned grayscale 16-bit unsigned grayscale 32-bit RGB 16-bit signed grayscale 64-bit RGB floating point grayscale 64-bit complex 32-bit HSL

IMAQ ImageToEDVR 2D U64

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

Optional Rectangle defines a four-element array that contains the left, top, right, and bottom coordinates of the region to include in the external data value reference array. The right and bottom values are exclusive and lie outside the region. The operation applies to the entire image if the input is empty or not connected.

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

Image is a reference to the source image.

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

Include Border Pixels (F) determines whether to include the border pixels surrounding the region specified by the Optional Rectangle input in the external data value reference array. The default value is FALSE.

The size of the border included in the EDVR array is the same as the size of the border on the source Image. If this input is TRUE, all of the border pixels surrounding the region specified by the Optional Rectangle input are included. If this input is FALSE or unconnected, the border pixels are not included. For 1-D EDVR array types, the left border, right border, and alignment padding pixels are always included regardless of the input value of this control.

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

Step Sizes is a cluster containing information about the X and Y step sizes to apply to the source Image.

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

X Step Size is the vertical sampling step, which defines the columns from the source Image to be included in the external data value reference array (the horizontal reduction ratio). For example, with an X Step Size of 3, one out of every three columns is included from the source Image in the external data value reference array. Each column is included if the default value of 1 is used.

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

Y Step Size is the horizontal sampling step, which defines the lines from the source Image to be included in the external data value reference array (the vertical reduction ratio). For example, with a Y Step Size of 3, one out of every three rows is included from the source Image in the external data value reference array. Each row is included if the default value of 1 is used.

/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/irn.gif

EDVR 2D U64 is an external data value reference array which refers to the requested pixels of the source Image.

This external data value reference must be deleted before the source Image can be resized or completely disposed. Use the Delete Data Value Reference VI on the Memory Control Functions palette to delete the external data value reference. For 1-D array types, the resulting EDVR contains all of the lines concatenated together, starting with the top line and ending with the bottom line. Each line always consists of the left border, image data, right border, and padding pixels. Inspect the Line Info cluster for the width of each segment. For 3-D array types, the 3rd dimension represents the individual components of aggregate pixel types. The RGB type is broken down into blue, green, red, and alpha components. The HSL type is broken down into luminance, saturation, hue, and alpha components. The Complex type is broken down into real and imaginary components.

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

Line Info is a cluster containing information about the composition of the resulting external data value reference array. All values are in units of array elements and not source Image pixels. For 2-D and 3-D EDVR arrays, the Line Info values apply to the 2nd dimension of the EDVR array. For 1-D EDVR arrays, the Line Info values apply to a single line segment in the EDVR array. A line segment represents a single line of data from the source Image and the EDVR array consists of multiple concatenated line segments. A given line starts with the Left Border elements and is followed in order by the Image Data elements, the Right Border elements, and the Padding elements.

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

Total Width is the number of elements in the external data value reference array that represent a single line of data from the source Image. For 2-D and 3-D EDVR arrays this is equal to the size of the 2nd dimension of the EDVR array. For 1-D EDVR arrays this is the length of a single line segment of the array. Advancing the 1-D EDVR array offset by Total Width will move the offset to the next line. Total Width is equal to the sum of the Left Border, Image Data, Right Border, and Padding values in the Line Info cluster.

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

Left Border is the number of elements in the EDVR array that represent the border on the left side of the image for each line of image data.

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

Image Data is the number of elements in the EDVR array that represent the actual image data within the region specified by the Optional Rectangle input for each line of image data.

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

Right Border is the number of elements in the EDVR array that represent the border on the right side of the image for each line of image data.

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

Padding is the number of elements in the EDVR array that represent the alignment padding at the end of each line of image data.

/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 ImageToEDVR 2D CSG

Returns a 2-D CSG External Data Value Reference (EDVR) array for the requested region of the source image.

Supported Image Types

8-bit unsigned grayscale 16-bit unsigned grayscale 32-bit RGB 16-bit signed grayscale 64-bit RGB floating point grayscale 64-bit complex 32-bit HSL

IMAQ ImageToEDVR 2D CSG

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

Optional Rectangle defines a four-element array that contains the left, top, right, and bottom coordinates of the region to include in the external data value reference array. The right and bottom values are exclusive and lie outside the region. The operation applies to the entire image if the input is empty or not connected.

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

Image is a reference to the source image.

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

Include Border Pixels (F) determines whether to include the border pixels surrounding the region specified by the Optional Rectangle input in the external data value reference array. The default value is FALSE.

The size of the border included in the EDVR array is the same as the size of the border on the source Image. If this input is TRUE, all of the border pixels surrounding the region specified by the Optional Rectangle input are included. If this input is FALSE or unconnected, the border pixels are not included. For 1-D EDVR array types, the left border, right border, and alignment padding pixels are always included regardless of the input value of this control.

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

Step Sizes is a cluster containing information about the X and Y step sizes to apply to the source Image.

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

X Step Size is the vertical sampling step, which defines the columns from the source Image to be included in the external data value reference array (the horizontal reduction ratio). For example, with an X Step Size of 3, one out of every three columns is included from the source Image in the external data value reference array. Each column is included if the default value of 1 is used.

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

Y Step Size is the horizontal sampling step, which defines the lines from the source Image to be included in the external data value reference array (the vertical reduction ratio). For example, with a Y Step Size of 3, one out of every three rows is included from the source Image in the external data value reference array. Each row is included if the default value of 1 is used.

/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/irn.gif

EDVR 2D CSG is an external data value reference array which refers to the requested pixels of the source Image.

This external data value reference must be deleted before the source Image can be resized or completely disposed. Use the Delete Data Value Reference VI on the Memory Control Functions palette to delete the external data value reference. For 1-D array types, the resulting EDVR contains all of the lines concatenated together, starting with the top line and ending with the bottom line. Each line always consists of the left border, image data, right border, and padding pixels. Inspect the Line Info cluster for the width of each segment. For 3-D array types, the 3rd dimension represents the individual components of aggregate pixel types. The RGB type is broken down into blue, green, red, and alpha components. The HSL type is broken down into luminance, saturation, hue, and alpha components. The Complex type is broken down into real and imaginary components.

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

Line Info is a cluster containing information about the composition of the resulting external data value reference array. All values are in units of array elements and not source Image pixels. For 2-D and 3-D EDVR arrays, the Line Info values apply to the 2nd dimension of the EDVR array. For 1-D EDVR arrays, the Line Info values apply to a single line segment in the EDVR array. A line segment represents a single line of data from the source Image and the EDVR array consists of multiple concatenated line segments. A given line starts with the Left Border elements and is followed in order by the Image Data elements, the Right Border elements, and the Padding elements.

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

Total Width is the number of elements in the external data value reference array that represent a single line of data from the source Image. For 2-D and 3-D EDVR arrays this is equal to the size of the 2nd dimension of the EDVR array. For 1-D EDVR arrays this is the length of a single line segment of the array. Advancing the 1-D EDVR array offset by Total Width will move the offset to the next line. Total Width is equal to the sum of the Left Border, Image Data, Right Border, and Padding values in the Line Info cluster.

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

Left Border is the number of elements in the EDVR array that represent the border on the left side of the image for each line of image data.

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

Image Data is the number of elements in the EDVR array that represent the actual image data within the region specified by the Optional Rectangle input for each line of image data.

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

Right Border is the number of elements in the EDVR array that represent the border on the right side of the image for each line of image data.

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

Padding is the number of elements in the EDVR array that represent the alignment padding at the end of each line of image data.

/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 ImageToEDVR 1D U8

Returns a 1-D U8 External Data Value Reference (EDVR) array for the requested region of the source image.

Supported Image Types

8-bit unsigned grayscale 16-bit unsigned grayscale 32-bit RGB 16-bit signed grayscale 64-bit RGB floating point grayscale 64-bit complex 32-bit HSL

IMAQ ImageToEDVR 1D U8

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

Optional Rectangle defines a four-element array that contains the left, top, right, and bottom coordinates of the region to include in the external data value reference array. The right and bottom values are exclusive and lie outside the region. The operation applies to the entire image if the input is empty or not connected.

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

Image is a reference to the source image.

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

Include Border Pixels (F) determines whether to include the border pixels surrounding the region specified by the Optional Rectangle input in the external data value reference array. The default value is FALSE.

The size of the border included in the EDVR array is the same as the size of the border on the source Image. If this input is TRUE, all of the border pixels surrounding the region specified by the Optional Rectangle input are included. If this input is FALSE or unconnected, the border pixels are not included. For 1-D EDVR array types, the left border, right border, and alignment padding pixels are always included regardless of the input value of this control.

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

Step Sizes is a cluster containing information about the X and Y step sizes to apply to the source Image.

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

X Step Size is the vertical sampling step, which defines the columns from the source Image to be included in the external data value reference array (the horizontal reduction ratio). For example, with an X Step Size of 3, one out of every three columns is included from the source Image in the external data value reference array. Each column is included if the default value of 1 is used.

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

Y Step Size is the horizontal sampling step, which defines the lines from the source Image to be included in the external data value reference array (the vertical reduction ratio). For example, with a Y Step Size of 3, one out of every three rows is included from the source Image in the external data value reference array. Each row is included if the default value of 1 is used.

/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/irn.gif

EDVR 1D U8 is an external data value reference array which refers to the requested pixels of the source Image.

This external data value reference must be deleted before the source Image can be resized or completely disposed. Use the Delete Data Value Reference VI on the Memory Control Functions palette to delete the external data value reference. For 1-D array types, the resulting EDVR contains all of the lines concatenated together, starting with the top line and ending with the bottom line. Each line always consists of the left border, image data, right border, and padding pixels. Inspect the Line Info cluster for the width of each segment. For 3-D array types, the 3rd dimension represents the individual components of aggregate pixel types. The RGB type is broken down into blue, green, red, and alpha components. The HSL type is broken down into luminance, saturation, hue, and alpha components. The Complex type is broken down into real and imaginary components.

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

Line Info is a cluster containing information about the composition of the resulting external data value reference array. All values are in units of array elements and not source Image pixels. For 2-D and 3-D EDVR arrays, the Line Info values apply to the 2nd dimension of the EDVR array. For 1-D EDVR arrays, the Line Info values apply to a single line segment in the EDVR array. A line segment represents a single line of data from the source Image and the EDVR array consists of multiple concatenated line segments. A given line starts with the Left Border elements and is followed in order by the Image Data elements, the Right Border elements, and the Padding elements.

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

Total Width is the number of elements in the external data value reference array that represent a single line of data from the source Image. For 2-D and 3-D EDVR arrays this is equal to the size of the 2nd dimension of the EDVR array. For 1-D EDVR arrays this is the length of a single line segment of the array. Advancing the 1-D EDVR array offset by Total Width will move the offset to the next line. Total Width is equal to the sum of the Left Border, Image Data, Right Border, and Padding values in the Line Info cluster.

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

Left Border is the number of elements in the EDVR array that represent the border on the left side of the image for each line of image data.

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

Image Data is the number of elements in the EDVR array that represent the actual image data within the region specified by the Optional Rectangle input for each line of image data.

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

Right Border is the number of elements in the EDVR array that represent the border on the right side of the image for each line of image data.

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

Padding is the number of elements in the EDVR array that represent the alignment padding at the end of each line of image data.

/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 ImageToEDVR 1D I16

Returns a 1-D I16 External Data Value Reference (EDVR) array for the requested region of the source image.

Supported Image Types

8-bit unsigned grayscale 16-bit unsigned grayscale 32-bit RGB 16-bit signed grayscale 64-bit RGB floating point grayscale 64-bit complex 32-bit HSL

IMAQ ImageToEDVR 1D I16

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

Optional Rectangle defines a four-element array that contains the left, top, right, and bottom coordinates of the region to include in the external data value reference array. The right and bottom values are exclusive and lie outside the region. The operation applies to the entire image if the input is empty or not connected.

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

Image is a reference to the source image.

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

Include Border Pixels (F) determines whether to include the border pixels surrounding the region specified by the Optional Rectangle input in the external data value reference array. The default value is FALSE.

The size of the border included in the EDVR array is the same as the size of the border on the source Image. If this input is TRUE, all of the border pixels surrounding the region specified by the Optional Rectangle input are included. If this input is FALSE or unconnected, the border pixels are not included. For 1-D EDVR array types, the left border, right border, and alignment padding pixels are always included regardless of the input value of this control.

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

Step Sizes is a cluster containing information about the X and Y step sizes to apply to the source Image.

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

X Step Size is the vertical sampling step, which defines the columns from the source Image to be included in the external data value reference array (the horizontal reduction ratio). For example, with an X Step Size of 3, one out of every three columns is included from the source Image in the external data value reference array. Each column is included if the default value of 1 is used.

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

Y Step Size is the horizontal sampling step, which defines the lines from the source Image to be included in the external data value reference array (the vertical reduction ratio). For example, with a Y Step Size of 3, one out of every three rows is included from the source Image in the external data value reference array. Each row is included if the default value of 1 is used.

/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/irn.gif

EDVR 1D I16 is an external data value reference array which refers to the requested pixels of the source Image.

This external data value reference must be deleted before the source Image can be resized or completely disposed. Use the Delete Data Value Reference VI on the Memory Control Functions palette to delete the external data value reference. For 1-D array types, the resulting EDVR contains all of the lines concatenated together, starting with the top line and ending with the bottom line. Each line always consists of the left border, image data, right border, and padding pixels. Inspect the Line Info cluster for the width of each segment. For 3-D array types, the 3rd dimension represents the individual components of aggregate pixel types. The RGB type is broken down into blue, green, red, and alpha components. The HSL type is broken down into luminance, saturation, hue, and alpha components. The Complex type is broken down into real and imaginary components.

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

Line Info is a cluster containing information about the composition of the resulting external data value reference array. All values are in units of array elements and not source Image pixels. For 2-D and 3-D EDVR arrays, the Line Info values apply to the 2nd dimension of the EDVR array. For 1-D EDVR arrays, the Line Info values apply to a single line segment in the EDVR array. A line segment represents a single line of data from the source Image and the EDVR array consists of multiple concatenated line segments. A given line starts with the Left Border elements and is followed in order by the Image Data elements, the Right Border elements, and the Padding elements.

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

Total Width is the number of elements in the external data value reference array that represent a single line of data from the source Image. For 2-D and 3-D EDVR arrays this is equal to the size of the 2nd dimension of the EDVR array. For 1-D EDVR arrays this is the length of a single line segment of the array. Advancing the 1-D EDVR array offset by Total Width will move the offset to the next line. Total Width is equal to the sum of the Left Border, Image Data, Right Border, and Padding values in the Line Info cluster.

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

Left Border is the number of elements in the EDVR array that represent the border on the left side of the image for each line of image data.

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

Image Data is the number of elements in the EDVR array that represent the actual image data within the region specified by the Optional Rectangle input for each line of image data.

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

Right Border is the number of elements in the EDVR array that represent the border on the right side of the image for each line of image data.

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

Padding is the number of elements in the EDVR array that represent the alignment padding at the end of each line of image data.

/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 ImageToEDVR 1D U16

Returns a 1-D U16 External Data Value Reference (EDVR) array for the requested region of the source image.

Supported Image Types

8-bit unsigned grayscale 16-bit unsigned grayscale 32-bit RGB 16-bit signed grayscale 64-bit RGB floating point grayscale 64-bit complex 32-bit HSL

IMAQ ImageToEDVR 1D U16

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

Optional Rectangle defines a four-element array that contains the left, top, right, and bottom coordinates of the region to include in the external data value reference array. The right and bottom values are exclusive and lie outside the region. The operation applies to the entire image if the input is empty or not connected.

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

Image is a reference to the source image.

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

Include Border Pixels (F) determines whether to include the border pixels surrounding the region specified by the Optional Rectangle input in the external data value reference array. The default value is FALSE.

The size of the border included in the EDVR array is the same as the size of the border on the source Image. If this input is TRUE, all of the border pixels surrounding the region specified by the Optional Rectangle input are included. If this input is FALSE or unconnected, the border pixels are not included. For 1-D EDVR array types, the left border, right border, and alignment padding pixels are always included regardless of the input value of this control.

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

Step Sizes is a cluster containing information about the X and Y step sizes to apply to the source Image.

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

X Step Size is the vertical sampling step, which defines the columns from the source Image to be included in the external data value reference array (the horizontal reduction ratio). For example, with an X Step Size of 3, one out of every three columns is included from the source Image in the external data value reference array. Each column is included if the default value of 1 is used.

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

Y Step Size is the horizontal sampling step, which defines the lines from the source Image to be included in the external data value reference array (the vertical reduction ratio). For example, with a Y Step Size of 3, one out of every three rows is included from the source Image in the external data value reference array. Each row is included if the default value of 1 is used.

/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/irn.gif

EDVR 1D U16 is an external data value reference array which refers to the requested pixels of the source Image.

This external data value reference must be deleted before the source Image can be resized or completely disposed. Use the Delete Data Value Reference VI on the Memory Control Functions palette to delete the external data value reference. For 1-D array types, the resulting EDVR contains all of the lines concatenated together, starting with the top line and ending with the bottom line. Each line always consists of the left border, image data, right border, and padding pixels. Inspect the Line Info cluster for the width of each segment. For 3-D array types, the 3rd dimension represents the individual components of aggregate pixel types. The RGB type is broken down into blue, green, red, and alpha components. The HSL type is broken down into luminance, saturation, hue, and alpha components. The Complex type is broken down into real and imaginary components.

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

Line Info is a cluster containing information about the composition of the resulting external data value reference array. All values are in units of array elements and not source Image pixels. For 2-D and 3-D EDVR arrays, the Line Info values apply to the 2nd dimension of the EDVR array. For 1-D EDVR arrays, the Line Info values apply to a single line segment in the EDVR array. A line segment represents a single line of data from the source Image and the EDVR array consists of multiple concatenated line segments. A given line starts with the Left Border elements and is followed in order by the Image Data elements, the Right Border elements, and the Padding elements.

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

Total Width is the number of elements in the external data value reference array that represent a single line of data from the source Image. For 2-D and 3-D EDVR arrays this is equal to the size of the 2nd dimension of the EDVR array. For 1-D EDVR arrays this is the length of a single line segment of the array. Advancing the 1-D EDVR array offset by Total Width will move the offset to the next line. Total Width is equal to the sum of the Left Border, Image Data, Right Border, and Padding values in the Line Info cluster.

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

Left Border is the number of elements in the EDVR array that represent the border on the left side of the image for each line of image data.

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

Image Data is the number of elements in the EDVR array that represent the actual image data within the region specified by the Optional Rectangle input for each line of image data.

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

Right Border is the number of elements in the EDVR array that represent the border on the right side of the image for each line of image data.

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

Padding is the number of elements in the EDVR array that represent the alignment padding at the end of each line of image data.

/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 ImageToEDVR 1D U32

Returns a 1-D U32 External Data Value Reference (EDVR) array for the requested region of the source image.

Supported Image Types

8-bit unsigned grayscale 16-bit unsigned grayscale 32-bit RGB 16-bit signed grayscale 64-bit RGB floating point grayscale 64-bit complex 32-bit HSL

IMAQ ImageToEDVR 1D U32

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

Optional Rectangle defines a four-element array that contains the left, top, right, and bottom coordinates of the region to include in the external data value reference array. The right and bottom values are exclusive and lie outside the region. The operation applies to the entire image if the input is empty or not connected.

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

Image is a reference to the source image.

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

Include Border Pixels (F) determines whether to include the border pixels surrounding the region specified by the Optional Rectangle input in the external data value reference array. The default value is FALSE.

The size of the border included in the EDVR array is the same as the size of the border on the source Image. If this input is TRUE, all of the border pixels surrounding the region specified by the Optional Rectangle input are included. If this input is FALSE or unconnected, the border pixels are not included. For 1-D EDVR array types, the left border, right border, and alignment padding pixels are always included regardless of the input value of this control.

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

Step Sizes is a cluster containing information about the X and Y step sizes to apply to the source Image.

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

X Step Size is the vertical sampling step, which defines the columns from the source Image to be included in the external data value reference array (the horizontal reduction ratio). For example, with an X Step Size of 3, one out of every three columns is included from the source Image in the external data value reference array. Each column is included if the default value of 1 is used.

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

Y Step Size is the horizontal sampling step, which defines the lines from the source Image to be included in the external data value reference array (the vertical reduction ratio). For example, with a Y Step Size of 3, one out of every three rows is included from the source Image in the external data value reference array. Each row is included if the default value of 1 is used.

/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/irn.gif

EDVR 1D U32 is an external data value reference array which refers to the requested pixels of the source Image.

This external data value reference must be deleted before the source Image can be resized or completely disposed. Use the Delete Data Value Reference VI on the Memory Control Functions palette to delete the external data value reference. For 1-D array types, the resulting EDVR contains all of the lines concatenated together, starting with the top line and ending with the bottom line. Each line always consists of the left border, image data, right border, and padding pixels. Inspect the Line Info cluster for the width of each segment. For 3-D array types, the 3rd dimension represents the individual components of aggregate pixel types. The RGB type is broken down into blue, green, red, and alpha components. The HSL type is broken down into luminance, saturation, hue, and alpha components. The Complex type is broken down into real and imaginary components.

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

Line Info is a cluster containing information about the composition of the resulting external data value reference array. All values are in units of array elements and not source Image pixels. For 2-D and 3-D EDVR arrays, the Line Info values apply to the 2nd dimension of the EDVR array. For 1-D EDVR arrays, the Line Info values apply to a single line segment in the EDVR array. A line segment represents a single line of data from the source Image and the EDVR array consists of multiple concatenated line segments. A given line starts with the Left Border elements and is followed in order by the Image Data elements, the Right Border elements, and the Padding elements.

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

Total Width is the number of elements in the external data value reference array that represent a single line of data from the source Image. For 2-D and 3-D EDVR arrays this is equal to the size of the 2nd dimension of the EDVR array. For 1-D EDVR arrays this is the length of a single line segment of the array. Advancing the 1-D EDVR array offset by Total Width will move the offset to the next line. Total Width is equal to the sum of the Left Border, Image Data, Right Border, and Padding values in the Line Info cluster.

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

Left Border is the number of elements in the EDVR array that represent the border on the left side of the image for each line of image data.

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

Image Data is the number of elements in the EDVR array that represent the actual image data within the region specified by the Optional Rectangle input for each line of image data.

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

Right Border is the number of elements in the EDVR array that represent the border on the right side of the image for each line of image data.

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

Padding is the number of elements in the EDVR array that represent the alignment padding at the end of each line of image data.

/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 ImageToEDVR 1D SGL

Returns a 1-D SGL External Data Value Reference (EDVR) array for the requested region of the source image.

Supported Image Types

8-bit unsigned grayscale 16-bit unsigned grayscale 32-bit RGB 16-bit signed grayscale 64-bit RGB floating point grayscale 64-bit complex 32-bit HSL

IMAQ ImageToEDVR 1D SGL

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

Optional Rectangle defines a four-element array that contains the left, top, right, and bottom coordinates of the region to include in the external data value reference array. The right and bottom values are exclusive and lie outside the region. The operation applies to the entire image if the input is empty or not connected.

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

Image is a reference to the source image.

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

Include Border Pixels (F) determines whether to include the border pixels surrounding the region specified by the Optional Rectangle input in the external data value reference array. The default value is FALSE.

The size of the border included in the EDVR array is the same as the size of the border on the source Image. If this input is TRUE, all of the border pixels surrounding the region specified by the Optional Rectangle input are included. If this input is FALSE or unconnected, the border pixels are not included. For 1-D EDVR array types, the left border, right border, and alignment padding pixels are always included regardless of the input value of this control.

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

Step Sizes is a cluster containing information about the X and Y step sizes to apply to the source Image.

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

X Step Size is the vertical sampling step, which defines the columns from the source Image to be included in the external data value reference array (the horizontal reduction ratio). For example, with an X Step Size of 3, one out of every three columns is included from the source Image in the external data value reference array. Each column is included if the default value of 1 is used.

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

Y Step Size is the horizontal sampling step, which defines the lines from the source Image to be included in the external data value reference array (the vertical reduction ratio). For example, with a Y Step Size of 3, one out of every three rows is included from the source Image in the external data value reference array. Each row is included if the default value of 1 is used.

/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/irn.gif

EDVR 1D SGL is an external data value reference array which refers to the requested pixels of the source Image.

This external data value reference must be deleted before the source Image can be resized or completely disposed. Use the Delete Data Value Reference VI on the Memory Control Functions palette to delete the external data value reference. For 1-D array types, the resulting EDVR contains all of the lines concatenated together, starting with the top line and ending with the bottom line. Each line always consists of the left border, image data, right border, and padding pixels. Inspect the Line Info cluster for the width of each segment. For 3-D array types, the 3rd dimension represents the individual components of aggregate pixel types. The RGB type is broken down into blue, green, red, and alpha components. The HSL type is broken down into luminance, saturation, hue, and alpha components. The Complex type is broken down into real and imaginary components.

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

Line Info is a cluster containing information about the composition of the resulting external data value reference array. All values are in units of array elements and not source Image pixels. For 2-D and 3-D EDVR arrays, the Line Info values apply to the 2nd dimension of the EDVR array. For 1-D EDVR arrays, the Line Info values apply to a single line segment in the EDVR array. A line segment represents a single line of data from the source Image and the EDVR array consists of multiple concatenated line segments. A given line starts with the Left Border elements and is followed in order by the Image Data elements, the Right Border elements, and the Padding elements.

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

Total Width is the number of elements in the external data value reference array that represent a single line of data from the source Image. For 2-D and 3-D EDVR arrays this is equal to the size of the 2nd dimension of the EDVR array. For 1-D EDVR arrays this is the length of a single line segment of the array. Advancing the 1-D EDVR array offset by Total Width will move the offset to the next line. Total Width is equal to the sum of the Left Border, Image Data, Right Border, and Padding values in the Line Info cluster.

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

Left Border is the number of elements in the EDVR array that represent the border on the left side of the image for each line of image data.

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

Image Data is the number of elements in the EDVR array that represent the actual image data within the region specified by the Optional Rectangle input for each line of image data.

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

Right Border is the number of elements in the EDVR array that represent the border on the right side of the image for each line of image data.

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

Padding is the number of elements in the EDVR array that represent the alignment padding at the end of each line of image data.

/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 ImageToEDVR 1D U64

Returns a 1-D U64 External Data Value Reference (EDVR) array for the requested region of the source image.

Supported Image Types

8-bit unsigned grayscale 16-bit unsigned grayscale 32-bit RGB 16-bit signed grayscale 64-bit RGB floating point grayscale 64-bit complex 32-bit HSL

IMAQ ImageToEDVR 1D U64

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

Optional Rectangle defines a four-element array that contains the left, top, right, and bottom coordinates of the region to include in the external data value reference array. The right and bottom values are exclusive and lie outside the region. The operation applies to the entire image if the input is empty or not connected.

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

Image is a reference to the source image.

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

Include Border Pixels (F) determines whether to include the border pixels surrounding the region specified by the Optional Rectangle input in the external data value reference array. The default value is FALSE.

The size of the border included in the EDVR array is the same as the size of the border on the source Image. If this input is TRUE, all of the border pixels surrounding the region specified by the Optional Rectangle input are included. If this input is FALSE or unconnected, the border pixels are not included. For 1-D EDVR array types, the left border, right border, and alignment padding pixels are always included regardless of the input value of this control.

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

Step Sizes is a cluster containing information about the X and Y step sizes to apply to the source Image.

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

X Step Size is the vertical sampling step, which defines the columns from the source Image to be included in the external data value reference array (the horizontal reduction ratio). For example, with an X Step Size of 3, one out of every three columns is included from the source Image in the external data value reference array. Each column is included if the default value of 1 is used.

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

Y Step Size is the horizontal sampling step, which defines the lines from the source Image to be included in the external data value reference array (the vertical reduction ratio). For example, with a Y Step Size of 3, one out of every three rows is included from the source Image in the external data value reference array. Each row is included if the default value of 1 is used.

/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/irn.gif

EDVR 1D U64 is an external data value reference array which refers to the requested pixels of the source Image.

This external data value reference must be deleted before the source Image can be resized or completely disposed. Use the Delete Data Value Reference VI on the Memory Control Functions palette to delete the external data value reference. For 1-D array types, the resulting EDVR contains all of the lines concatenated together, starting with the top line and ending with the bottom line. Each line always consists of the left border, image data, right border, and padding pixels. Inspect the Line Info cluster for the width of each segment. For 3-D array types, the 3rd dimension represents the individual components of aggregate pixel types. The RGB type is broken down into blue, green, red, and alpha components. The HSL type is broken down into luminance, saturation, hue, and alpha components. The Complex type is broken down into real and imaginary components.

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

Line Info is a cluster containing information about the composition of the resulting external data value reference array. All values are in units of array elements and not source Image pixels. For 2-D and 3-D EDVR arrays, the Line Info values apply to the 2nd dimension of the EDVR array. For 1-D EDVR arrays, the Line Info values apply to a single line segment in the EDVR array. A line segment represents a single line of data from the source Image and the EDVR array consists of multiple concatenated line segments. A given line starts with the Left Border elements and is followed in order by the Image Data elements, the Right Border elements, and the Padding elements.

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

Total Width is the number of elements in the external data value reference array that represent a single line of data from the source Image. For 2-D and 3-D EDVR arrays this is equal to the size of the 2nd dimension of the EDVR array. For 1-D EDVR arrays this is the length of a single line segment of the array. Advancing the 1-D EDVR array offset by Total Width will move the offset to the next line. Total Width is equal to the sum of the Left Border, Image Data, Right Border, and Padding values in the Line Info cluster.

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

Left Border is the number of elements in the EDVR array that represent the border on the left side of the image for each line of image data.

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

Image Data is the number of elements in the EDVR array that represent the actual image data within the region specified by the Optional Rectangle input for each line of image data.

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

Right Border is the number of elements in the EDVR array that represent the border on the right side of the image for each line of image data.

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

Padding is the number of elements in the EDVR array that represent the alignment padding at the end of each line of image data.

/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 ImageToEDVR 1D CSG

Returns a 1-D CSG External Data Value Reference (EDVR) array for the requested region of the source image.

Supported Image Types

8-bit unsigned grayscale 16-bit unsigned grayscale 32-bit RGB 16-bit signed grayscale 64-bit RGB floating point grayscale 64-bit complex 32-bit HSL

IMAQ ImageToEDVR 1D CSG

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

Optional Rectangle defines a four-element array that contains the left, top, right, and bottom coordinates of the region to include in the external data value reference array. The right and bottom values are exclusive and lie outside the region. The operation applies to the entire image if the input is empty or not connected.

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

Image is a reference to the source image.

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

Include Border Pixels (F) determines whether to include the border pixels surrounding the region specified by the Optional Rectangle input in the external data value reference array. The default value is FALSE.

The size of the border included in the EDVR array is the same as the size of the border on the source Image. If this input is TRUE, all of the border pixels surrounding the region specified by the Optional Rectangle input are included. If this input is FALSE or unconnected, the border pixels are not included. For 1-D EDVR array types, the left border, right border, and alignment padding pixels are always included regardless of the input value of this control.

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

Step Sizes is a cluster containing information about the X and Y step sizes to apply to the source Image.

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

X Step Size is the vertical sampling step, which defines the columns from the source Image to be included in the external data value reference array (the horizontal reduction ratio). For example, with an X Step Size of 3, one out of every three columns is included from the source Image in the external data value reference array. Each column is included if the default value of 1 is used.

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

Y Step Size is the horizontal sampling step, which defines the lines from the source Image to be included in the external data value reference array (the vertical reduction ratio). For example, with a Y Step Size of 3, one out of every three rows is included from the source Image in the external data value reference array. Each row is included if the default value of 1 is used.

/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/irn.gif

EDVR 1D CSG is an external data value reference array which refers to the requested pixels of the source Image.

This external data value reference must be deleted before the source Image can be resized or completely disposed. Use the Delete Data Value Reference VI on the Memory Control Functions palette to delete the external data value reference. For 1-D array types, the resulting EDVR contains all of the lines concatenated together, starting with the top line and ending with the bottom line. Each line always consists of the left border, image data, right border, and padding pixels. Inspect the Line Info cluster for the width of each segment. For 3-D array types, the 3rd dimension represents the individual components of aggregate pixel types. The RGB type is broken down into blue, green, red, and alpha components. The HSL type is broken down into luminance, saturation, hue, and alpha components. The Complex type is broken down into real and imaginary components.

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

Line Info is a cluster containing information about the composition of the resulting external data value reference array. All values are in units of array elements and not source Image pixels. For 2-D and 3-D EDVR arrays, the Line Info values apply to the 2nd dimension of the EDVR array. For 1-D EDVR arrays, the Line Info values apply to a single line segment in the EDVR array. A line segment represents a single line of data from the source Image and the EDVR array consists of multiple concatenated line segments. A given line starts with the Left Border elements and is followed in order by the Image Data elements, the Right Border elements, and the Padding elements.

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

Total Width is the number of elements in the external data value reference array that represent a single line of data from the source Image. For 2-D and 3-D EDVR arrays this is equal to the size of the 2nd dimension of the EDVR array. For 1-D EDVR arrays this is the length of a single line segment of the array. Advancing the 1-D EDVR array offset by Total Width will move the offset to the next line. Total Width is equal to the sum of the Left Border, Image Data, Right Border, and Padding values in the Line Info cluster.

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

Left Border is the number of elements in the EDVR array that represent the border on the left side of the image for each line of image data.

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

Image Data is the number of elements in the EDVR array that represent the actual image data within the region specified by the Optional Rectangle input for each line of image data.

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

Right Border is the number of elements in the EDVR array that represent the border on the right side of the image for each line of image data.

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

Padding is the number of elements in the EDVR array that represent the alignment padding at the end of each line of image data.

/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 ImageToEDVR 3D U8

Returns a 3-D U8 External Data Value Reference (EDVR) array for the requested region of the source image.

Supported Image Types

8-bit unsigned grayscale 16-bit unsigned grayscale 32-bit RGB 16-bit signed grayscale 64-bit RGB floating point grayscale 64-bit complex 32-bit HSL

IMAQ ImageToEDVR 3D U8

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

Optional Rectangle defines a four-element array that contains the left, top, right, and bottom coordinates of the region to include in the external data value reference array. The right and bottom values are exclusive and lie outside the region. The operation applies to the entire image if the input is empty or not connected.

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

Image is a reference to the source image.

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

Include Border Pixels (F) determines whether to include the border pixels surrounding the region specified by the Optional Rectangle input in the external data value reference array. The default value is FALSE.

The size of the border included in the EDVR array is the same as the size of the border on the source Image. If this input is TRUE, all of the border pixels surrounding the region specified by the Optional Rectangle input are included. If this input is FALSE or unconnected, the border pixels are not included. For 1-D EDVR array types, the left border, right border, and alignment padding pixels are always included regardless of the input value of this control.

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

Step Sizes is a cluster containing information about the X and Y step sizes to apply to the source Image.

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

X Step Size is the vertical sampling step, which defines the columns from the source Image to be included in the external data value reference array (the horizontal reduction ratio). For example, with an X Step Size of 3, one out of every three columns is included from the source Image in the external data value reference array. Each column is included if the default value of 1 is used.

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

Y Step Size is the horizontal sampling step, which defines the lines from the source Image to be included in the external data value reference array (the vertical reduction ratio). For example, with a Y Step Size of 3, one out of every three rows is included from the source Image in the external data value reference array. Each row is included if the default value of 1 is used.

/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/irn.gif

EDVR 3D U8 is an external data value reference array which refers to the requested pixels of the source Image.

This external data value reference must be deleted before the source Image can be resized or completely disposed. Use the Delete Data Value Reference VI on the Memory Control Functions palette to delete the external data value reference. For 1-D array types, the resulting EDVR contains all of the lines concatenated together, starting with the top line and ending with the bottom line. Each line always consists of the left border, image data, right border, and padding pixels. Inspect the Line Info cluster for the width of each segment. For 3-D array types, the 3rd dimension represents the individual components of aggregate pixel types. The RGB type is broken down into blue, green, red, and alpha components. The HSL type is broken down into luminance, saturation, hue, and alpha components. The Complex type is broken down into real and imaginary components.

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

Line Info is a cluster containing information about the composition of the resulting external data value reference array. All values are in units of array elements and not source Image pixels. For 2-D and 3-D EDVR arrays, the Line Info values apply to the 2nd dimension of the EDVR array. For 1-D EDVR arrays, the Line Info values apply to a single line segment in the EDVR array. A line segment represents a single line of data from the source Image and the EDVR array consists of multiple concatenated line segments. A given line starts with the Left Border elements and is followed in order by the Image Data elements, the Right Border elements, and the Padding elements.

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

Total Width is the number of elements in the external data value reference array that represent a single line of data from the source Image. For 2-D and 3-D EDVR arrays this is equal to the size of the 2nd dimension of the EDVR array. For 1-D EDVR arrays this is the length of a single line segment of the array. Advancing the 1-D EDVR array offset by Total Width will move the offset to the next line. Total Width is equal to the sum of the Left Border, Image Data, Right Border, and Padding values in the Line Info cluster.

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

Left Border is the number of elements in the EDVR array that represent the border on the left side of the image for each line of image data.

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

Image Data is the number of elements in the EDVR array that represent the actual image data within the region specified by the Optional Rectangle input for each line of image data.

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

Right Border is the number of elements in the EDVR array that represent the border on the right side of the image for each line of image data.

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

Padding is the number of elements in the EDVR array that represent the alignment padding at the end of each line of image data.

/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 ImageToEDVR 3D I16

Returns a 3-D I16 External Data Value Reference (EDVR) array for the requested region of the source image.

Supported Image Types

8-bit unsigned grayscale 16-bit unsigned grayscale 32-bit RGB 16-bit signed grayscale 64-bit RGB floating point grayscale 64-bit complex 32-bit HSL

IMAQ ImageToEDVR 3D I16

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

Optional Rectangle defines a four-element array that contains the left, top, right, and bottom coordinates of the region to include in the external data value reference array. The right and bottom values are exclusive and lie outside the region. The operation applies to the entire image if the input is empty or not connected.

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

Image is a reference to the source image.

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

Include Border Pixels (F) determines whether to include the border pixels surrounding the region specified by the Optional Rectangle input in the external data value reference array. The default value is FALSE.

The size of the border included in the EDVR array is the same as the size of the border on the source Image. If this input is TRUE, all of the border pixels surrounding the region specified by the Optional Rectangle input are included. If this input is FALSE or unconnected, the border pixels are not included. For 1-D EDVR array types, the left border, right border, and alignment padding pixels are always included regardless of the input value of this control.

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

Step Sizes is a cluster containing information about the X and Y step sizes to apply to the source Image.

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

X Step Size is the vertical sampling step, which defines the columns from the source Image to be included in the external data value reference array (the horizontal reduction ratio). For example, with an X Step Size of 3, one out of every three columns is included from the source Image in the external data value reference array. Each column is included if the default value of 1 is used.

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

Y Step Size is the horizontal sampling step, which defines the lines from the source Image to be included in the external data value reference array (the vertical reduction ratio). For example, with a Y Step Size of 3, one out of every three rows is included from the source Image in the external data value reference array. Each row is included if the default value of 1 is used.

/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/irn.gif

EDVR 3D I16 is an external data value reference array which refers to the requested pixels of the source Image.

This external data value reference must be deleted before the source Image can be resized or completely disposed. Use the Delete Data Value Reference VI on the Memory Control Functions palette to delete the external data value reference. For 1-D array types, the resulting EDVR contains all of the lines concatenated together, starting with the top line and ending with the bottom line. Each line always consists of the left border, image data, right border, and padding pixels. Inspect the Line Info cluster for the width of each segment. For 3-D array types, the 3rd dimension represents the individual components of aggregate pixel types. The RGB type is broken down into blue, green, red, and alpha components. The HSL type is broken down into luminance, saturation, hue, and alpha components. The Complex type is broken down into real and imaginary components.

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

Line Info is a cluster containing information about the composition of the resulting external data value reference array. All values are in units of array elements and not source Image pixels. For 2-D and 3-D EDVR arrays, the Line Info values apply to the 2nd dimension of the EDVR array. For 1-D EDVR arrays, the Line Info values apply to a single line segment in the EDVR array. A line segment represents a single line of data from the source Image and the EDVR array consists of multiple concatenated line segments. A given line starts with the Left Border elements and is followed in order by the Image Data elements, the Right Border elements, and the Padding elements.

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

Total Width is the number of elements in the external data value reference array that represent a single line of data from the source Image. For 2-D and 3-D EDVR arrays this is equal to the size of the 2nd dimension of the EDVR array. For 1-D EDVR arrays this is the length of a single line segment of the array. Advancing the 1-D EDVR array offset by Total Width will move the offset to the next line. Total Width is equal to the sum of the Left Border, Image Data, Right Border, and Padding values in the Line Info cluster.

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

Left Border is the number of elements in the EDVR array that represent the border on the left side of the image for each line of image data.

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

Image Data is the number of elements in the EDVR array that represent the actual image data within the region specified by the Optional Rectangle input for each line of image data.

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

Right Border is the number of elements in the EDVR array that represent the border on the right side of the image for each line of image data.

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

Padding is the number of elements in the EDVR array that represent the alignment padding at the end of each line of image data.

/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 ImageToEDVR 3D U16

Returns a 3-D U16 External Data Value Reference (EDVR) array for the requested region of the source image.

Supported Image Types

8-bit unsigned grayscale 16-bit unsigned grayscale 32-bit RGB 16-bit signed grayscale 64-bit RGB floating point grayscale 64-bit complex 32-bit HSL

IMAQ ImageToEDVR 3D U16

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

Optional Rectangle defines a four-element array that contains the left, top, right, and bottom coordinates of the region to include in the external data value reference array. The right and bottom values are exclusive and lie outside the region. The operation applies to the entire image if the input is empty or not connected.

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

Image is a reference to the source image.

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

Include Border Pixels (F) determines whether to include the border pixels surrounding the region specified by the Optional Rectangle input in the external data value reference array. The default value is FALSE.

The size of the border included in the EDVR array is the same as the size of the border on the source Image. If this input is TRUE, all of the border pixels surrounding the region specified by the Optional Rectangle input are included. If this input is FALSE or unconnected, the border pixels are not included. For 1-D EDVR array types, the left border, right border, and alignment padding pixels are always included regardless of the input value of this control.

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

Step Sizes is a cluster containing information about the X and Y step sizes to apply to the source Image.

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

X Step Size is the vertical sampling step, which defines the columns from the source Image to be included in the external data value reference array (the horizontal reduction ratio). For example, with an X Step Size of 3, one out of every three columns is included from the source Image in the external data value reference array. Each column is included if the default value of 1 is used.

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

Y Step Size is the horizontal sampling step, which defines the lines from the source Image to be included in the external data value reference array (the vertical reduction ratio). For example, with a Y Step Size of 3, one out of every three rows is included from the source Image in the external data value reference array. Each row is included if the default value of 1 is used.

/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/irn.gif

EDVR 3D U16 is an external data value reference array which refers to the requested pixels of the source Image.

This external data value reference must be deleted before the source Image can be resized or completely disposed. Use the Delete Data Value Reference VI on the Memory Control Functions palette to delete the external data value reference. For 1-D array types, the resulting EDVR contains all of the lines concatenated together, starting with the top line and ending with the bottom line. Each line always consists of the left border, image data, right border, and padding pixels. Inspect the Line Info cluster for the width of each segment. For 3-D array types, the 3rd dimension represents the individual components of aggregate pixel types. The RGB type is broken down into blue, green, red, and alpha components. The HSL type is broken down into luminance, saturation, hue, and alpha components. The Complex type is broken down into real and imaginary components.

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

Line Info is a cluster containing information about the composition of the resulting external data value reference array. All values are in units of array elements and not source Image pixels. For 2-D and 3-D EDVR arrays, the Line Info values apply to the 2nd dimension of the EDVR array. For 1-D EDVR arrays, the Line Info values apply to a single line segment in the EDVR array. A line segment represents a single line of data from the source Image and the EDVR array consists of multiple concatenated line segments. A given line starts with the Left Border elements and is followed in order by the Image Data elements, the Right Border elements, and the Padding elements.

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

Total Width is the number of elements in the external data value reference array that represent a single line of data from the source Image. For 2-D and 3-D EDVR arrays this is equal to the size of the 2nd dimension of the EDVR array. For 1-D EDVR arrays this is the length of a single line segment of the array. Advancing the 1-D EDVR array offset by Total Width will move the offset to the next line. Total Width is equal to the sum of the Left Border, Image Data, Right Border, and Padding values in the Line Info cluster.

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

Left Border is the number of elements in the EDVR array that represent the border on the left side of the image for each line of image data.

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

Image Data is the number of elements in the EDVR array that represent the actual image data within the region specified by the Optional Rectangle input for each line of image data.

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

Right Border is the number of elements in the EDVR array that represent the border on the right side of the image for each line of image data.

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

Padding is the number of elements in the EDVR array that represent the alignment padding at the end of each line of image data.

/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 ImageToEDVR 3D SGL

Returns a 3-D SGL External Data Value Reference (EDVR) array for the requested region of the source image.

Supported Image Types

8-bit unsigned grayscale 16-bit unsigned grayscale 32-bit RGB 16-bit signed grayscale 64-bit RGB floating point grayscale 64-bit complex 32-bit HSL

IMAQ ImageToEDVR 3D SGL

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

Optional Rectangle defines a four-element array that contains the left, top, right, and bottom coordinates of the region to include in the external data value reference array. The right and bottom values are exclusive and lie outside the region. The operation applies to the entire image if the input is empty or not connected.

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

Image is a reference to the source image.

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

Include Border Pixels (F) determines whether to include the border pixels surrounding the region specified by the Optional Rectangle input in the external data value reference array. The default value is FALSE.

The size of the border included in the EDVR array is the same as the size of the border on the source Image. If this input is TRUE, all of the border pixels surrounding the region specified by the Optional Rectangle input are included. If this input is FALSE or unconnected, the border pixels are not included. For 1-D EDVR array types, the left border, right border, and alignment padding pixels are always included regardless of the input value of this control.

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

Step Sizes is a cluster containing information about the X and Y step sizes to apply to the source Image.

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

X Step Size is the vertical sampling step, which defines the columns from the source Image to be included in the external data value reference array (the horizontal reduction ratio). For example, with an X Step Size of 3, one out of every three columns is included from the source Image in the external data value reference array. Each column is included if the default value of 1 is used.

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

Y Step Size is the horizontal sampling step, which defines the lines from the source Image to be included in the external data value reference array (the vertical reduction ratio). For example, with a Y Step Size of 3, one out of every three rows is included from the source Image in the external data value reference array. Each row is included if the default value of 1 is used.

/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/irn.gif

EDVR 3D SGL is an external data value reference array which refers to the requested pixels of the source Image.

This external data value reference must be deleted before the source Image can be resized or completely disposed. Use the Delete Data Value Reference VI on the Memory Control Functions palette to delete the external data value reference. For 1-D array types, the resulting EDVR contains all of the lines concatenated together, starting with the top line and ending with the bottom line. Each line always consists of the left border, image data, right border, and padding pixels. Inspect the Line Info cluster for the width of each segment. For 3-D array types, the 3rd dimension represents the individual components of aggregate pixel types. The RGB type is broken down into blue, green, red, and alpha components. The HSL type is broken down into luminance, saturation, hue, and alpha components. The Complex type is broken down into real and imaginary components.

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

Line Info is a cluster containing information about the composition of the resulting external data value reference array. All values are in units of array elements and not source Image pixels. For 2-D and 3-D EDVR arrays, the Line Info values apply to the 2nd dimension of the EDVR array. For 1-D EDVR arrays, the Line Info values apply to a single line segment in the EDVR array. A line segment represents a single line of data from the source Image and the EDVR array consists of multiple concatenated line segments. A given line starts with the Left Border elements and is followed in order by the Image Data elements, the Right Border elements, and the Padding elements.

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

Total Width is the number of elements in the external data value reference array that represent a single line of data from the source Image. For 2-D and 3-D EDVR arrays this is equal to the size of the 2nd dimension of the EDVR array. For 1-D EDVR arrays this is the length of a single line segment of the array. Advancing the 1-D EDVR array offset by Total Width will move the offset to the next line. Total Width is equal to the sum of the Left Border, Image Data, Right Border, and Padding values in the Line Info cluster.

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

Left Border is the number of elements in the EDVR array that represent the border on the left side of the image for each line of image data.

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

Image Data is the number of elements in the EDVR array that represent the actual image data within the region specified by the Optional Rectangle input for each line of image data.

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

Right Border is the number of elements in the EDVR array that represent the border on the right side of the image for each line of image data.

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

Padding is the number of elements in the EDVR array that represent the alignment padding at the end of each line of image data.

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

Examples

Refer to the following for an example that uses this VI.

  • LabVIEW\examples\Vision\Image Management\Image To EDVR.vi

WAS THIS ARTICLE HELPFUL?

Not Helpful