queue_model_objects Module

This module contains objects that combined make up the data model. Any object that inherhits from TaskNode can be added to and handled by the QueueModel.

class HardwareObjects.queue_model_objects_v1.Acquisition

Bases: object

get_preview_image_paths()

Returns the full paths, including the filename, to preview/thumbnail images stored in the archive directory.

Parameters:acquisition (Acquisition) – The acqusition object to generate paths for.
Returns:The full paths.
Return type:str
class HardwareObjects.queue_model_objects_v1.AcquisitionParameters

Bases: object

class HardwareObjects.queue_model_objects_v1.CentredPosition(motor_dict=None)

Bases: object

Class that represents a centred position. Can also be initialized with a mxcube motor dict which simply is a dictonary with the motornames and their corresponding values.

as_dict()
class HardwareObjects.queue_model_objects_v1.Characterisation(ref_data_collection=None, characterisation_parameters=None, name='')

Bases: HardwareObjects.queue_model_objects_v1.TaskNode

get_files_to_be_written()
get_name()
get_path_template()
class HardwareObjects.queue_model_objects_v1.CharacterisationParameters

Bases: object

as_dict()
class HardwareObjects.queue_model_objects_v1.Crystal

Bases: object

class HardwareObjects.queue_model_objects_v1.DataCollection(acquisition_list=None, crystal=None, processing_parameters=None, name='')

Bases: HardwareObjects.queue_model_objects_v1.TaskNode

Adds the child node <child>. Raises the exception TypeError if child is not of type TaskNode.

Moves the child (reparents it) if it already has a parent.

Parameters:
  • parent (TaskNode) – Parent TaskNode object.
  • acquisition_list (list) – List of Acquisition objects.
  • processing_paremeters – Parameters used by autoproessing software.
Crystal :

Crystal object

Returns:

None

Return type:

None

as_dict()
get_files_to_be_written()
get_name()
get_path_template()
is_collected()
set_collected(collected)
class HardwareObjects.queue_model_objects_v1.EnergyScan(sample=None, path_template=None)

Bases: HardwareObjects.queue_model_objects_v1.TaskNode

get_path_template()
get_prefix()
get_run_number()
class HardwareObjects.queue_model_objects_v1.EnergyScanResult

Bases: object

class HardwareObjects.queue_model_objects_v1.PathTemplate

Bases: object

get_archive_directory()

Returns the archive directory, for longer term storage.

Returns:Archive directory.
Return type:str
get_files_to_be_written()
get_image_file_name(suffix=None)
get_image_path()
get_prefix()
is_part_of(path_template)
class HardwareObjects.queue_model_objects_v1.ProcessingParameters
get_cell_str()
class HardwareObjects.queue_model_objects_v1.RootNode

Bases: HardwareObjects.queue_model_objects_v1.TaskNode

class HardwareObjects.queue_model_objects_v1.Sample

Bases: HardwareObjects.queue_model_objects_v1.TaskNode

get_display_name()
get_name()
has_lims_data()
init_from_lims_object(lims_sample)
init_from_sc_sample(sc_sample)
class HardwareObjects.queue_model_objects_v1.SampleCentring

Bases: HardwareObjects.queue_model_objects_v1.TaskNode

get_name()
get_task()
set_task(task_node)
class HardwareObjects.queue_model_objects_v1.TaskGroup

Bases: HardwareObjects.queue_model_objects_v1.TaskNode

class HardwareObjects.queue_model_objects_v1.TaskNode

Bases: object

Objects that inherit TaskNode can be added to and handled by the QueueModel object.

get_children()
Returns:The children of this node.
Return type:List of TaskNode objects.
get_files_to_be_written()
get_full_name()
get_name()
get_next_number_for_name(name)
get_parent()
Returns:The parent of this node.
Return type:TaskNode
get_path_template()
get_root()
is_enabled()
Returns:True if enabled and False if disabled
is_executed()
set_enabled(state)

Sets the enabled state, True represents enabled (executable) and false disabled (not executable).

Parameters:state (bool) – The state, True or False
set_executed(executed)
set_name(name)

Sets the name.

Parameters:name (str) – The new name.
Returns:none
set_number(number)

Sets the number of this node. The number can be used to give the task a unique number when for instance, the name is not unique for this node.

Parameters:number (int) – number
class HardwareObjects.queue_model_objects_v1.Workflow

Bases: HardwareObjects.queue_model_objects_v1.TaskNode

get_path_template()
get_type()
set_type(workflow_type)
HardwareObjects.queue_model_objects_v1.dc_from_edna_output(edna_result, reference_image_collection, dcg_model, sample_data_model, session_hwobj, char_params=None)
HardwareObjects.queue_model_objects_v1.to_collect_dict(data_collection, session)

return [{‘comment’: ‘’, ‘helical’: 0, ‘motors’: {}, ‘take_snapshots’: False, ‘fileinfo’: {‘directory’: ‘/data/id14eh4/inhouse/opid144/’ + ‘20120808/RAW_DATA’,

‘prefix’: ‘opid144’, ‘run_number’: 1, ‘process_directory’: ‘/data/id14eh4/inhouse/’ + ‘opid144/20120808/PROCESSED_DATA’},

‘in_queue’: 0, ‘detector_mode’: 2, ‘shutterless’: 0, ‘sessionId’: 32368, ‘do_inducedraddam’: False, ‘sample_reference’: {}, ‘processing’: ‘False’, ‘residues’: ‘’, ‘dark’: True, ‘scan4d’: 0, ‘input_files’: 1, ‘oscillation_sequence’: [{‘exposure_time’: 1.0,

‘kappaStart’: 0.0, ‘phiStart’: 0.0, ‘start_image_number’: 1, ‘number_of_images’: 1, ‘overlap’: 0.0, ‘start’: 0.0, ‘range’: 1.0, ‘number_of_passes’: 1}],

‘nb_sum_images’: 0, ‘EDNA_files_dir’: ‘’, ‘anomalous’: ‘False’, ‘file_exists’: 0, ‘experiment_type’: ‘SAD’, ‘skip_images’: 0}]

Project Versions

Previous topic

queue_model_enumerables_v1 Module

Next topic

Example Files

This Page