de_twin.state.AcquisitionRequest#

class de_twin.state.AcquisitionRequest(camera_model='DE16', exposure_mode=ExposureMode.NORMAL, frame_time_s=0.01, total_frames=1, frames_per_buffer=1, hw_roi=None, hw_binning=(1, 1), bit_depth=None, counting=False, beam_blank_cmd=2, shutter_cmd=2, camera_inserted=True, scan=<factory>, acquisition_index=0, super_resolution=False, seed=None)[source]#

Bases: object

What the camera has been asked to produce.

Filled from DE-Server (shared-memory control block), from the deapi fake server’s properties, or directly by an in-process caller.

Parameters:

camera_model (str)
exposure_mode (ExposureMode)
frame_time_s (float)
total_frames (int)
frames_per_buffer (int)
hw_roi (Roi | None)
hw_binning (tuple[int, int])
bit_depth (int | None)
counting (bool)
beam_blank_cmd (int)
shutter_cmd (int)
camera_inserted (bool)
scan (ScanRequest)
acquisition_index (int)
super_resolution (bool)
seed (int | None)

__init__(camera_model='DE16', exposure_mode=ExposureMode.NORMAL, frame_time_s=0.01, total_frames=1, frames_per_buffer=1, hw_roi=None, hw_binning=(1, 1), bit_depth=None, counting=False, beam_blank_cmd=2, shutter_cmd=2, camera_inserted=True, scan=<factory>, acquisition_index=0, super_resolution=False, seed=None)#

Parameters:

camera_model (str)
exposure_mode (ExposureMode)
frame_time_s (float)
total_frames (int)
frames_per_buffer (int)
hw_roi (Roi | None)
hw_binning (tuple[int, int])
bit_depth (int | None)
counting (bool)
beam_blank_cmd (int)
shutter_cmd (int)
camera_inserted (bool)
scan (ScanRequest)
acquisition_index (int)
super_resolution (bool)
seed (int | None)

Return type:

None

Methods

__init__([camera_model, exposure_mode, ...])

Attributes

`acquisition_index`
`beam_blank_cmd`
`beam_reaches_detector`	False when the acquisition itself blocks the beam (dark reference etc.).
`bit_depth`
`camera_inserted`
`camera_model`
`counting`
`exposure_mode`
`frame_time_s`
`frames_per_buffer`
`hw_binning`
`hw_roi`
`seed`	frame k is seeded by (seed, k) whatever the twin exposed before.
`shutter_cmd`
`super_resolution`	read out at 2x the ROI each way (Apollo "Super-resolution").
`total_frames`
`scan`

camera_model: str = 'DE16'#

exposure_mode: ExposureMode = 3#

frame_time_s: float = 0.01#

total_frames: int = 1#

frames_per_buffer: int = 1#

hw_roi: Roi | None = None#

hw_binning: tuple[int, int] = (1, 1)#

bit_depth: int | None = None#

counting: bool = False#

beam_blank_cmd: int = 2#

shutter_cmd: int = 2#

camera_inserted: bool = True#

scan: ScanRequest#

acquisition_index: int = 0#

super_resolution: bool = False#

read out at 2x the ROI each way (Apollo “Super-resolution”).

Type:: Counting cameras

seed: int | None = None#

frame k is seeded by (seed, k) whatever the twin exposed before. None: the twin’s own seed and running frame count.

Type:: Pins this acquisition’s detector noise

property beam_reaches_detector: bool#: False when the acquisition itself blocks the beam (dark reference etc.).