mxcubecore.HardwareObjects.MicrodiffAperture

MicrodiffAperture. Move the aperture in the beam to a specified value or out of the beam. The factor, which serves to calculate the flux, can be a single value or a tuple of values per aperture size.

Example xml file: <object class=”MicrodiffAperture”>

<username>aperture</username> <exporter_address>wid30bmd2s:9001</exporter_address> <value_channel_name>CurrentApertureDiameterIndex</value_channel_name> <state_channel_name>State</state_channel_name> <– either only factor –> <factor>(0.15, 0.3, 0.63, 0.9, 0.96)</factor> <!– or complete, corresponding to label: (index, size[um], factor) –> <values>{“A10”: (0, 10, 0.15), “A20”: (1, 20, 0.3), “A30”: (2, 30, 0.63), “A50”: (3, 50, 0.9), “A75”: (4, 75, 0.96)}</values> <object role=”inout” href=”/udiff_apertureinout”/>

</object>

Classes

MicrodiffAperture(name)

MicrodiffAperture class

class mxcubecore.HardwareObjects.MicrodiffAperture.MicrodiffAperture(name)

Bases: ExporterNState

MicrodiffAperture class

get_diameter_size_list()

Get the list of values to be visible. Hide IN, OUT and UNKNOWN. :returns: List of availble aperture values (string). :rtype: (list)

get_factor(label)

Get the factor associated to a label. :param (enum: label enum or name :param str): label enum or name

Returns:

Factor value

Return type:

(float) or (tuple)

get_size(label)

Get the aperture size associated to a label. :param (enum: label enum or name :param str): label enum or name

Returns:

Factor value

Return type:

(float)

Raises:

RuntimeError – Unknown aperture size.

init()

Initialize the aperture