BFModule.BufferAcquisition.BufferInfo

class BFModule.BufferAcquisition.BufferInfo

Bases: pybind11_object

Class returning the buffer info for the WaitForFrameDone methods.

__init__(self: BFModule.BufferAcquisition.BufferInfo) → None

Methods

__init__(self)

Attributes

BufferNumber	The index of this buffer in the buffer array.
CXPSrcTag	The CXP frame buffer soruce tag.
CXPXOffset	The CXP frame x-offset.
CXPYOffset	The CXP frame y-offset.
FrameCount	The frame count of this buffer within the overall acquisition.
HiResTimeStamp	System high resolution timestamp.
NumItemsOnQueue	The number of buffers still waiting on the queue.
NumLinesAcquired	The number of lines acquired.
TimeStamp	The system or board time at the instant of frame capture.

property BufferNumber

The index of this buffer in the buffer array.

property CXPSrcTag

The CXP frame buffer soruce tag.

property CXPXOffset

The CXP frame x-offset.

property CXPYOffset

The CXP frame y-offset.

property FrameCount

The frame count of this buffer within the overall acquisition.

property HiResTimeStamp

System high resolution timestamp. Does not correlate direclty to wall time.

property NumItemsOnQueue

The number of buffers still waiting on the queue.

property NumLinesAcquired

The number of lines acquired. Usually equals the buffer y-size/height.

property TimeStamp

The system or board time at the instant of frame capture.