mxcubecore.HardwareObjects.abstract.AbstractCollect#

AbstractMulticollect Defines a sequence how data collection is executed.

Classes

`AbstractCollect`(name)
`BeamlineConfig`(synchrotron_name, ...)

class mxcubecore.HardwareObjects.abstract.AbstractCollect.AbstractCollect(name)[source]#

Bases: HardwareObject, object

close_detector_cover()[source]#: Descript. :

close_fast_shutter()[source]#: Descript. :

close_safety_shutter()[source]#: Descript. :

collect(owner, dc_parameters_list)[source]#: Main collect method.

collection_failed(failed_msg=None)[source]#: Collection failed method

collection_finished()[source]#: Collection finished beahviour

collection_stopped()[source]#: Collection stopped method

create_directories(*args)[source]#: Descript. :

create_file_directories()[source]#: Method create directories for raw files and processing files. Directorie names for xds, mosflm and hkl are created

data_collection_cleanup()[source]#: Method called when at end of data collection, successful or not.

abstract data_collection_hook()[source]#: Descript. :

do_collect(owner)[source]#: Actual collect sequence

get_beam_size()[source]#: Descript. :

get_cryo_temperature()[source]#: Descript. :

get_detector_distance()[source]#: Descript. :

get_machine_current()[source]#: Descript. :

get_machine_fill_mode()[source]#: Descript. :

get_machine_message()[source]#: Descript. :

get_measured_intensity()[source]#: Descript. :

get_resolution()[source]#: Descript. :

get_sample_info()[source]#: Descript. :

get_slit_gaps()[source]#: Descript. :

get_transmission()[source]#: Descript. :

get_undulators_gaps()[source]#: Descript. :

get_wavelength()[source]#: Descript. :

init()[source]#: Hardware object init.

move_detector(value)[source]#: Descript. :

move_to_centered_position()[source]#: Descript. :

open_detector_cover()[source]#: Descript. :

open_fast_shutter()[source]#: Descript. :

open_safety_shutter()[source]#: Descript. :

prepare_input_files()[source]#: Prepares input files for xds, mosflm and hkl2000 returns: 3 strings

setCentringStatus(status)[source]#: Descript. :

set_beamline_configuration(**configuration_parameters)[source]#

Sets beamline configuration

Parameters:: configuration_parameters (dict) – dict with config param.

set_energy(value)[source]#: Descript. :

set_fast_characterisation(arg)[source]#: Descript. :

set_helical(arg)[source]#: Descript. :

set_helical_pos(arg)[source]#: Descript. :

set_mesh_scan_parameters(num_lines, total_nb_frames, mesh_center_param, mesh_range_param)[source]#

sets the mesh scan parameters :

vertcal range
horizontal range
nb lines
nb frames per line
invert direction (boolean) # NOT YET DONE

set_resolution(value)[source]#: Descript. :

set_transmission(value)[source]#: Descript. :

set_wavelength(value)[source]#: Descript. :

stop_collect()[source]#: Stops data collection

store_data_collection_in_lims()[source]#: Descript. :

store_image_in_lims(frame_number, motor_position_id=None)[source]#: Descript. :

store_sample_info_in_lims()[source]#: Descript. :

take_crystal_snapshots()[source]#: Descript. :

abstract trigger_auto_processing(process_event, frame_number)[source]#: Descript. :

update_data_collection_in_lims()[source]#: Descript. :

update_lims_with_workflow(workflow_id, grid_snapshot_filename)[source]#

Updates collection with information about workflow

Parameters:

workflow_id (int) – workflow id
grid_snapshot_filename (string) – grid snapshot file path

class mxcubecore.HardwareObjects.abstract.AbstractCollect.BeamlineConfig(synchrotron_name, directory_prefix, default_exposure_time, minimum_exposure_time, detector_fileext, detector_type, detector_manufacturer, detector_model, detector_px, detector_py, detector_binning_mode, undulators, focusing_optic, monochromator_type, beam_divergence_vertical, beam_divergence_horizontal, polarisation, input_files_server)#

Bases: tuple

beam_divergence_horizontal#: Alias for field number 15

beam_divergence_vertical#: Alias for field number 14

default_exposure_time#: Alias for field number 2

detector_binning_mode#: Alias for field number 10

detector_fileext#: Alias for field number 4

detector_manufacturer#: Alias for field number 6

detector_model#: Alias for field number 7

detector_px#: Alias for field number 8

detector_py#: Alias for field number 9

detector_type#: Alias for field number 5

directory_prefix#: Alias for field number 1

focusing_optic#: Alias for field number 12

input_files_server#: Alias for field number 17

minimum_exposure_time#: Alias for field number 3

monochromator_type#: Alias for field number 13

polarisation#: Alias for field number 16

synchrotron_name#: Alias for field number 0

undulators#: Alias for field number 11