BFModule.BufferAcquisition.AcqStatus

class BFModule.BufferAcquisition.AcqStatus

Bases: pybind11_object

Struct holding the values of all the acquisition flags.

__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)

Attributes

Abort	Returns the abort status of acquisition.
Cleanup	Returns the clean up status.
Pause	Returns the pause status of acquisition.
Start	Returns the start status of acquisition.
Stop	Returns the stop status of acquisition.
Unknown	Unknown status.

property Abort

Returns the abort status of acquisition. If Abort is TRUE, acquisition of image data to buffers has been aborted. When acquisition is aborted, acquisition of data is stopped immediately, not waiting for the last frame to be completely acquired. If Abort is FALSE, acquisition has not been aborted.

Type:

bool

property Cleanup

Returns the clean up status. If Cleanup is TRUE, BiSeqCleanUp or BiCircCleanUp has been called. If FALSE, BiSeqCleanUp or BiCircCleanUp has not been called.

Type:

bool

property Pause

Returns the pause status of acquisition. If Pause is TRUE, acquisition of image data to buffers has been paused. If FALSE, acquisition has not been paused.

Type:

bool

property Start

Returns the start status of acquisition. If Start is TRUE, the acquisition of image data to buffers has started. If Start is FALSE, acquisition of image data has either been stopped, never started, or aborted.

Type:

bool

property Stop

Returns the stop status of acquisition. If Stop is TRUE, acquisition of image data to buffers has been stopped, aborted, or never started. When acquisition is stopped, the last frame is fully acquired, then acquisition is stopped. If Stop is FALSE, image data is being acquired.

Type:

bool

property Unknown

Unknown status.

Type:

bool