mxcubecore.HardwareObjects.SampleView

Functions

combine_images(img1, img2)

Classes

Grid(mpos_list, screen_coord)
Line(mpos_list, screen_coord)
Point(mpos_list, screen_coord)
SampleView(name)
Shape([mpos_list, screen_coord])	Base class for shapes.
TwoDPoint(mpos_list, screen_coord)

class mxcubecore.HardwareObjects.SampleView.Grid(mpos_list, screen_coord)

Bases: Shape

class mxcubecore.HardwareObjects.SampleView.Line(mpos_list, screen_coord)

Bases: Shape

get_centred_positions()

Returns:

The centred position(s) associated with the shape.

Return type:

List of CentredPosition objects.

class mxcubecore.HardwareObjects.SampleView.Point(mpos_list, screen_coord)

Bases: Shape

class mxcubecore.HardwareObjects.SampleView.SampleView(name)

Bases: AbstractSampleView

add_shape(shape)

Add the shape <shape> to the dictionary of handled shapes.

Parameters:

• param (shape) – Shape to add.

• type (shape) – Shape object.

add_shape_from_mpos(mpos_list, screen_coord, t, state: Literal['HIDDEN', 'SAVED', 'TMP'] = 'SAVED', user_state: Literal['HIDDEN', 'SAVED', 'TMP'] = 'SAVED')

Adds a shape of type <t>, with motor positions from mpos_list and screen position screen_coord.

Parameters:

• mpos_list (list[mpos_list]) – List of motor positions

• screen_coord (tuple(x, y) – Screen cordinate for shape

• t (str) – Type str for shape, P (Point), L (Line), G (Grid)

• state (Literal['HIDDEN', 'SAVED', 'TMP']) –

• user_state (Literal['HIDDEN', 'SAVED', 'TMP']) –

Returns:

(Shape) Shape of type <t>

add_shape_from_refs(refs, t, state: Literal['HIDDEN', 'SAVED', 'TMP'] = 'SAVED', user_state: Literal['HIDDEN', 'SAVED', 'TMP'] = 'SAVED')

Adds a shape of type <t>, taking motor positions and screen positions from reference points in refs.

Parameters:

• refs (list[str]) – List of id’s of the refrence Points

• t (str) – Type str for shape, P (Point), L (Line), G (Grid)

• state (Literal['HIDDEN', 'SAVED', 'TMP']) –

• user_state (Literal['HIDDEN', 'SAVED', 'TMP']) –

Returns:

Shape of type <t>

Return type:

(Shape)

cancel_centring()

Cancels current centring procedure

clear_all()

Clear the shapes, remove all contents.

de_select_all()

De select all shapes.

de_select_shape(sid)

De-select the shape with id <sid>.

Parameters:

sid (str) – The id of the shape to de-select.

delete_shape(sid)

Removes the shape with id <sid> from the list of handled shapes.

Parameters:

sid (str) – The id of the shape to remove

Returns:

The removed shape

Return type:

(Shape)

get_grid()

Get the first of the selected grids, (the one that was selected first in a sequence of select operations)

Returns:

The first selected grid as a dictionary

Return type:

(dict)

get_grids()

Get all Grids currently handled.

Returns:

(list[Grid]) All lines currently handled

get_lines()

Get all Lines currently handled.

Returns:

(list[Line]) All lines currently handled

get_points()

Get all Points currently handled.

Returns:

(list[Point]) All points currently handled

get_selected_shapes()

Get all selected shapes.

Returns:

(list[Shape]) List fot selected Shapes

get_shape(sid)

Get Shape with id <sid>.

Parameters:

sid (str) – id of Shape to retrieve

Returns:

(Shape) All the shapes

get_shapes()

Get all Shapes.

Returns:

(list[Shape]) All the shapes

get_snapshot(overlay=None, bw=False, return_as_array=False)

Get snapshot(s)

Parameters:

• overlay (str) – Image data with shapes and other items to display on the snapshot

• bw (bool) – return grayscale image

• return_as_array (bool) – return as np array

Returns:

(BytesIO) snapshot as bytes image

inc_used_for_collection(cpos)

Increase counter that keepts on collect made on this shape, shape with associated CenteredPosition cpos

Parameters:

cpos (CenteredPosition) – CenteredPosition of shape

init()

Hardware object init.

is_selected(sid)

Check if Shape with <sid> is selected.

Returns:

(Boolean) True if Shape with <sid> is selected False otherwise

save_snapshot(path, overlay=None, bw=False)

Save a snapshot to file.

Parameters:

• path (str) – The filename.

• overlay (str) – Image data with shapes and other items to display on the snapshot

• bw (bool) – return grayscale image

select_shape(sid)

Select the shape <shape>.

Parameters:

sid (str) – Id of the shape to select.

select_shape_with_cpos(cpos)

Selects shape with the assocaitaed centerd posotion <cpos>

Parameters:

cpos (CenteredPosition) –

set_grid_data(sid, result_data, data_file_path)

Sets grid rsult data for a shape with the specified id.

Parameters:

• sid (str) – The id of the shape to set grid data for.

• result_data – The result data to set for the shape. Either a base64 encoded string for PNG/image

• RGB (or a dictionary for) –

• data_file_path (str) – The path to the data file associated with the result data.

Returns:

None

Raises:

AttributeError – If no shape with the specified id exists.

property shapes

Get shapes dict. :returns: Shapes hardware object. :rtype: (AbstractShapes)

start_auto_centring()

Start automatic centring procedure

start_centring(tree_click=True)

Starts centring procedure

take_snapshot(overlay_data=None, bw=False)

Get snapshot with overlayed data.

Parameters:

• overlay_data (str) – base64 encoded image to lay over camera image

• bw (bool) – return grayscale image

Returns:

(Image) rgb or grayscale image

class mxcubecore.HardwareObjects.SampleView.Shape(mpos_list=[], screen_coord=(-1, -1))

Bases: object

Base class for shapes.

get_centred_positions()

Returns:

The centred position(s) associated with the shape.

Return type:

List of CentredPosition objects.

class mxcubecore.HardwareObjects.SampleView.TwoDPoint(mpos_list, screen_coord)

Bases: Point