mxcubecore.HardwareObjects.abstract.AbstractAperture#

Abstract hardware object for the aperture.

Classes

AbstractAperture(name)

Abstract hardware object for the aperture.
class mxcubecore.HardwareObjects.abstract.AbstractAperture.AbstractAperture(name: str)[source]#

Bases: HardwareObject

Abstract hardware object for the aperture.

Emits:

  • diameterIndexChanged (int, float) – Two-item tuple: current index and diameter in millimeters.

  • valueChanged (str) – Current position name.

Parameters:

name (str) –

force_emit_signals() → None[source]#

Reemit all signals.

Return type:

None

get_diameter_index() → int[source]#

Get current diameter index.

Returns:

Current diameter index.

Return type:

int

get_diameter_size() → float[source]#

Get diameter size.

Returns:

Current diameter size in millimeters.

Return type:

float

get_diameter_size_list() → list[float][source]#

Get list of diameter sizes.

Returns:

List of diameter sizes in microns.

Return type:

list[float]

get_position_list() → list[str][source]#

Get list of positions.

Returns:

Position names as a list of strings.

Return type:

list[str]

get_position_name() → str[source]#

Get current position name.

Returns:

Current position name.

Return type:

str

init()[source]#

Hardware object init.

is_out() → bool[source]#
Returns:

True if aperture is in the beam, otherwise returns False.

Return type:

bool

set_diameter_index(diameter_index: int) → None[source]#

Set active diameter index.

Parameters:

diameter_index (int) – Selected diameter index.

Return type:

None

set_diameter_size(diameter_size: int) → None[source]#

Set diameter size.

Parameters:

diameter_size (int) – selected diameter index

Return type:

None

set_in()[source]#

Set aperture in the beam.

set_out()[source]#

Remove aperture from the beam.

set_position_index(position_index: int) → None[source]#

Set aperture position based on a position index.

Parameters:

position_index (int) – Selected position index.

Return type:

None

set_position_name(position_name: str) → None[source]#

Set aperture position based on a position name.

Parameters:

position_name (str) – Selected position name.

Return type:

None