mxcubecore.HardwareObjects.MAXIV.BIOMAXEiger#

File: BIOMAXEiger.py

Description: This module implements the hardware object for the Eiger detector

based on a Tango device server

Detector Status:#

hardware status:

ready: ready for trigger (this is the state after an “Arm” command) idle: ready for config (this should be the state after a “Disarm” command)

hardware object status:

configuring: a configuration task is ongoing

Functions

test()

Classes

BIOMAXEiger(*args)

Description: Eiger hwobj based on tango
class mxcubecore.HardwareObjects.MAXIV.BIOMAXEiger.BIOMAXEiger(*args)[source]#

Bases: HardwareObject

Description: Eiger hwobj based on tango

abort()[source]#

Immediately terminate HardwareObject action.

Should not happen in state READY.

cancel_acquisition()[source]#

Cancel acquisition

get_header_appendix()[source]#

Data that is appended to the header data

get_header_detail()[source]#

Detail of header data to be sent.

get_image_appendix()[source]#

Data that is appended to the image data

get_pixel_size_x()[source]#

return sizes of a single pixel along x-axis respectively unit, mm

get_pixel_size_y()[source]#

return sizes of a single pixel along y-axis respectively unit, mm

get_stream_state()[source]#

“disabled”, “ready”, “acquire” or “error”.

get_x_pixels_in_detector()[source]#

number of pixels along x-axis numbers vary depending on the RoiMode

get_y_pixels_in_detector()[source]#

number of pixels along y-axis, numbers vary depending on the RoiMode

init()[source]#

Hardware object init.

is_ready()[source]#

Convenience function: Check if the object state is READY.

The same effect could be achieved with `python self.get_state() == self.STATES.READY `

Returns:

True if ready, otherwise False.

Return type:

bool

prepare_acquisition(config)[source]#

config is a dictionary OmegaStart,OmegaIncrement, BeamCenterX BeamCenterY OmegaStart OmegaIncrement start, osc_range, exptime, ntrigger, number_of_images, images_per_file, compression,ROI,wavelength):

set_channel_value(name, value)[source]#

Set channel value.

Parameters:

  • channel_name (str) – Channel name.

  • value (Any) – Value to set.

set_energy_threshold(threshold)[source]#

set energy_threshold Note, the readout_time will be changed By deafult, the value is 50% of the photon_energy and will be updated upon setting PhotonEnergy. If other values are needed, this should be set after changing PhotonEnergy. Eengery, in eV

set_header_appendix(value)[source]#

Data that is appended to the header data

set_header_detail(value)[source]#

Detail of header data to be sent.

set_image_appendix(value)[source]#

Data that is appended to the image data

set_photon_energy(energy)[source]#

set photon_energy Note, the readout_time will be changed engery, in eV

stop_acquisition()[source]#

when use external trigger, Disarm is required, otherwise the last h5 will not be released and not available in WebDAV.

wait_ready(timeout=20)[source]#

Wait timeout seconds till object is ready.

If timeout is None: wait forever.

Parameters:

timeout (Optional[float], optional) – Timeout (seconds). Defaults to None.