BFModule.Display.clsDisp

class BFModule.Display.clsDisp

Bases: pybind11_object

A GUI widget used to display bitmap images.

__init__(*args, **kwargs)

Overloaded function.

1. __init__(self: BFModule.Display.clsDisp) -> None

2. __init__(self: BFModule.Display.clsDisp, bufAq: BFModule.BufferAcquisition.clsBufferedAcquisition) -> None

   param BufferAcquisition bufAq:

   Acquisition object

Methods

Close(self)	Close the display surface.
Open(self)	Open a display surface.
Update(*args, **kwargs)	Overloaded function.
__init__(*args, **kwargs)	Overloaded function.

Attributes

isOpen

Check if the display is open.

Close(self: BFModule.Display.clsDisp) → None

Close the display surface.

Raises:

RuntimeError – Error closing the display surface.

Open(self: BFModule.Display.clsDisp) → None

Open a display surface. :raises RuntimeError: Error opening display surface.

Update(*args, **kwargs)

Overloaded function.

1. Update(self: BFModule.Display.clsDisp, buf: numpy.ndarray[numpy.uint8]) -> None

   Update the display surface.

   param numpy.array buf:

   The buffer to display

   rtype:

   void

   raises RuntimeError:

   Error updating ImageView display.

2. Update(self: BFModule.Display.clsDisp, buf: numpy.ndarray[numpy.uint16]) -> None

   Update the display surface.

   param numpy.array buf:

   The buffer to display

   rtype:

   void

   raises RuntimeError:

   Error updating ImageView display.

property isOpen

Check if the display is open.

Return type:

bool

Retruns:

True if display is open, False otherwise.