An acquisition fifo.
Namespace: Cognex.VisionProAssembly: Cognex.VisionPro.Core (in Cognex.VisionPro.Core.dll) Version: 69.0.0.0
Syntax
The ICogAcqFifo type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
| Acquire | Acquire a new image. | |
| AcquiredPixelFormat | The pixel format of the image as the camera acquires them. | |
| AcquireVisionData | Acquire an object that can hold one of the following types: an image, a point cloud or a vision data container. | |
| CompleteAcquire | Completes the acquisition specified by the given ticket and returns the acquired image. If the ticket is omitted, or set to -1, the uncompleted acquire that was least recently started will be completed. | |
| CompleteAcquireEx | Completes the acquisition specified by the requested ticket and returns the acquired image. This method is the same as CompleteAcquire(Int32, Int32 , Int32 ) but passes and returns its results in an ICogAcqInfo. | |
| CompleteAcquireVisionDataEx | Returns an ICogVisionData that can hold one of the following types: an image, a point cloud or a vision data container. | |
| Connect | Cognex Internal use only. | |
| CreateEventSink | Create an object in the event thread of this fifo. This allows single-threaded objects to sink acquisition events efficiently. | |
| Flush | Flush all outstanding queued acquisitions. | |
| GetFifoState | Returns the instantaneous state of the fifo. | |
| GetInternal | Cognex Internal use only. | |
| Prepare | Prepare the fifo so it is ready to start taking triggers immediately. | |
| ResumeAndRaiseChangedEvent |
Re-enables raising of the Changed event after SuspendChangedEvent
has been called, and raises the Changed event if the
ChangedEventSuspended count is reduced to zero and any changes were
made while events were suspended. Must be called once for each call to
SuspendChangedEvent.
(Inherited from ICogChangedEvent.) | |
| SetInternal | Cognex Internal use only. | |
| StartAcquire | Start a new acquisition. The returned value is a ticket that may be handed to CompleteAcquire. | |
| SuspendChangedEvent |
Temporarily suspends the raising of the Changed event. May be called
more than once, and a corresponding call to ResumeAndRaiseChangedEvent
must be made for each call to SuspendChangedEvent.
(Inherited from ICogChangedEvent.) |
Properties
| Name | Description | |
|---|---|---|
| AutoPrepareEnabled | Whether a fifo is automatically prepared after a property is changed. Default is true. | |
| CameraPort | Camera port number which this fifo is attached to. | |
| ChangedEventSuspended |
Indicates if the raising of the Changed event has been suspended.
(Inherited from ICogChangedEvent.) | |
| CoordinateSpaceTree | Reads or sets a custom space tree that will be copied into all images acquired from this acquisition fifo. The tree provides advanced functions for managing coordinate spaces. | |
| FrameGrabber | Frame grabber associated with this acquisition fifo. | |
| NumCameraPorts | Number of physical camera ports available for this acquisition fifo. | |
| OutputPixelFormat | The desired pixel format for images acquired with this fifo. A conversion will be performed if different from AcquiredPixelFormat. | |
| Owned1394DCAMParams | Gets a ICogAcq1394DCAM interface for a FIFO if one exists. | |
| OwnedBrightnessMultiChannelParams | Gets a ICogAcqBrightnessMultiChannel interface for a FIFO if one exists. | |
| OwnedBrightnessParams | Gets a ICogAcqBrightness interface for a FIFO if one exists. | |
| OwnedCameraCalibrationParams | Gets a ICogAcqCameraCalibration interface for a FIFO if one exists. | |
| OwnedChargeTransferIntervalParams | Gets a ICogAcqChargeTransferInterval interface for a FIFO if one exists. | |
| OwnedContrastMultiChannelParams | Gets a ICogAcqContrastMultiChannel interface for a FIFO if one exists. | |
| OwnedContrastParams | Gets a ICogAcqContrast interface for a FIFO if one exists. | |
| OwnedCustomPropertiesParams | Gets a ICogAcqCustomProperties interface for a FIFO if one exists. | |
| OwnedDigitalCameraGainParams | Gets a ICogAcqDigitalCameraGain interface for a FIFO if one exists. | |
| OwnedExposureParams | Gets a ICogAcqExposure interface for a FIFO if one exists. | |
| OwnedFieldCalibrationParams | Gets a ICogAcqFieldCalibration interface for a FIFO if one exists. | |
| OwnedGenTLBuffersParams | Gets a ICogAcqGenTLBuffers interface for a FIFO if one exists. | |
| OwnedGigEVisionTransportParams | Gets a ICogAcqGigEVisionTransport interface for a FIFO if one exists. | |
| OwnedHardwareImagePoolParams | Gets a ICogAcqHardwareImagePool interface for a FIFO if one exists. | |
| OwnedHorizontalAdjustmentParams | Gets a ICogAcqHorizontalAdjustment interface for a FIFO if one exists. | |
| OwnedLightParams | Gets a ICogAcqLight interface for a FIFO if one exists. | |
| OwnedLineScanParams | Gets a ICogAcqLineScan interface for a FIFO if one exists. | |
| OwnedLookupTableParams | Gets a ICogAcqLookupTable interface for a FIFO if one exists. | |
| OwnedMasterClockFrequencyParams | Gets a ICogAcqMasterClockFrequency interface for a FIFO if one exists. | |
| OwnedOffsetClampParams | Gets a ICogAcqOffsetClamp interface for a FIFO if one exists. | |
| OwnedProfileCameraParams | Gets a ICogAcqProfileCamera interface for a FIFO if one exists. | |
| OwnedRangeImageParams | Gets a ICogAcqRangeImage interface for a FIFO if one exists. | |
| OwnedReadoutDirectionParams | Gets a ICogAcqReadoutDirection interface for a FIFO if one exists. | |
| OwnedROIParams | Gets a ICogAcqROI interface for a FIFO if one exists. | |
| OwnedSampleParams | Gets a ICogAcqSample interface for a FIFO if one exists. | |
| OwnedSettlingTimeParams | Gets a ICogAcqSettlingTime interface for a FIFO if one exists. | |
| OwnedSimultaneousParams | Gets a ICogAcqSimultaneous interface for a FIFO if one exists. | |
| OwnedStrobeDelayParams | Gets a ICogAcqStrobeDelay interface for a FIFO if one exists. | |
| OwnedStrobeParams | Gets a ICogAcqStrobe interface for a FIFO if one exists. | |
| OwnedStrobePulseDurationParams | Gets a ICogAcqStrobePulseDuration interface for a FIFO if one exists. | |
| OwnedSyncParams | Gets a ICogAcqSync interface for a FIFO if one exists. | |
| OwnedTriggerFilterParams | Gets a ICogAcqTriggerFilter interface for a FIFO if one exists. | |
| OwnedTriggerParams | Gets a ICogAcqTrigger interface for a FIFO if one exists. | |
| OwnedWhiteBalanceParams | Gets a ICogAcqWhiteBalance interface for a FIFO if one exists. | |
| SelectedSpaceName | Read or set the selected space name that is applied to each image returned from Acquire or CompleteAcquire. | |
| StateFlags |
Returns the complete set of state flags supported on this object. The
flags may be indexed by name as shown in the following C# code snippet:
if (changedObject.StateFlags["Color"] & eventArgs.StateFlags) { ... }
(Inherited from ICogChangedEvent.) | |
| Timeout | Read or set the timeout in milliseconds used when calling Acquire or CompleteAcquire (typically used for handling the case of triggers that didn't occur). | |
| TimeoutEnabled | Read or set whether the timeout value is used. | |
| UserData | Gets a CogDictionary object that can be used to store application-specific information for this acquisition fifo. Internal use only. | |
| VideoFormat | Video Format associated with this acquisition fifo. |
Events
| Name | Description | |
|---|---|---|
| Changed |
This event is raised when one or more parts of the object's state may
have changed.
(Inherited from ICogChangedEvent.) | |
| Complete | Occurs after a FIFO has completed an acquisition, perhaps unsuccessfully. If the acquisition was unsuccessful, Acquire or CompleteAcquire will return an error. The acquisition may have been initiated by a call to Acquire, a call to StartAcquire, or by the acquisition system if you are using auto-trigger mode. | |
| Flushed | Occurs after an acquisition FIFO is flushed. | |
| MovePart | Occurs when an acquisition FIFO determines that the camera's field of view can be changed without affecting the acquired image. | |
| Overrun | Occurs after a FIFO has missed a trigger. This usually means that triggers are coming in too fast to be processed. |
Remarks
Interface for controlling an acquisition FIFO.
To learn how image acquisition works in VisionPro, see Acquisition in VisionPro.
Each acquisition FIFO has additional properties (such as ICogAcqBrightness, ICogAcqContrast, and ICogAcqExposure) implemented as interfaces. To access these interfaces, use the Owned... getters (OwnedBrightnessParams, OwnedContrastParams, OwnedExposureParams).
See How to Change CogAcqFifo Properties for examples of how to obtain an acquisition property interface from a FIFO and how to change it.
See Also