High-Level Functions
High-level functions are divided into the following types:
- Snap functions—Capture all or a portion of a single frame or field to the user buffer.
- Grab functions—Perform a continuous acquisition of data to a single buffer.
- Ring and Sequence functions—Start and stop a continuous acquisition of multiple fields or frames.
- Signal I/O functions—Control the trigger lines on image acquisition devices.
- Miscellaneous functions—Set and get the acquisition window region of interest and return information such as session status and buffer sizes.
Snap Functions |
|
| imgSnap | Performs a single frame or field acquisition. |
| imgSnapArea | Performs an area-specific frame or field acquisition. |
Grab Functions | |
| imgGrabSetup | Configures and optionally starts a continuous acquisition. |
| imgGrab | Acquires the most current frame into the specified buffer. Call this function only after calling imgGrabSetup. |
| imgGrabArea | Performs a transfer from a continuous acquisition using the given parameters. Call this function only after calling imgGrabSetup. |
Ring and Sequence Functions | |
| imgRingSetup | Prepares a session for acquiring continuously and looping into a buffer list. |
| imgSequenceSetup | Prepares a session for acquiring a sequence into a buffer list. |
| imgSessionStartAcquisition | Starts an acquisition. |
| imgSessionStopAcquisition | Stops an acquisition. |
Signal I/O Functions | |
| imgSessionTriggerConfigure2 | Configures an acquisition to start based on an external trigger. |
| imgSessionLineTrigSource2 | Configures triggering per line for acquisition from a line scan camera. |
| imgSessionTriggerClear | Disables all triggers on the session. |
| imgSessionTriggerDrive2 | Configures the specified trigger line to drive a signal out. |
| imgSessionTriggerRead2 | Reads the current value of the specified trigger line. |
| imgSessionTriggerRoute2 | Drives the destination trigger line with the signal on the source trigger line. |
| imgSessionWaitSignal2 | Waits for a signal to be asserted. This function returns when the specified signal is asserted. |
| imgSessionWaitSignalAsync2 | Monitors for a signal to be asserted and invokes a user-defined callback when the signal is asserted. |
| imgEncoderResetPosition | Resets the absolute encoder position counter to 0. |
| imgPulseCreate2 | Configures the attributes of a pulse. A single pulse consists of a delay phase (phase 1), followed by a pulse phase (phase 2), and then a return to the original level. |
| imgPulseDispose | Disposes of a pulse ID. |
| imgPulseRate | Converts delay and width into delay, width, and timebase values needed by imgPulseCreate. |
| imgPulseStart | Starts the generation of a pulse. You must call imgPulseCreate first to configure the pulse. |
| imgPulseStop | Stops the generation of a pulse. |
Miscellaneous Functions | |
| imgSessionStatus | Gets the current session status. |
| imgSessionSetROI | Sets the acquisition region of interest. |
| imgSessionGetROI | Gets the acquisition region of interest. |
| imgSessionGetBufferSize | Gets the minimum buffer size needed for frame buffer allocation. |