mxcubecore.HardwareObjects.abstract.AbstractAperture#

Classes

class mxcubecore.HardwareObjects.abstract.AbstractAperture.AbstractAperture(name)[source]#

Bases: HardwareObject

force_emit_signals()[source]#

Reemits all signals

get_diameter_index()[source]#
Returns:

current diameter index

Return type:

int

get_diameter_size()[source]#
Returns:

current diameter size in mm

Return type:

float

get_diameter_size_list()[source]#
Returns:

list of diameter sizes in microns

Return type:

list

get_position_list()[source]#
Returns:

list of position names as str

Return type:

list

get_position_name()[source]#
Returns:

current position as str

Return type:

str

init()[source]#

Hardware object init.

is_out()[source]#
Returns:

True if aperture is in the beam, otherwise returns false

Return type:

bool

set_diameter_index(diameter_index)[source]#

Sets active diameter index

Parameters:

diameter_index (int) – selected diameter index

Emits:

diameterIndexChanged (int, float): current index, diameter in mm

set_diameter_size(diameter_size)[source]#
Parameters:

diameter_size (int) – selected diameter index

set_in()[source]#

Sets aperture in the beam

set_out()[source]#

Removes aperture from the beam

set_position_index(position_index)[source]#

Sets aperture position based on a position index

Parameters:

position_index (int) – selected position index

set_position_name(position_name)[source]#

Sets aperture position based on a position name

Parameters:

position_name (str) – selected position