AbstractDataAnalysis Module

Example configuration file: data-analysis.xml

class HardwareObjects.AbstractDataAnalysis.AbstractDataAnalysis

Bases: object

characterise(edna_input)
Returns:The EDNA Characterisation result XML.
Str :
from_params(ref_parameters, char_params, path_str)

Return xml input file for EDNA

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’
param 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’ ‘determine_rad_params’

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

param path_str:Template string representing path to each image
get_html_report(edna_output)
Returns:The path to the html result report generated by EDNA.
Return type:str
HardwareObjects.AbstractDataAnalysis.dc_from_edna_output(edna_output, sample, dcg, session, char_params=None)

Project Versions

Previous topic

HardwareObjects Package

Next topic

AbstractMultiCollect Module

This Page