ICogAcqFifo InterfaceCognex VisionPro 9.8 SR1
An acquisition fifo.

Namespace: Cognex.VisionPro
Assembly: Cognex.VisionPro.Core (in Cognex.VisionPro.Core.dll) Version: 75.0.0.0
Syntax

public interface ICogAcqFifo : ICogChangedEvent

The ICogAcqFifo type exposes the following members.

Methods

  NameDescription
Public methodAcquire
Acquire a new image.
Public methodAcquiredPixelFormat
The pixel format of the image as the camera acquires them.
Public methodAcquireVisionData
Acquire an object that can hold one of the following types: an image, a point cloud or a vision data container.
Public methodCompleteAcquire
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.
Public methodCompleteAcquireEx
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.
Public methodCompleteAcquireVisionDataEx
Returns an ICogVisionData that can hold one of the following types: an image, a point cloud or a vision data container.
Public methodConnect
Cognex Internal use only.
Public methodCreateEventSink
Create an object in the event thread of this fifo. This allows single-threaded objects to sink acquisition events efficiently.
Public methodFlush
Flush all outstanding queued acquisitions.
Public methodGetFifoState
Returns the instantaneous state of the fifo.
Public methodGetInternal
Cognex Internal use only.
Public methodPrepare
Prepare the fifo so it is ready to start taking triggers immediately.
Public methodResumeAndRaiseChangedEvent
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.)
Public methodSetInternal
Cognex Internal use only.
Public methodStartAcquire
Start a new acquisition. The returned value is a ticket that may be handed to CompleteAcquire.
Public methodSuspendChangedEvent
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.)
Top
Properties

  NameDescription
Public propertyAutoPrepareEnabled
Whether a fifo is automatically prepared after a property is changed. Default is true.
Public propertyCameraPort
Camera port number which this fifo is attached to.
Public propertyChangedEventSuspended
Indicates if the raising of the Changed event has been suspended.
(Inherited from ICogChangedEvent.)
Public propertyCoordinateSpaceTree
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.
Public propertyFrameGrabber
Frame grabber associated with this acquisition fifo.
Public propertyNumCameraPorts
Number of physical camera ports available for this acquisition fifo.
Public propertyOutputPixelFormat
The desired pixel format for images acquired with this fifo. A conversion will be performed if different from AcquiredPixelFormat.
Public propertyOwned1394DCAMParams
Gets a ICogAcq1394DCAM interface for a FIFO if one exists.
Public propertyOwnedBrightnessMultiChannelParams
Gets a ICogAcqBrightnessMultiChannel interface for a FIFO if one exists.
Public propertyOwnedBrightnessParams
Gets a ICogAcqBrightness interface for a FIFO if one exists.
Public propertyOwnedCameraCalibrationParams
Gets a ICogAcqCameraCalibration interface for a FIFO if one exists.
Public propertyOwnedChargeTransferIntervalParams
Gets a ICogAcqChargeTransferInterval interface for a FIFO if one exists.
Public propertyOwnedContrastMultiChannelParams
Gets a ICogAcqContrastMultiChannel interface for a FIFO if one exists.
Public propertyOwnedContrastParams
Gets a ICogAcqContrast interface for a FIFO if one exists.
Public propertyOwnedCustomPropertiesParams
Gets a ICogAcqCustomProperties interface for a FIFO if one exists.
Public propertyOwnedDigitalCameraGainParams
Gets a ICogAcqDigitalCameraGain interface for a FIFO if one exists.
Public propertyOwnedExposureParams
Gets a ICogAcqExposure interface for a FIFO if one exists.
Public propertyOwnedFieldCalibrationParams
Gets a ICogAcqFieldCalibration interface for a FIFO if one exists.
Public propertyOwnedGenTLBuffersParams
Gets a ICogAcqGenTLBuffers interface for a FIFO if one exists.
Public propertyOwnedGigEVisionTransportParams
Gets a ICogAcqGigEVisionTransport interface for a FIFO if one exists.
Public propertyOwnedHardwareImagePoolParams
Gets a ICogAcqHardwareImagePool interface for a FIFO if one exists.
Public propertyOwnedHorizontalAdjustmentParams
Gets a ICogAcqHorizontalAdjustment interface for a FIFO if one exists.
Public propertyOwnedLightParams
Gets a ICogAcqLight interface for a FIFO if one exists.
Public propertyOwnedLineScanParams
Gets a ICogAcqLineScan interface for a FIFO if one exists.
Public propertyOwnedLookupTableParams
Gets a ICogAcqLookupTable interface for a FIFO if one exists.
Public propertyOwnedMasterClockFrequencyParams
Gets a ICogAcqMasterClockFrequency interface for a FIFO if one exists.
Public propertyOwnedOffsetClampParams
Gets a ICogAcqOffsetClamp interface for a FIFO if one exists.
Public propertyOwnedProfileCameraParams
Gets a ICogAcqProfileCamera interface for a FIFO if one exists.
Public propertyOwnedRangeImageParams
Gets a ICogAcqRangeImage interface for a FIFO if one exists.
Public propertyOwnedReadoutDirectionParams
Gets a ICogAcqReadoutDirection interface for a FIFO if one exists.
Public propertyOwnedROIParams
Gets a ICogAcqROI interface for a FIFO if one exists.
Public propertyOwnedSampleParams
Gets a ICogAcqSample interface for a FIFO if one exists.
Public propertyOwnedSettlingTimeParams
Gets a ICogAcqSettlingTime interface for a FIFO if one exists.
Public propertyOwnedSimultaneousParams
Gets a ICogAcqSimultaneous interface for a FIFO if one exists.
Public propertyOwnedStrobeDelayParams
Gets a ICogAcqStrobeDelay interface for a FIFO if one exists.
Public propertyOwnedStrobeParams
Gets a ICogAcqStrobe interface for a FIFO if one exists.
Public propertyOwnedStrobePulseDurationParams
Gets a ICogAcqStrobePulseDuration interface for a FIFO if one exists.
Public propertyOwnedSyncParams
Gets a ICogAcqSync interface for a FIFO if one exists.
Public propertyOwnedTriggerFilterParams
Gets a ICogAcqTriggerFilter interface for a FIFO if one exists.
Public propertyOwnedTriggerParams
Gets a ICogAcqTrigger interface for a FIFO if one exists.
Public propertyOwnedWhiteBalanceParams
Gets a ICogAcqWhiteBalance interface for a FIFO if one exists.
Public propertySelectedSpaceName
Read or set the selected space name that is applied to each image returned from Acquire or CompleteAcquire.
Public propertyStateFlags
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.)
Public propertyTimeout
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).
Public propertyTimeoutEnabled
Read or set whether the timeout value is used.
Public propertyUserData
Gets a CogDictionary object that can be used to store application-specific information for this acquisition fifo. Internal use only.
Public propertyVideoFormat
Video Format associated with this acquisition fifo.
Top
Events

  NameDescription
Public eventChanged
This event is raised when one or more parts of the object's state may have changed.
(Inherited from ICogChangedEvent.)
Public eventComplete
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.
Public eventFlushed
Occurs after an acquisition FIFO is flushed.
Public eventMovePart
Occurs when an acquisition FIFO determines that the camera's field of view can be changed without affecting the acquired image.
Public eventOverrun
Occurs after a FIFO has missed a trigger. This usually means that triggers are coming in too fast to be processed.
Top
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