Table Of Contents

IMAQdx Extract Image (G Dataflow)

Last Modified: March 25, 2019

Retrieves an acquired image directly from the circular buffer list, and does not make a copy of the image.

This node is valid only within the context of a ring acquisition. The driver cannot acquire a new image into an image that is being extracted. To allow the acquisition to proceed, release the image by calling the IMAQdx Release Image node or by calling the IMAQdx Extract Image node with the Release Previous control set to TRUE.

connector_pane_image
datatype_icon

session in

Unique reference to the camera, which you can obtain with the IMAQdx Initialize node.

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

buffer mode

Number of buffer mode. Default value is Next, which specifies that the driver waits for the next acquired buffer.

Other possible values are Last, Buffer Number, Every, and Last New. Last specifies that the driver does not wait for the next buffer but instead returns the last acquired buffer. Buffer Number specifies an exact buffer number to wait for. Every returns all sequential images in memory. Last New returns the last acquired buffer if the buffer has not been returned before, to avoid returning duplicate images. Use buffer number mode in conjunction with buffer number in.

datatype_icon

buffer number in

Cumulative image number to get.

datatype_icon

timeout

Time, in milliseconds, to wait for the requested buffer to become available. A value of -1 indicates to wait indefinitely. A value of -2 indicates to use the value of the Timeout attribute in place of this parameter.

datatype_icon

release previous

Boolean that specifies whether to release any previously extracted images before extracting the requested buffer.

datatype_icon

session out

Unique reference to the camera. session out is the same as session in.

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

image out

Reference to the captured image.

datatype_icon

buffer number out

Actual acquired buffer number returned.

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