Table Of Contents

Image to EDVR (1D Array » Image to EDVR (1D I16)) (G Dataflow)

Last Modified: October 25, 2017

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

connector_pane_image
datatype_icon

image in

Reference to the source image.

datatype_icon

optional rectangle

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.

datatype_icon

include border pixels

Boolean value that determines whether to include the border pixels surrounding the region specified by the optional rectangle input in the external data value reference array.

The size of the border included in the EDVR array is the same as the size of the border on the source Image. 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.

True Border pixels surrounding the region are included in the external data value reference array.
False Border pixels surrounding the region are not included in the external data value reference array.

Default: False

datatype_icon

step sizes

Cluster containing information about the X and Y step sizes to apply to the source image.

datatype_icon

X Step Size

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

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.

Default: 1

datatype_icon

Y Step Size

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

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.

Default: 1

datatype_icon

error in

Error conditions that occur before this node runs.

The node responds to this input according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Default: No error

datatype_icon

image out

Reference to the image input.

datatype_icon

edvr 1D I16

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

datatype_icon

line information

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 information values apply to the 2nd dimension of the EDVR array. For 1-D EDVR arrays, the line information 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.

datatype_icon

Total Width

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

datatype_icon

Left Border

Number of elements in the EDVR array that represent the border on the left side of the image for each line of image data.

datatype_icon

Image Data

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.

datatype_icon

Right Border

Number of elements in the EDVR array that represent the border on the right side of the image for each line of image data.

datatype_icon

Padding

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

datatype_icon

error out

Error information.

The node produces this output according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Where This Node Can Run:

Desktop OS: Windows

FPGA: Not supported

Web Server: Not supported in VIs that run in a web application


Recently Viewed Topics