mxcubecore.HardwareObjects.GenericDiffractometer

GenericDiffractometer

Classes

BlockShapeEnum(value)	An enumeration.
CalibrationData(*[, top_left, top_right, ...])
ChipLayout(*[, head_type, holder_type, ...])
DiffractometerState()	Enumeration of diffractometer states
GenericDiffractometer(name)	Abstract base class for diffractometers
GonioHeadConfiguration(*[, current])
HeadTypeEnum(value)	An enumeration.
HolderTypeEnum(value)	An enumeration.
PhaseEnum(value)	An enumeration.
PhaseModel(*[, value])
SampleHolderSectionModel(*[, ...])

class mxcubecore.HardwareObjects.GenericDiffractometer.BlockShapeEnum(value)

Bases: str, Enum

An enumeration.

class mxcubecore.HardwareObjects.GenericDiffractometer.DiffractometerState

Bases: object

Enumeration of diffractometer states

class mxcubecore.HardwareObjects.GenericDiffractometer.GenericDiffractometer(name)

Bases: HardwareObject

Abstract base class for diffractometers

accept_centring()

Descript. : Arg. “ fully_centred_point. True if 3 click centring

else False

property alignment_x

alignment_x motor object (also used as graphics.focus)

Returns:

AbstractActuator

property alignment_y

alignment_y motor object

Returns:

AbstractActuator

property alignment_z

alignment_z motor object

Returns:

AbstractActuator

beam_position_changed(value)

Descript. :

centring_done(centring_procedure)

Descript. :

property centring_x

centring_x motor object

Returns:

AbstractActuator

property centring_y

centring_y motor object

Returns:

AbstractActuator

close_kappa()

Descript. :

current_phase_changed(current_phase)

Descript. :

emit_centring_failed()

Descript. :

emit_centring_moving()

Descript. :

emit_centring_started(method)

Descript. :

emit_centring_successful()

Descript. :

emit_progress_message(msg=None)

Descript. :

execute_server_task(method, timeout=30, *args)

Method is used to execute commands and wait till

diffractometer is in ready state

Parameters:

• method (instance) – method to be executed

• timeout (seconds) – timeout in seconds

force_emit_signals()

Emits all hardware object signals

The method is called from the gui via beamline object to ensure that bricks have values after the initialization. Problem arrise when a hardware object is used by several bricks. If first brick connects to some signal emited by a brick then other bricks connecting to the same signal will not receive the values on the startup. The easiest solution is to call force_emit_signals method directly after the initialization of the beamline object

get_available_centring_methods()

Descript. :

get_centring_status()

Descript. :

get_current_centring_method()

Descript. :

get_current_phase()

Descript. :

get_grid_direction()

Descript. :

get_head_type()

Returns head type

Returns:

string

get_motors()

Get motor_name:Motor dictionary

get_osc_limits()

Returns osc limits

get_phase_list()

Returns list of available phases

Returns:

list with str

get_pixels_per_mm()

Returns tuple with pixels_per_mm_x and pixels_per_mm_y

Returns:

list with two floats

get_point_between_two_points(point_one, point_two, frame_num, frame_total)

Method returns a centring point between two centring points It is used to get a position on a helical line based on frame number and total frame number

get_positions()

Descript. :

get_scan_limits(speed=None, num_images=None, exp_time=None)

Gets scan limits. Necessary for example in the plate mode where osc range is limited

get_snapshot()

Get snapshot from sample view

Returns:

A bytes object of the current camera image.

Return type:

bytes

head_type_changed(head_type)

Descript. :

image_clicked(x, y, xi=None, yi=None)

Descript. :

in_plate_mode()

Returns True if diffractometer in plate mod

Returns:

boolean

init()

Hardware object init.

is_ready()

Detects if device is ready

property kappa

kappa motor object

Returns:

AbstractActuator

property kappa_phi

kappa_phi motor object

Returns:

AbstractActuator

motor_state_changed(state)

Descript. :

move_motors(motor_positions, timeout=15)

Moves diffractometer motors to the requested positions

Parameters:

motors_dict (dict) – dictionary with motor names or hwobj and target values.

move_motors_done(move_motors_procedure)

Descript. :

move_omega_relative(relative_angle)

Descript. :

move_to_beam(x, y, omega=None)

Descript.function to create a centring point based on all motors

positions.

property omega

omega motor object

Returns:

AbstractActuator

reject_centring()

Descript. :

sample_is_loaded_changed(sample_is_loaded)

Descript. :

set_phase(phase, timeout=None)

Sets diffractometer to selected phase

By default available phase is Centring, BeamLocation, DataCollection, Transfer

Parameters:

• phase (string) – phase

• timeout (int) – timeout in sec

set_use_sc(flag)

Sets use_sc flag, that indicates if sample changer is used

Parameters:

flag (boolean) – use sample changer flag

start_move_to_beam(coord_x=None, coord_y=None, omega=None, wait_result=None)

Descript. :

transfer_mode_changed(transfer_mode)

Descript. :

use_sample_changer()

Returns True if sample changer is in use

Returns:

boolean

visual_align(point_1, point_2)

Descript. :

wait_device_ready(timeout=30)

Waits when diffractometer status is ready:

Parameters:

timeout (int) – timeout in second

wait_ready(timeout=30)

Waits when diffractometer status is ready:

Parameters:

timeout (int) – timeout in second

property zoom

zoom motor object

NBNB HACK TODO - ocnfigure this in graphics object (which now calls this property)

Returns:

AbstractActuator

class mxcubecore.HardwareObjects.GenericDiffractometer.HeadTypeEnum(value)

Bases: str, Enum

An enumeration.

class mxcubecore.HardwareObjects.GenericDiffractometer.HolderTypeEnum(value)

Bases: str, Enum

An enumeration.

class mxcubecore.HardwareObjects.GenericDiffractometer.PhaseEnum(value)

Bases: str, Enum

An enumeration.