start_acquisition#

Client.start_acquisition(number_of_acquisitions: int = 1, request_movie_buffer: bool = False, update: bool = True, queue_virtual_buffers: bool | list[bool] = False)#

Start acquiring images. Make sure all of the properties are set to the desired values.

Parameters:

  • number_of_acquisitions (int, optional) – The number of acquisitions to repeat, by default 1

  • request_movie_buffer (bool, optional) – Request a movie buffer, by default False. If True, the movie buffer will be returned with all of the frames.

  • queue_virtual_buffers (bool or list[bool], optional) –

    Controls which virtual detector buffers (0–4) are queued during acquisition. - False (default): no virtual buffers are queued. - True: all 5 virtual buffers are queued. - list[bool]: a list of exactly 5 booleans; each element enables/disables

    the corresponding virtual buffer (index 0–4).

    Requires SDK >= 5.3.0 (server commandVer >= 16).

Raises:

ValueError – If queue_virtual_buffers is a list whose length is not exactly 5.