mxcubecore.HardwareObjects.Beamline#
Beamline class serving as singleton container for links to top-level HardwareObjects
All HardwareObjects
Classes
|
Beamline class serving as singleton container for links to HardwareObjects |
- class mxcubecore.HardwareObjects.Beamline.Beamline(name)[source]#
Bases:
ConfiguredObjectBeamline class serving as singleton container for links to HardwareObjects
- property all_roles#
Tuple of all content object roles, indefinition and loading order
- Returns:
tuple[text_str, …]
- property authenticator#
Authenticator Hardware object
- Return type:
Optional[AbstractAuthenticator]
- property beam#
Beam Hardware object
- Return type:
Optional[AbstractBeam]
- property beam_realign#
Beam-realign procedure object
- Return type:
Optional[AbstractProcedure]
- property beamline_actions#
Beamline Actions
- Return type:
Optional[beamline_actions]
- property centring#
Centring procedures object. Includes X-ray, n-click, optical, move_to_beam
- Return type:
Optional[AbstractCentring]
- property characterisation#
EDNA characterisation and analysis procedure.
NB the current code looks rather EDNA-specific to be called ‘AbsatractCharacterisation’. Potentially we could generalise it, and maybe make it into a procedure???
- Return type:
Optional[EdnaCharacterisation]
- property collect#
Data collection procedure.
- Return type:
Optional[AbstractCollect]
- property control#
Beamline control system
- Return type:
Optional[Control]
- property cryo#
Cryo Hardware object
- Return type:
Optional[AbstractActuator]
- property detector#
Detector Hardware object
- Return type:
Optional[AbstractDetector]
- property diffractometer#
Diffractometer Hardware object
- Return type:
Optional[AbstractDiffractometer]
- emit(signal: str | object | Any, *args) None[source]#
Emit signal. Accepts both multiple args and a single tuple of args.
This is needed for communication from the GUI to the core (jsonparamsgui in mxcubeqt)
NBNB TODO HACK This is a duplicate of the same function in HardwareObjectMixin. Since the Beamline is not a CommandContainer or a normal HardwareObject it may not be appropriate to make it a subclass of HardwareObjectYaml We need to consider how we want this organised
- property energy#
Energy Hardware object
- Return type:
Optional[AbstractEnergy]
- property energy_scan#
Energy scan procedure.
- Return type:
Optional[AbstractProcedure]
- property fast_shutter#
Fast Shutter Hardware object
- Return type:
Optional[AbstractShutter]
- property flux#
Flux Hardware object
- Return type:
Optional[AbstractActuator]
- get_default_acquisition_parameters(acquisition_type='default')[source]#
- Returns:
A AcquisitionParameters object with all default parameters for the specified acquisition type. “default” is a standard acqquisition
- get_hardware_object(_id: str) HardwareObject | None[source]#
Returns the HardwareObject with the given id
- Parameters:
_id (str) – “attribute path” / id of HardwareObject
- Returns:
HardwareObject with the given id
- Return type:
HardwareObject | None
- get_id(ho: HardwareObject) str[source]#
Returns “dotted path/attribute” which is unique within the context of HardwareRepository
- Parameters:
ho (HardwareObject) – The hardware object for which to get the id
- Returns:
“dotted path/attribute”
- Return type:
- property gphl_connection#
Global PHasing workflow remote connection
- Return type:
Optional[GphlWorkflowConnection]
- property gphl_workflow#
Global phasing data collection workflow procedure.
- Return type:
Optional[GphlWorkflow]
- property harvester#
Harvester Hardware object can be a sample or plate holder
- Return type:
Optional[AbstractHarvester]
- property harvester_maintenance#
harvester maintenance Hardware object
- Return type:
Optional[Harvester]
- property hutch_interlock#
Hutch Interlock Hardware object
- Return type:
Optional[AbstractInterlock]
- property image_tracking#
Imaging tracking object
- Return type:
Optional[HardwareObject]
- property imaging#
Imaging procedure.
- Return type:
Optional[AbstractProcedure]
- property lims#
LIMS client object.
- Return type:
Optional[ISPyBClient]
- property machine_info#
Machine information Hardware object
- Return type:
Optional[AbstractMachineInfo]
- property manual_centring#
Manual centring Procedure
NB AbstractManualCentring serves to define the parameters for manual centring The actual implementation is set by configuration, and can be given as an AbstractManualCentring subclass on each beamline
- Returns:
Optional[AbstractManualCentring]
- property offline_processing#
Asynchronous (queue sumbission) data processing procedure.
- Return type:
Optional[AbstractProcessing]
- property online_processing#
Synchronous (on-line) data processing procedure.
- Return type:
Optional[AbstractProcessing]
- property plate_manipulator#
DEPRECATED Plate Manipulator Hardware object NBNB TODO REMOVE THIS From qt version usage and and call HWR.beamline.sample_changer instead as plate_manipulator being treated as an alternative sample changer.
- Return type:
Optional[AbstractSampleChanger]
- property queue_manager#
Queue manager object.
- Return type:
Optional[QueueManager]
- property queue_model#
Queue model object.
- Return type:
Optional[QueueModel]
- property resolution#
Resolution Hardware object
- Return type:
Optional[AbstractActuator]
- property safety_shutter#
Safety Shutter Hardware object
- Return type:
Optional[AbstractShutter]
- property sample_changer#
Sample Changer Hardware object can be a sample changer, plate_manipulator, jets, chips
- Return type:
Optional[AbstractSampleChanger]
- property sample_changer_maintenance#
Sample Changer Maintnance Hardware object
- Return type:
Optional[AbstractMaintnanceSampleChanger]
- property sample_environment#
Sample Environment Hardware Object
- Return type:
Optional[AbstractSampleEnvironment]
- property sample_view#
Sample view object. Includes defined shapes.
- Return type:
Optional[AbstractSampleView]
- property session#
Session Hardware object, holding information on current session and user.
- Return type:
Optional[Session]
- property transmission#
Transmission Hardware object
- Return type:
Optional[AbstractTransmission]
- property xml_rpc_server#
XMLRPCServer for RPC
- Return type:
Optional[XMLRPCServer]
- property xray_centring#
Xray Ccntring hardware object.
- Return type:
Optional[XrayCentring2]
- property xrf_spectrum#
X-ray fluorescence spectrum procedure.
- Returns:
Optional[AbstractProcedure]