mxcubecore.HardwareObjects.ESRF.ESRFPhotonFlux

Photon flux calculations Example xml_ configuration:

class: ESRF.ESRFPhotonFlux.ESRFPhotonFlux
 configuration:
   beam_check_name: checkbeam
   counter_name: i0
   threshold: 5000000000.0
   username: Photon flux
 objects:
   aperture: udiff_aperture.yaml
   controller: bliss.yaml
   monitor_beam: monitor_beam.yaml

Classes

ESRFPhotonFlux(name)

Photon flux calculation

class mxcubecore.HardwareObjects.ESRF.ESRFPhotonFlux.ESRFPhotonFlux(name)

Bases: AbstractFlux

Photon flux calculation

property check_beam

Check if there is beam :returns: True if beam present, False otherwise :rtype: (bool)

get_value()

Get the flux value as function of a diode reading, the energy

and the aperture factor (if any).

Returns:

The flux value or 0 if below the pre-defined threshold.

Return type:

(float)

init()

Initialisation

wait_for_beam(timeout=None)

Wait until beam present. :param timeout: optional - timeout [s],

If timeout == 0: return at once and do not wait

(default);

if timeout is None: wait forever.