mxcubecore.HardwareObjects.mockup.SOLEILCharacterisationMockup#

Classes

SOLEILEDNACharacterisationMockup(name)

class mxcubecore.HardwareObjects.mockup.SOLEILCharacterisationMockup.SOLEILEDNACharacterisationMockup(name)[source]#

Bases: AbstractCharacterisation

characterise(edna_input)[source]#

Start the characterosation. :param input: :type input: object

Returns:

(str) The Characterisation result.

execute_command(command_name, *args, **kwargs)[source]#

Execute command.

Parameters:

  • command_name (str) – Command name.

  • *args (tuple) – Arguments to pass through to the command to be executed.

  • **kwargs (Dict[str, Any]) – Named arguments to pass through to the

  • executed. (command to be) –

Raises:

AttributeError – If command not found.

Returns:

Execution output.

Return type:

Any

get_html_report(edna_result)[source]#

Get the path to the characterisation html report, generated by the characterisation softare. :param output: Characterisation output object :type output: object

Returns:

(str) The path to the html result report.

input_from_params(data_collection, char_params)[source]#
Parameters:

  • ref_parameters – (A named tuple or object with following fields): ‘id’, ‘prefix’, ‘run_number’, ‘template’, ‘first_image’, ‘num_images’, ‘osc_start’, ‘osc_range’, ‘overlap’, ‘exp_time’, ‘num_passes’, ‘comments’, ‘path’, ‘centred_positions’, ‘energy’, ‘resolution’, ‘transmission’, ‘shutterless’, ‘inverse_beam’, ‘screening_id’

  • char_params –

    (A named tuple or object with following fields): # Optimisation parameters ‘aimed_resolution’ ‘aimed_multiplicity’ ‘aimed_i_sigma’ ‘aimed_completness’ ‘strategy_complexity’ ‘induce_burn’ ‘use_permitted_rotation’ ‘permitted_phi_start’ ‘permitted_phi_end’

    # Crystal ‘max_crystal_vdim’ ‘min_crystal_vdim’ ‘max_crystal_vphi’ ‘min_crystal_vphi’ ‘space_group’

    # Characterisation type ‘use_min_dose’ ‘use_min_time’ ‘min_dose’ ‘min_time’ ‘account_rad_damage’ ‘not_use_low_res’ ‘auto_res’ ‘opt_sad’ ‘sad_res’ ‘determine_rad_params’

    # Radiation damage model ‘rad_suscept’ ‘beta’ ‘sigma’

  • path_str (Template string representing path to each image) –

Returns:

Input for characterisation software

is_running()[source]#
Returns:

(bool) True if process is running otherwise False