mxcubecore.HardwareObjects.ESRF.ESRFSession

Classes

ESRFSession(name)

class mxcubecore.HardwareObjects.ESRF.ESRFSession.ESRFSession(name)

Bases: Session

get_default_subdir(sample_data: dict) → str

Gets the default sub-directory based on sample information

Parameters:

sample_data (dict) – Lims sample dictionary

Returns:

Sub-directory path string

Return type:

str

get_full_path(subdir: str, tag: str) → Tuple[str, str]

Returns the full path to both image and processed data. The path(s) returned will follow the convention:

<base_direcotry>/<subdir>/run_<NUMBER>_<tag>

Where NUMBER is a automaticaly sequential number and base_directory the path returned by get_base_image/process_direcotry

Parameters:

• subdir (str) – subdirecotry

• tag (str) – tag for

Returns:

Tuple with the full path to image and processed data

Return type:

Tuple[str, str]

get_image_directory(sub_dir=None)

Returns the full path to images, using the name of each of data_nodes parents as sub directories.

Parameters:

data_node (TaskNode) – The data node to get additional information from, (which will be added to the path).

Returns:

The full path to images.

Return type:

str

init()

Hardware object init.