mxcubecore.HardwareObjects.EDNACharacterisation#

Classes

EDNACharacterisation(name)

class mxcubecore.HardwareObjects.EDNACharacterisation.EDNACharacterisation(name)[source]#

Bases: AbstractCharacterisation

characterise(edna_input) → str[source]#

Runs Characterisation and returns the results.

Parameters:

input (EDNAInput) –

Return type:

str

dc_from_output(edna_result, reference_image_collection) → List[DataCollection][source]#

Create a data collection from characterisation result :param output: :type output: object

Returns:

(queue_model_objects.DataCollection)

Return type:

List[DataCollection]

get_default_characterisation_parameters() → CharacterisationParameters[source]#

Returns the default parameters

Return type:

CharacterisationParameters

get_html_report(edna_result) → str[source]#

Returns the path to the html result report generated by the characterisation software.

Parameters:

output (EDNAResult) –

Return type:

str

init() → None[source]#

Hardware object init.

Return type:

None

input_from_params(data_collection, char_params) → XSDataInputMXCuBE[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

Return type:

XSDataInputMXCuBE