MX Beamline Automation tasks#

How to use

These tasks come from bes. It can be installed with

pip install bes

ℹ️ These tasks are used at the following ESRF beamlines: BM07, ID23-1, ID23-2, ID30A-1, ID30A-3, ID30B

autoMesh#

Identifier:
bes.actors.autoMesh.run
Task type:
ppfmethod
Inputs:
beamline*
icat_beamline*
workflowParameters*
raw_directory*
run_number*
proposal
isHorizontalRotationAxis
pyarch_html_dir
dataCollectionGroupComment
numberOfPositions
mesh_beam_diameter
mxcubeParameters
doTwoMeshes
workflow_index
loopMinWidth
loopMaxWidth
besParameters
investigationId
simulated_data_dir
sample
workflow_note
Outputs:
return_value

besTestExecution#

Identifier:
bes.actors.besTestExecution.run
Task type:
ppfmethod
Inputs:
callBackHost
callBackPort
sleep
Outputs:
return_value

best3d_characterisation_mxv1#

Identifier:
bes.actors.best3d_characterisation_mxv1.run
Task type:
ppfmethod
Inputs:
beamline*
mxv1StrategyResultFile*
directory*
run_number*
expTypePrefix*
prefix*
suffix*
flux*
beamSizeX*
beamSizeY*
workflow_working_dir*
list_node_id*
workflowParameters*
sampleInfo
transmission
resolution
omegaMin
apertureSize
minExposureTime
pyarch_html_dir
strategyOption
anomalousData
crystalSizeX
crystalSizeY
crystalSizeZ
aimedCompleteness
aimedMultiplicity
sampleSusceptibility
forcedSpaceGroup
characterisationComment
doseLimit
rFriedel
complexity
aimedIOverSigmaAtHighestResolution
mxcubeParameters
Outputs:
return_value

burnStrategyNoReferenceImages#

Identifier:
bes.actors.burnStrategyNoReferenceImages.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
characterisationOscillationRange*
characterisationExposureTime*
characterisationTransmission*
resolution
automatic_mode
collection_software
mxcubeParameters
Outputs:
return_value

burn_strategy_display_results#

Identifier:
bes.actors.burn_strategy_display_results.run
Task type:
ppfmethod
Inputs:
beamline*
proposal*
raw_directory*
besParameters*
workflowParameters*
result_rdfit_htmlPage
result_rdfit_jsonPath
result_rdfit_scaleIntensityPlot
pyarch_html_dir
list_node_id
mxcubeParameters
result_rdfit_list_first_path_image
workflow_note
Outputs:
return_value

calibrateKappa#

Identifier:
bes.actors.calibrateKappa.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
isHorizontalRotationAxis
mxcubeParameters
Outputs:
return_value

centreBeam#

Identifier:
bes.actors.centreBeam.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
Outputs:
return_value

centrePin#

Identifier:
bes.actors.centrePin.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
isHorizontalRotationAxis
mxcubeParameters
Outputs:
return_value

centreRotationAxis_move180Degrees#

Identifier:
bes.actors.centreRotationAxis_move180Degrees.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
run_number*
newMotorPositions*
savedMotorPositions*
isHorizontalRotationAxis*
mxcubeParameters
Outputs:
return_value

centreRotationAxis_moveToNewAxisPosition#

Identifier:
bes.actors.centreRotationAxis_moveToNewAxisPosition.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
newMotorPositions*
motorInitialPositions*
grid_info*
phiy_scan1*
phiz_scan1*
run_number*
meshPositionFiles*
isHorizontalRotationAxis*
diffractionSignalDetection
mxcubeParameters
Outputs:
return_value

centreRotationAxis_prepareFirst1Dscan#

Identifier:
bes.actors.centreRotationAxis_prepareFirst1Dscan.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
raw_directory*
process_directory*
run_number*
prefix*
suffix*
gridExposureTime*
gridOscillationRange*
lineScanLength*
lineScanOverSampling*
gridTransmission
mxcubeParameters
meshPositionsAcquired
centre_beam_before_scans
Outputs:
return_value

characterisationCheckDataCollection#

Identifier:
bes.actors.characterisationCheckDataCollection.run
Task type:
ppfmethod
Inputs:
inputFile*
workingDirectory*
beamline
proposal
logFile
Outputs:
return_value

characterisationCompare#

Identifier:
bes.actors.characterisationCompare.run
Task type:
ppfmethod
Inputs:
outputFile*
indexingOutput*
Outputs:
return_value

characterisationEdna2Indexing#

Identifier:
bes.actors.characterisationEdna2Indexing.run
Task type:
ppfmethod
Inputs:
indexingInput*
workingDirectory*
Outputs:
return_value

characterisationError#

Identifier:
bes.actors.characterisationError.run
Task type:
ppfmethod
Inputs:
outputFile*
logFile
Outputs:
return_value

characterisationPrepareEdna2#

Identifier:
bes.actors.characterisationPrepareEdna2.run
Task type:
ppfmethod
Inputs:
inputFile*
Outputs:
return_value

checkDistlServer#

Identifier:
bes.actors.checkDistlServer.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
mxcubeParameters
Outputs:
return_value

checkMoveOfPhi#

Identifier:
bes.actors.checkMoveOfPhi.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
mxcubeParameters
Outputs:
return_value

checkMoveToNewKappaAngles#

Identifier:
bes.actors.checkMoveToNewKappaAngles.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
phi*
kappa*
kappa_phi*
newPhi*
newKappa*
newKappa_phi*
mxcubeParameters
Outputs:
return_value

checkMoveToNewSamplePosition#

Identifier:
bes.actors.checkMoveToNewSamplePosition.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
sampx*
sampy*
phiy*
newSampx*
newSampy*
newPhiy*
mxcubeParameters
Outputs:
return_value

chipx_collect#

Identifier:
bes.actors.chipx_collect.run
Task type:
ppfmethod
Inputs:
beamline*
prefix*
run_number*
exposureTime*
oscillationWidth*
workflowParameters*
transmission*
resolution*
raw_directory*
sample_node_id*
no_lines
mxcubeParameters
Outputs:
return_value

chipx_collect_dialog#

Identifier:
bes.actors.chipx_collect_dialog.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
collection_software*
workflowParameters*
transmission
no_lines
exposureTime
oscillationWidth
resolution
mxcubeParameters
Outputs:
return_value

chipx_collect_sections_dialog#

Identifier:
bes.actors.chipx_collect_sections_dialog.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
collection_software*
workflowParameters*
transmission
no_lines
exposureTime
resolution
mxcubeParameters
Outputs:
return_value

chipx_left_position#

Identifier:
bes.actors.chipx_left_position.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
raw_directory*
mxcubeParameters*
Outputs:
return_value

chipx_right_position#

Identifier:
bes.actors.chipx_right_position.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
raw_directory*
mxcubeParameters*
Outputs:
return_value

collectAndSpectraUserInput#

Identifier:
bes.actors.collectAndSpectraUserInput.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
motorPositions*
collection_software
mxcubeParameters
Outputs:
return_value

collect_centreSamplePos#

Identifier:
bes.actors.collect_centreSamplePos.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
sampleInfo*
mxcubeParameters
Outputs:
return_value

collect_centreSamplePos1#

Identifier:
bes.actors.collect_centreSamplePos1.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
sampleInfo*
mxcubeParameters
Outputs:
return_value

collect_centreSamplePos2#

Identifier:
bes.actors.collect_centreSamplePos2.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
sampleInfo*
mxcubeParameters
Outputs:
return_value

collect_start#

Identifier:
bes.actors.collect_start.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
raw_directory*
process_directory*
beamParameters*
prefix*
expTypePrefix*
run_number*
mxv1StrategyResultFile*
motorPositions*
suffix*
workflowParameters*
workflow_index*
sampleInfo
resolution
mxv1ResultCharacterisationFile
cellSpaceGroup
autoMeshPhiPosition
mxcubeParameters
fineSlicedReferenceImages
characterisation_id
position_id
besParameters
fast_characterisation
Outputs:
return_value

commonPrepareDehydration#

Identifier:
bes.actors.commonPrepareDehydration.run
Task type:
ppfmethod
Inputs:
beamline*
Outputs:
return_value

commonPrepareEnhancedCharacterisation#

Identifier:
bes.actors.commonPrepareEnhancedCharacterisation.run
Task type:
ppfmethod
Inputs:
beamline*
Outputs:
return_value

commonPrepareLowDoseDC#

Identifier:
bes.actors.commonPrepareLowDoseDC.run
Task type:
ppfmethod
Inputs:
beamline*
Outputs:
return_value

commonPrepareTestBest3DCharacterisation#

Identifier:
bes.actors.commonPrepareTestBest3DCharacterisation.run
Task type:
ppfmethod
Inputs:
beamline*
Outputs:
return_value

common_default_parameters#

Identifier:
bes.actors.common_default_parameters.run
Task type:
ppfmethod
Inputs:
directory*
prefix*
run_number*
beamline*
motorPositions*
workflowParameters*
expTypePrefix
suffix
characterisationExposureTime
gridExposureTime
collectExposureTime
transmission
gridTransmission
collectTransmission
characterisationTransmission
doRefDataCollectionReview
plateMode
gridSnapShots
lineScanLength
fineSlicedReferenceImages
process_partial_data_sets
characterisation_id
position_id
mxcubeParameters
fast_characterisation
take_snapshots_before_mesh
Outputs:
return_value

common_prepare_MXPressF_twoMeshes#

Identifier:
bes.actors.common_prepare_MXPressF_twoMeshes.run
Task type:
ppfmethod
Inputs:
beamline*
expTypePrefix
Outputs:
return_value

common_prepare_burn_strategy#

Identifier:
bes.actors.common_prepare_burn_strategy.run
Task type:
ppfmethod
Inputs:
beamline*
Outputs:
return_value

common_prepare_centreBeam#

Identifier:
bes.actors.common_prepare_centreBeam.run
Task type:
ppfmethod
Inputs:
beamline
Outputs:
return_value

common_prepare_chipx_collect#

Identifier:
bes.actors.common_prepare_chipx_collect.run
Task type:
ppfmethod
Inputs:
beamline*
Outputs:
return_value

common_prepare_chipx_collect_sections#

Identifier:
bes.actors.common_prepare_chipx_collect_sections.run
Task type:
ppfmethod
Inputs:
beamline*
Outputs:
return_value

common_prepare_chipx_left_position#

Identifier:
bes.actors.common_prepare_chipx_left_position.run
Task type:
ppfmethod
Inputs:
beamline*
Outputs:
return_value

common_prepare_chipx_right_position#

Identifier:
bes.actors.common_prepare_chipx_right_position.run
Task type:
ppfmethod
Inputs:
beamline*
Outputs:
return_value

common_prepare_distanceCalibration#

Identifier:
bes.actors.common_prepare_distanceCalibration.run
Task type:
ppfmethod
Inputs:
beamline
Outputs:
return_value

common_prepare_energyInterleavedMAD#

Identifier:
bes.actors.common_prepare_energyInterleavedMAD.run
Task type:
ppfmethod
Inputs:
beamline
Outputs:
return_value

common_prepare_helical_characterisation#

Identifier:
bes.actors.common_prepare_helical_characterisation.run
Task type:
ppfmethod
Inputs:
beamline*
Outputs:
return_value

common_prepare_kappa#

Identifier:
bes.actors.common_prepare_kappa.run
Task type:
ppfmethod
Inputs:
beamline*
Outputs:
return_value

common_prepare_mesh1D#

Identifier:
bes.actors.common_prepare_mesh1D.run
Task type:
ppfmethod
Inputs:
beamline*
expTypePrefix
Outputs:
return_value

common_prepare_mesh2D#

Identifier:
bes.actors.common_prepare_mesh2D.run
Task type:
ppfmethod
Inputs:
beamline*
expTypePrefix
Outputs:
return_value

common_prepare_mesh2D_auto#

Identifier:
bes.actors.common_prepare_mesh2D_auto.run
Task type:
ppfmethod
Inputs:
beamline*
expTypePrefix
Outputs:
return_value

common_prepare_mesh_and_burn#

Identifier:
bes.actors.common_prepare_mesh_and_burn.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
Outputs:
return_value

common_prepare_mesh_and_collect#

Identifier:
bes.actors.common_prepare_mesh_and_collect.run
Task type:
ppfmethod
Inputs:
beamline*
expTypePrefix
Outputs:
return_value

common_prepare_mesh_and_collect_from_file#

Identifier:
bes.actors.common_prepare_mesh_and_collect_from_file.run
Task type:
ppfmethod
Inputs:
beamline*
expTypePrefix
Outputs:
return_value

common_prepare_mesh_ice_rings#

Identifier:
bes.actors.common_prepare_mesh_ice_rings.run
Task type:
ppfmethod
Inputs:
beamline*
expTypePrefix
Outputs:
return_value

common_prepare_meshbest3d#

Identifier:
bes.actors.common_prepare_meshbest3d.run
Task type:
ppfmethod
Inputs:
beamline*
expTypePrefix
Outputs:
return_value

common_prepare_mxpress_setup#

Identifier:
bes.actors.common_prepare_mxpress_setup.run
Task type:
ppfmethod
Inputs:
directory*
beamline*
Outputs:
return_value

common_prepare_mxpressa#

Identifier:
bes.actors.common_prepare_mxpressa.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
Outputs:
return_value

common_prepare_mxpressa_3500Gy#

Identifier:
bes.actors.common_prepare_mxpressa_3500Gy.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
Outputs:
return_value

common_prepare_mxpressa_aperture_100um#

Identifier:
bes.actors.common_prepare_mxpressa_aperture_100um.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
Outputs:
return_value

common_prepare_mxpressa_aperture_10um#

Identifier:
bes.actors.common_prepare_mxpressa_aperture_10um.run
Task type:
ppfmethod
Inputs:
beamline*
Outputs:
return_value

common_prepare_mxpressa_aperture_15um#

Identifier:
bes.actors.common_prepare_mxpressa_aperture_15um.run
Task type:
ppfmethod
Inputs:
beamline*
Outputs:
return_value

common_prepare_mxpressa_aperture_30um#

Identifier:
bes.actors.common_prepare_mxpressa_aperture_30um.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
Outputs:
return_value

common_prepare_mxpressa_aperture_50um#

Identifier:
bes.actors.common_prepare_mxpressa_aperture_50um.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
Outputs:
return_value

common_prepare_mxpressa_dozor#

Identifier:
bes.actors.common_prepare_mxpressa_dozor.run
Task type:
ppfmethod
Inputs:
beamline*
Outputs:
return_value

common_prepare_mxpressa_dozorm#

Identifier:
bes.actors.common_prepare_mxpressa_dozorm.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
Outputs:
return_value

common_prepare_mxpressa_htx#

Identifier:
bes.actors.common_prepare_mxpressa_htx.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
Outputs:
return_value

common_prepare_mxpressa_meshBest#

Identifier:
bes.actors.common_prepare_mxpressa_meshBest.run
Task type:
ppfmethod
Inputs:
beamline*
Outputs:
return_value

common_prepare_mxpresse#

Identifier:
bes.actors.common_prepare_mxpresse.run
Task type:
ppfmethod
Inputs:
beamline*
expTypePrefix
Outputs:
return_value

common_prepare_mxpresse_red#

Identifier:
bes.actors.common_prepare_mxpresse_red.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
expTypePrefix
Outputs:
return_value

common_prepare_mxpresse_sad#

Identifier:
bes.actors.common_prepare_mxpresse_sad.run
Task type:
ppfmethod
Inputs:
beamline*
expTypePrefix
Outputs:
return_value

common_prepare_mxpressemulti#

Identifier:
bes.actors.common_prepare_mxpressemulti.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
Outputs:
return_value

common_prepare_mxpressf#

Identifier:
bes.actors.common_prepare_mxpressf.run
Task type:
ppfmethod
Inputs:
beamline*
expTypePrefix
Outputs:
return_value

common_prepare_mxpressg#

Identifier:
bes.actors.common_prepare_mxpressg.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
Outputs:
return_value

common_prepare_mxpressg_advanced#

Identifier:
bes.actors.common_prepare_mxpressg_advanced.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
Outputs:
return_value

common_prepare_mxpressg_basic#

Identifier:
bes.actors.common_prepare_mxpressg_basic.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
Outputs:
return_value

common_prepare_mxpressg_minimal#

Identifier:
bes.actors.common_prepare_mxpressg_minimal.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
Outputs:
return_value

common_prepare_mxpressi#

Identifier:
bes.actors.common_prepare_mxpressi.run
Task type:
ppfmethod
Inputs:
beamline*
expTypePrefix
Outputs:
return_value

common_prepare_mxpressk#

Identifier:
bes.actors.common_prepare_mxpressk.run
Task type:
ppfmethod
Inputs:
beamline*
expTypePrefix
Outputs:
return_value

common_prepare_mxpressl#

Identifier:
bes.actors.common_prepare_mxpressl.run
Task type:
ppfmethod
Inputs:
beamline*
expTypePrefix
Outputs:
return_value

common_prepare_mxpressm#

Identifier:
bes.actors.common_prepare_mxpressm.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
grid_info
expTypePrefix
Outputs:
return_value

common_prepare_mxpresso#

Identifier:
bes.actors.common_prepare_mxpresso.run
Task type:
ppfmethod
Inputs:
beamline*
expTypePrefix
Outputs:
return_value

common_prepare_mxpresso_540#

Identifier:
bes.actors.common_prepare_mxpresso_540.run
Task type:
ppfmethod
Inputs:
beamline*
expTypePrefix
Outputs:
return_value

common_prepare_mxpressp#

Identifier:
bes.actors.common_prepare_mxpressp.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
Outputs:
return_value

common_prepare_mxpressp_sad#

Identifier:
bes.actors.common_prepare_mxpressp_sad.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
Outputs:
return_value

common_prepare_mxpressr#

Identifier:
bes.actors.common_prepare_mxpressr.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
prefix*
mxcubeParameters
Outputs:
return_value

common_prepare_mxpressr_180#

Identifier:
bes.actors.common_prepare_mxpressr_180.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
prefix*
mxcubeParameters
Outputs:
return_value

common_prepare_mxpressr_180_setup#

Identifier:
bes.actors.common_prepare_mxpressr_180_setup.run
Task type:
ppfmethod
Inputs:
directory*
Outputs:
return_value

common_prepare_mxpressr_dehydration#

Identifier:
bes.actors.common_prepare_mxpressr_dehydration.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
prefix*
mxcubeParameters
Outputs:
return_value

common_prepare_mxpressr_dehydration_1min_1pc#

Identifier:
bes.actors.common_prepare_mxpressr_dehydration_1min_1pc.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
prefix*
mxcubeParameters
Outputs:
return_value

common_prepare_mxpressr_dehydration_2min_1pc#

Identifier:
bes.actors.common_prepare_mxpressr_dehydration_2min_1pc.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
prefix*
mxcubeParameters
Outputs:
return_value

common_prepare_mxpressr_dehydration_2min_5pc#

Identifier:
bes.actors.common_prepare_mxpressr_dehydration_2min_5pc.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
prefix*
mxcubeParameters
Outputs:
return_value

common_prepare_mxpressr_dehydration_5min_5pc#

Identifier:
bes.actors.common_prepare_mxpressr_dehydration_5min_5pc.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
prefix*
mxcubeParameters
Outputs:
return_value

common_prepare_mxpressr_dehydration_setup#

Identifier:
bes.actors.common_prepare_mxpressr_dehydration_setup.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
prefix*
mxcubeParameters
Outputs:
return_value

common_prepare_mxpressr_setup#

Identifier:
bes.actors.common_prepare_mxpressr_setup.run
Task type:
ppfmethod
Inputs:
directory*
Outputs:
return_value

common_prepare_mxpresss#

Identifier:
bes.actors.common_prepare_mxpresss.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
Outputs:
return_value

common_prepare_mxscore#

Identifier:
bes.actors.common_prepare_mxscore.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
grid_info
expTypePrefix
Outputs:
return_value

common_prepare_radiation_damage#

Identifier:
bes.actors.common_prepare_radiation_damage.run
Task type:
ppfmethod
Inputs:
beamline*
Outputs:
return_value

common_prepare_serial_data_collection#

Identifier:
bes.actors.common_prepare_serial_data_collection.run
Task type:
ppfmethod
Inputs:
beamline*
expTypePrefix
Outputs:
return_value

common_prepare_smallXrayCentring#

Identifier:
bes.actors.common_prepare_smallXrayCentring.run
Task type:
ppfmethod
Inputs:
beamline*
besParameters
workflow_parameters
expTypePrefix
Outputs:
return_value

common_prepare_testAutoInsitu#

Identifier:
bes.actors.common_prepare_testAutoInsitu.run
Task type:
ppfmethod
Inputs:
beamline
Outputs:
return_value

common_prepare_testAutoMesh#

Identifier:
bes.actors.common_prepare_testAutoMesh.run
Task type:
ppfmethod
Inputs:
beamline*
Outputs:
return_value

common_prepare_testCentreRotationAxis#

Identifier:
bes.actors.common_prepare_testCentreRotationAxis.run
Task type:
ppfmethod
Inputs:
beamline*
Outputs:
return_value

common_prepare_testCentreRotationAxis_totalIntensity#

Identifier:
bes.actors.common_prepare_testCentreRotationAxis_totalIntensity.run
Task type:
ppfmethod
Inputs:
beamline*
Outputs:
return_value

common_prepare_testCollectAndSpectra#

Identifier:
bes.actors.common_prepare_testCollectAndSpectra.run
Task type:
ppfmethod
Inputs:
beamline
Outputs:
return_value

common_prepare_testInterleavedMad#

Identifier:
bes.actors.common_prepare_testInterleavedMad.run
Task type:
ppfmethod
Inputs:
beamline
Outputs:
return_value

common_prepare_testInversedLineScan#

Identifier:
bes.actors.common_prepare_testInversedLineScan.run
Task type:
ppfmethod
Inputs:
beamline*
Outputs:
return_value

common_prepare_threeMeshScans#

Identifier:
bes.actors.common_prepare_threeMeshScans.run
Task type:
ppfmethod
Inputs:
beamline*
expTypePrefix
Outputs:
return_value

common_prepare_time_resolved_mesh#

Identifier:
bes.actors.common_prepare_time_resolved_mesh.run
Task type:
ppfmethod
Inputs:
beamline*
Outputs:
return_value

common_prepare_twoMeshScans#

Identifier:
bes.actors.common_prepare_twoMeshScans.run
Task type:
ppfmethod
Inputs:
beamline*
expTypePrefix
Outputs:
return_value

common_prepare_vertcial_line_scan#

Identifier:
bes.actors.common_prepare_vertcial_line_scan.run
Task type:
ppfmethod
Inputs:
beamline*
expTypePrefix
Outputs:
return_value

common_prepare_visual_kappa#

Identifier:
bes.actors.common_prepare_visual_kappa.run
Task type:
ppfmethod
Inputs:
beamline*
Outputs:
return_value

common_prepare_xrayCentring#

Identifier:
bes.actors.common_prepare_xrayCentring.run
Task type:
ppfmethod
Inputs:
beamline*
expTypePrefix
Outputs:
return_value

common_prepare_xrayCentringAndCharacterisation#

Identifier:
bes.actors.common_prepare_xrayCentringAndCharacterisation.run
Task type:
ppfmethod
Inputs:
beamline*
expTypePrefix
Outputs:
return_value

common_prepare_xrayCentring_auto#

Identifier:
bes.actors.common_prepare_xrayCentring_auto.run
Task type:
ppfmethod
Inputs:
beamline*
expTypePrefix
Outputs:
return_value

common_workflow_finished_message#

Identifier:
bes.actors.common_workflow_finished_message.run
Task type:
ppfmethod
Inputs:
message_text
Outputs:
return_value

correctID30A1phiy#

Identifier:
bes.actors.correctID30A1phiy.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
motorPositions*
mxcubeParameters
Outputs:
return_value

createLucidBackgroundImage#

Identifier:
bes.actors.createLucidBackgroundImage.run
Task type:
ppfmethod
Inputs:
directory*
mxcubeParameters
Outputs:
return_value

createThumbnailsForPyarch#

Identifier:
bes.actors.createThumbnailsForPyarch.run
Task type:
ppfmethod
Inputs:
image_path*
jpeg_path*
jpeg_thumbnail_path*
Outputs:
return_value

crystfel#

Identifier:
bes.actors.crystfel.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
meshPositionFile*
run_number*
expTypePrefix*
workflow_working_dir*
prefix*
suffix*
grid_info*
data_threshold*
data_collection_max_positions*
radius*
list_node_id
firstImagePath
pyarch_html_dir
diffractionSignalDetection
resultMeshPath
mxcubeParameters
Outputs:
return_value

dehydrationAskIfContinue#

Identifier:
bes.actors.dehydrationAskIfContinue.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
continue_dehydration*
doDataCollection*
automatic_mode*
collection_software
transmission
mxcubeParameters
snapShots
characterisationExposureTime
no_reference_images
angle_between_reference_images
Outputs:
return_value

dehydrationAutomaticCarryOn#

Identifier:
bes.actors.dehydrationAutomaticCarryOn.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
currentRH*
endRH*
step*
steppingSign*
automatic_mode*
mxcubeParameters
Outputs:
return_value

dehydrationCarryOn#

Identifier:
bes.actors.dehydrationCarryOn.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
currentRH*
endRH*
step*
steppingSign*
automatic_mode*
mxcubeParameters
Outputs:
return_value

dehydrationDefaultValues#

Identifier:
bes.actors.dehydrationDefaultValues.run
Task type:
ppfmethod
Inputs:
beamline*
Outputs:
return_value

dehydrationDefineGradient#

Identifier:
bes.actors.dehydrationDefineGradient.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
characterisationExposureTime*
characterisationTransmission*
automaticMode
mxcubeParameters
collection_software
Outputs:
return_value

dehydrationImageAnalysis#

Identifier:
bes.actors.dehydrationImageAnalysis.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
dehydrationResults*
list_node_id*
mxv1StrategyResultFile*
directory*
run_number*
expTypePrefix*
prefix*
suffix*
startTime*
currentRH*
targetRH*
continue_dehydration*
diffractionSignalDetection
firstListDehydrationNodeId
transmission
firstDehydrationLoop
pyarch_html_dir
mxcubeParameters
firstImagePath
Outputs:
return_value

dehydrationInitLoop#

Identifier:
bes.actors.dehydrationInitLoop.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
startRH*
endRH*
delay*
motorPositions*
bestPositionFound
pyarch_html_dir
mxcubeParameters
Outputs:
return_value

dehydrationNextStep#

Identifier:
bes.actors.dehydrationNextStep.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
targetRH*
steppingSign*
step*
doDataCollection*
run_number*
delay*
phi_start*
mxcubeParameters
Outputs:
return_value

dehydrationSetStartRH#

Identifier:
bes.actors.dehydrationSetStartRH.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
startRH
delay
mxcubeParameters
Outputs:
return_value

displayErrorMessage#

Identifier:
bes.actors.displayErrorMessage.run
Task type:
ppfmethod
Inputs:
beamline
directory
workflowParameters
errorMessage
message_text
automatic_mode
collection_software
mxcubeParameters
Outputs:
return_value

distanceCalibrationDataCollections#

Identifier:
bes.actors.distanceCalibrationDataCollections.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
raw_directory*
process_directory*
dataCollectionOscillationRange*
prefix*
expTypePrefix*
run_number*
suffix*
csvOfResolutions*
collectExposureTime*
transmission*
motorPositions*
workflow_type*
workflow_index*
workflow_working_dir*
sample_node_id
mxcubeParameters
Outputs:
return_value

distanceCalibrationUserInput#

Identifier:
bes.actors.distanceCalibrationUserInput.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
motorPositions*
prefix*
collection_software
mxcubeParameters
Outputs:
return_value

eEDNACheckResults#

Identifier:
bes.actors.eEDNACheckResults.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
run_number*
mxv1ResultCharacterisationFile*
doRefDataCollectionReview*
lowResolution*
highResolution*
resolution
newDataCollection
mxcubeParameters
runGphlWorkflow
edna_characterisation_success
Outputs:
return_value

eEDNANoReferenceImages#

Identifier:
bes.actors.eEDNANoReferenceImages.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
characterisationOscillationRange*
characterisationExposureTime*
characterisationTransmission*
automatic_mode
resolution
collection_software
mxcubeParameters
Outputs:
return_value

ednaCharacterisation#

Identifier:
bes.actors.ednaCharacterisation.run
Task type:
ppfmethod
Inputs:
inputFile*
outputFile*
workingDirectory*
logFile
ednaStartScript
pluginName
timeout
Outputs:
return_value

ednaPluginLauncher#

Identifier:
bes.actors.ednaPluginLauncher.run
Task type:
ppfmethod
Inputs:
inputFile*
outputFile*
workingDirectory*
pluginName*
debug
timeout
Outputs:
return_value

edna_characterisation_mxv1#

Identifier:
bes.actors.edna_characterisation_mxv1.run
Task type:
ppfmethod
Inputs:
beamline*
proposal*
mxv1StrategyResultFile*
directory*
run_number*
expTypePrefix*
prefix*
suffix*
flux*
beamSizeX*
beamSizeY*
workflow_type*
workflow_working_dir*
list_node_id*
workflowParameters*
sampleInfo
characterisationTransmission
resolution
pyarch_html_dir
strategyOption
anomalousData
crystalSizeX
crystalSizeY
crystalSizeZ
aimedCompleteness
aimedMultiplicity
sampleSusceptibility
minExposureTime
forcedSpaceGroup
minOscWidth
fineSlicedReferenceImages
aimedIOverSigmaAtHighestResolution
characterisationOscillationRange
do_data_collect
do_data_collect_orig
diffractionSignalDetection
doseLimit
misalignedCrystalDetected
axisStart
axisRange
runGphlWorkflow
mxcubeParameters
strategyType
characterisation_id
position_id
simulated_characterisation_results
besParameters
workflow_index
workflow_note
investigationId
Outputs:
return_value

edna_characterisation_mxv2#

Identifier:
bes.actors.edna_characterisation_mxv2.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
mxv1StrategyResultFile*
directory*
run_number*
expTypePrefix*
prefix*
suffix*
motorPositions*
flux*
beamSizeX*
beamSizeY*
kappaStrategyOption*
workflow_working_dir*
characterisationTransmission
pyarch_html_dir
list_node_id
forcedSpaceGroup
resolution
sampleInfo
characterisationComment
diffractionSignalDetection
anomalousData
mxcubeParameters
Outputs:
return_value

edna_pseudo_helical_characterisation_mxv1#

Identifier:
bes.actors.edna_pseudo_helical_characterisation_mxv1.run
Task type:
ppfmethod
Inputs:
beamline*
proposal*
mxv1CharacterisationStrategyResultFile*
directory*
run_number*
expTypePrefix*
prefix*
suffix*
flux*
beamSizeX*
beamSizeY*
workflow_type*
workflow_working_dir*
list_node_id*
workflowParameters*
bestPosition*
characterisation_images*
characterisation_raw_directory*
sampleInfo
characterisationTransmission
resolution
pyarch_html_dir
strategyOption
anomalousData
crystalSizeX
crystalSizeY
crystalSizeZ
aimedCompleteness
aimedMultiplicity
sampleSusceptibility
minExposureTime
forcedSpaceGroup
minOscWidth
aimedIOverSigmaAtHighestResolution
do_data_collect
do_data_collect_orig
diffractionSignalDetection
misalignedCrystalDetected
remainingPositions
mxcubeParameters
characterisation_id
position_id
simulated_characterisation_results
besParameters
workflow_note
investigationId
Outputs:
return_value

executeDozor2XrayCentring#

Identifier:
bes.actors.executeDozor2XrayCentring.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
grid_info*
workflowParameters*
workflow_working_dir*
resultMeshPath
mxcubeParameters
Outputs:
return_value

executeGphlWorkflow#

Identifier:
bes.actors.executeGphlWorkflow.run
Task type:
ppfmethod
Inputs:
beamline*
proposal*
workflowParameters*
besParameters*
prefix*
suffix*
raw_directory*
workflow_type*
sampleInfo*
workflow_node_id*
spot_xds_path*
resolution*
gphl_strategy_variant
mxcubeParameters
characterisation_id
position_id
sample_name
group_by
strategy_resolution
Outputs:
return_value

executeMeshCalculateBestPosition#

Identifier:
bes.actors.executeMeshCalculateBestPosition.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
proposal*
meshPositionFile*
run_number*
workflow_working_dir*
grid_info*
firstImagePath*
workflowParameters*
weakDiffractionWarning
meshUpperThreshold
diffractionSignalDetection
numberOfPositions
moreSamples
remainingPositions
dozorThreshold
mxcubeParameters
dozorAllFile
meshZigZag
dozorm2BeamSize
multiPositionIndex
isHorizontalRotationAxis
reject_level
position_id
simulated_grid_positions
doTwoMeshes
workflow_note
investigationId
besParameters
largeBeam
Outputs:
return_value

executeMeshUploadToISPyBNew#

Identifier:
bes.actors.executeMeshUploadToISPyBNew.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
meshPositionFile*
run_number*
expTypePrefix*
workflow_working_dir*
prefix*
suffix*
firstImagePath*
workflowParameters*
mxcubeParameters
Outputs:
return_value

executeTestGphlWorkflow#

Identifier:
bes.actors.executeTestGphlWorkflow.run
Task type:
ppfmethod
Inputs:
beamline*
proposal*
workflowParameters*
besParameters*
prefix*
suffix*
directory*
raw_directory*
motorPositions*
workflow_type*
sampleInfo*
workflow_node_id*
resolution
gphl_strategy_variant
mxcubeParameters
characterisation_id
position_id
sample_name
group_by
Outputs:
return_value

executeTimeResolvedMesh#

Identifier:
bes.actors.executeTimeResolvedMesh.run
Task type:
ppfmethod
Inputs:
beamline*
prefix*
workflowParameters*
sampleInfo
directory
process_directory
run_number
mxcubeParameters
Outputs:
return_value

execute_mesh_and_collect_start_mesh#

Identifier:
bes.actors.execute_mesh_and_collect_start_mesh.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
workflow_index*
workflow_type*
grid_info*
meshQueueListFile*
motorPositions*
directory*
meshPositionFile*
workflow_working_dir*
group_node_id
sample_node_id
resolution
force_not_shutterless
mxcubeParameters
highResolution
lowResolution
characterisation_id
position_id
besParameters
workflow_note
Outputs:
return_value

execute_mesh_create_thumbnails#

Identifier:
bes.actors.execute_mesh_create_thumbnails.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
meshPositionFile*
grid_info*
workflow_working_dir*
bestPosition*
allPositionFile*
run_number*
expTypePrefix*
prefix*
suffix*
firstImagePath*
dict_html_pyarch*
pyarch_html_dir
list_node_id
mxcubeParameters
Outputs:
return_value

execute_mesh_find_all_positions_upload_ispyb#

Identifier:
bes.actors.execute_mesh_find_all_positions_upload_ispyb.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
proposal*
meshPositionFile*
run_number*
expTypePrefix*
workflow_working_dir*
prefix*
suffix*
grid_info*
data_threshold*
data_collection_max_positions*
radius*
shape
list_node_id
firstImagePath
pyarch_html_dir
diffractionSignalDetection
resultMeshPath
mxcubeParameters
meshZigZag
dozorAllFile
isHorizontalRotationAxis
reject_level
doDialsFindSpots
besParameters
workflow_note
largeBeam
Outputs:
return_value

execute_mesh_processData#

Identifier:
bes.actors.execute_mesh_processData.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
run_number*
meshPositions*
workflow_working_dir*
grid_info*
mxcubeParameters
Outputs:
return_value

execute_mesh_redo_find_all_positions#

Identifier:
bes.actors.execute_mesh_redo_find_all_positions.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
meshPositionFile*
run_number*
expTypePrefix*
workflow_working_dir*
grid_info*
data_threshold*
data_collection_max_positions*
data_collection_max_positions_orig*
timeToReachHendersonLimit*
data_collection_no_images*
radius*
list_node_id
diffractionSignalDetection
pyarch_html_dir
mxcubeParameters
dozormListPositions
isHorizontalRotationAxis
dozormCrystalMapPath
dozormImageNumberMapPath
Outputs:
return_value

execute_mesh_startDataCollection#

Identifier:
bes.actors.execute_mesh_startDataCollection.run
Task type:
ppfmethod
Outputs:
return_value

execute_mesh_waitTillDataCollectionFinish#

Identifier:
bes.actors.execute_mesh_waitTillDataCollectionFinish.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
meshPositions*
run_number*
expTypePrefix*
workflow_working_dir*
prefix*
suffix*
grid_info*
firstImagePath*
pyarch_html_dir
list_node_id
mxcubeParameters
Outputs:
return_value

execute_serial_data_dollection#

Identifier:
bes.actors.execute_serial_data_dollection.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
workflow_index*
workflow_type*
grid_info*
meshQueueList*
phiz*
directory*
meshPositions*
workflow_working_dir*
group_node_id
sample_node_id
resolution
mxcubeParameters
Outputs:
return_value

extISPyBStatusError#

Identifier:
bes.actors.extISPyBStatusError.run
Task type:
ppfmethod
Inputs:
workflowParameters*
mxcubeParameters
Outputs:
return_value

extractBeamlineFromDirectory#

Identifier:
bes.actors.extractBeamlineFromDirectory.run
Task type:
ppfmethod
Inputs:
directory*
run_number*
beamline
Outputs:
return_value

extractBestMeshPosition#

Identifier:
bes.actors.extractBestMeshPosition.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
bestPosition
mxcubeParameters
Outputs:
return_value

getHelicalGridData#

Identifier:
bes.actors.getHelicalGridData.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
shape
mxcubeParameters
Outputs:
return_value

get_MS_data_collection_strategy#

Identifier:
bes.actors.get_MS_data_collection_strategy.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
beamParameters*
run_number*
mxv1StrategyResultFile*
workflowParameters*
characterisationTransmission*
mxcubeParameters
Outputs:
return_value

gridResultsToMXCuBE#

Identifier:
bes.actors.gridResultsToMXCuBE.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
proposal*
meshPositionFile*
run_number*
expTypePrefix*
workflow_working_dir*
grid_info*
firstImagePath*
bestPosition*
workflowParameters*
list_node_id
pyarch_html_dir
titleMeshHtmlPage
meshHtmlDirectoryName
diffractionSignalDetection
shape
remainingPositions
workflowStepType
dozormListPositions
mxcubeParameters
dozormCrystalMapPath
dozormColourMapPath
dozormImageNumberMapPath
besParameters
workflow_note
Outputs:
return_value

helicalCharacterisationUserInput#

Identifier:
bes.actors.helicalCharacterisationUserInput.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
characterisationOscillationRange*
characterisationExposureTime*
transmission*
characterisationTransmission*
automatic_mode
resolution
collection_software
mxcubeParameters
Outputs:
return_value

helical_characterisation_best_parameter#

Identifier:
bes.actors.helical_characterisation_best_parameter.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
run_number*
helicalDistance*
dataCollectionType
susceptibility
mxcubeParameters
Outputs:
return_value

helical_characterisation_centre_position#

Identifier:
bes.actors.helical_characterisation_centre_position.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
sampx1*
sampy1*
phiy1*
phiz1*
sampx2*
sampy2*
phiy2*
phiz2*
mxcubeParameters
Outputs:
return_value

helical_characterisation_data_collection#

Identifier:
bes.actors.helical_characterisation_data_collection.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
mxv1StrategyResultFile*
sampx1*
sampy1*
phiy1*
phiz1*
sampx2*
sampy2*
phiy2*
phiz2*
noPositions*
dataCollectionType
mxcubeParameters
Outputs:
return_value

initDimple#

Identifier:
bes.actors.initDimple.run
Task type:
ppfmethod
Outputs:
return_value

initExtISPyB#

Identifier:
bes.actors.initExtISPyB.run
Task type:
ppfmethod
Inputs:
projectId*
runId*
extispyb*
token*
workflowType
version
Outputs:
return_value

initReprocess#

Identifier:
bes.actors.initReprocess.run
Task type:
ppfmethod
Outputs:
return_value

init_workflow#

Identifier:
bes.actors.init_workflow.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
prefix*
workflow_title
workflow_type
workflow_id
workflowParameters
sample
sample_name
sample_lims_id
sample_node_id
mxcubeParameters
besParameters
investigationId
Outputs:
return_value

insituGetBarcodeFromPath#

Identifier:
bes.actors.insituGetBarcodeFromPath.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
workflowParameters*
mxcubeParameters
Outputs:
return_value

interleavedMadDataCollections#

Identifier:
bes.actors.interleavedMadDataCollections.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
raw_directory*
process_directory*
prefix*
expTypePrefix*
run_number*
osc_range*
noDegreesPerWedge*
numberOfImages*
motorPositions*
collectExposureTime*
transmission*
energy1*
energy2*
energy3*
energy4*
workflow_type*
workflow_index*
sample_node_id
isInverseBeam
mxcubeParameters
Outputs:
return_value

interleavedMadDefaultParameters#

Identifier:
bes.actors.interleavedMadDefaultParameters.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
energy
mxcubeParameters
Outputs:
return_value

interleavedMadUserInput#

Identifier:
bes.actors.interleavedMadUserInput.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
osc_range
numberOfImages
noDegreesPerWedge
energy1
energy2
energy3
energy4
collection_software
mxcubeParameters
Outputs:
return_value

ispyb_calculate_image_quality_indicators#

Identifier:
bes.actors.ispyb_calculate_image_quality_indicators.run
Task type:
ppfmethod
Inputs:
beamline*
mxv1StrategyResult*
directory*
run_number*
expTypePrefix*
prefix*
suffix*
workflow_working_dir*
Outputs:
return_value

ispyb_retrieve_flux_beamsize#

Identifier:
bes.actors.ispyb_retrieve_flux_beamsize.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
run_number*
mxcubeParameters*
Outputs:
return_value

ispyb_set_status_failure#

Identifier:
bes.actors.ispyb_set_status_failure.run
Task type:
ppfmethod
Inputs:
beamline
directory
workflowParameters
message_text
errorMessage
done_error_report
mxcubeParameters
Outputs:
return_value

ispyb_set_status_success#

Identifier:
bes.actors.ispyb_set_status_success.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
workflow_working_dir*
message_text
mxcubeParameters
end_workflow_in_mxcube
Outputs:
return_value

ispyb_set_status_success_with_errors#

Identifier:
bes.actors.ispyb_set_status_success_with_errors.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
workflow_working_dir*
message_text
end_workflow_in_mxcube
mxcubeParameters
Outputs:
return_value

kappaReorientationNewKappaStrategyUserInput#

Identifier:
bes.actors.kappaReorientationNewKappaStrategyUserInput.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
automatic_mode
collection_software
mxcubeParameters
Outputs:
return_value

kappaReorientationUserInput#

Identifier:
bes.actors.kappaReorientationUserInput.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
characterisationOscillationRange*
characterisationExposureTime*
transmission*
automatic_mode
resolution
collection_software
mxcubeParameters
Outputs:
return_value

kappaStrategyIncomaptibleMessage#

Identifier:
bes.actors.kappaStrategyIncomaptibleMessage.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
spaceGroup*
automatic_mode
collection_software
mxcubeParameters
Outputs:
return_value

kappa_set_new_angles#

Identifier:
bes.actors.kappa_set_new_angles.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
newKappa*
newKappa_phi*
newPhi*
mxcubeParameters
Outputs:
return_value

loadMxCuBEQueue#

Identifier:
bes.actors.loadMxCuBEQueue.run
Task type:
ppfmethod
Inputs:
beamline*
proposal*
workflowParameters*
directory*
run_number*
raw_directory*
process_directory*
prefix*
expTypePrefix*
mxv1StrategyResultFile*
motorPositions*
sampleInfo
firstImagePath
resolution
mxv1ResultCharacterisationFile
forcedSpaceGroup
do_data_collect
createNewDataCollectionGroup
suffix
highResolution
lowResolution
mxcubeParameters
collection_software
workflow_index
characterisation_id
position_id
process_partial_data_sets
list_partial_data_sets
moreSamples
doPseudoHelical
doOpenKappa
besParameters
multiPositionIndex
workflow_note
investigationId
collection_beam_diameter
Outputs:
return_value

logger_report_abort#

Identifier:
bes.actors.logger_report_abort.run
Task type:
ppfmethod
Inputs:
beamline
message_text
Outputs:
return_value

logger_report_error#

Identifier:
bes.actors.logger_report_error.run
Task type:
ppfmethod
Inputs:
workflowParameters
message_text
beamline
WorkflowException
mxcubeParameters
Outputs:
return_value

lowDoseCharacterisationOKInput#

Identifier:
bes.actors.lowDoseCharacterisationOKInput.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
collection_software
mxcubeParameters
Outputs:
return_value

lowDoseDCInput#

Identifier:
bes.actors.lowDoseDCInput.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
osc_range*
characterisationExposureTime*
transmission*
automatic_mode
resolution
collection_software
mxcubeParameters
Outputs:
return_value

lowDoseDCRedoInput#

Identifier:
bes.actors.lowDoseDCRedoInput.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
characterisationInputFile*
collection_software
mxcubeParameters
Outputs:
return_value

lowDoseMoveMotors#

Identifier:
bes.actors.lowDoseMoveMotors.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
workflowParameters*
deltaKappa*
deltaPhi*
noDCPositions*
mxcubeParameters
Outputs:
return_value

massif1PrepareEEDNA#

Identifier:
bes.actors.massif1PrepareEEDNA.run
Task type:
ppfmethod
Inputs:
beamline*
do_data_collect
Outputs:
return_value

massif1PrepareEEDNA_SAD#

Identifier:
bes.actors.massif1PrepareEEDNA_SAD.run
Task type:
ppfmethod
Outputs:
return_value

massif1PrepareMXScore#

Identifier:
bes.actors.massif1PrepareMXScore.run
Task type:
ppfmethod
Outputs:
return_value

massif2_prepare_180_degree_collect#

Identifier:
bes.actors.massif2_prepare_180_degree_collect.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
motorPositions*
flux*
mxcubeParameters
Outputs:
return_value

massif2_prepare_360_degree_collect#

Identifier:
bes.actors.massif2_prepare_360_degree_collect.run
Task type:
ppfmethod
Inputs:
beamline*
phi*
flux*
mxcubeParameters
Outputs:
return_value

massif2_retrieve_flux#

Identifier:
bes.actors.massif2_retrieve_flux.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
run_number*
expTypePrefix*
prefix*
suffix*
workflow_working_dir*
transmission
firstImagePath
mxcubeParameters
Outputs:
return_value

meshAndBurnDialog#

Identifier:
bes.actors.meshAndBurnDialog.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
workflowParameters*
transmission*
gridSnapShots*
collection_software
mxcubeParameters
resolution
data_collection_osc_range
data_collection_exposure_time
data_collection_no_images
Outputs:
return_value

mesh_and_collect_characterisation#

Identifier:
bes.actors.mesh_and_collect_characterisation.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
allPositionFile*
transmission*
aimedIOverSigmaAtHighestResolution
flux
beamSizeAtSampleX
beamSizeAtSampleY
resolution
crystalSizeX
crystalSizeY
crystalSizeZ
dozorVisibleResolution
data_collection_no_images
mxcubeParameters
Outputs:
return_value

mesh_and_collect_choose_mesh_results#

Identifier:
bes.actors.mesh_and_collect_choose_mesh_results.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
workflowParameters*
raw_directory
collection_software
mxcubeParameters
sample_name
Outputs:
return_value

mesh_and_collect_load_mxcube_queue#

Identifier:
bes.actors.mesh_and_collect_load_mxcube_queue.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
raw_directory*
process_directory*
prefix*
expTypePrefix*
run_number*
allPositionFile*
motorPositions*
workflow_type*
workflow_index*
data_collection_exposure_time*
transmission*
data_collection_no_images*
data_collection_osc_range*
data_collection_max_positions*
data_collection_start_phi
sampleInfo
resolution
inverseBeam
data_collection_iterations
grenades_fastproc
grenades_parallelproc
EDNA_proc
XIA2_DIALS
autoPROC
XDSAPP
mxcubeParameters
adaptiveAperture
listSnapShotFileName
characterisation_id
position_id
besParameters
Outputs:
return_value

mesh_and_collect_user_input#

Identifier:
bes.actors.mesh_and_collect_user_input.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
data_collection_exposure_time*
data_collection_osc_range*
data_collection_no_images*
data_collection_max_positions*
transmission*
radius*
aimedIOverSigmaAtHighestResolution
redo_find_positions
data_threshold
resolution
timeToReachHendersonLimit
flux
diffractionSignalDetection
collection_software
mxcubeParameters
automatic_mode
Outputs:
return_value

mesh_no_images_error#

Identifier:
bes.actors.mesh_no_images_error.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
message_text
firstImagePath
mxcubeParameters
Outputs:
return_value

mesh_no_position_error#

Identifier:
bes.actors.mesh_no_position_error.run
Task type:
ppfmethod
Inputs:
beamline*
proposal*
directory*
workflowParameters*
firstImagePath*
collection_software*
besParameters
mxcubeParameters
automatic_mode
dozorm2ExecutionError
investigationId
Outputs:
return_value

meshbest3d_input#

Identifier:
bes.actors.meshbest3d_input.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
workflowParameters*
osc_range*
gridExposureTime*
transmission*
plateMode*
gridSnapShots*
collection_software
mxcubeParameters
indexMesh2d
Outputs:
return_value

meshbest3d_moveToAngle1#

Identifier:
bes.actors.meshbest3d_moveToAngle1.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
run_number*
currentPhi*
angleRelative1*
mxcubeParameters
Outputs:
return_value

meshbest3d_moveToAngle2#

Identifier:
bes.actors.meshbest3d_moveToAngle2.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
run_number*
currentPhi*
angleRelative2*
mxcubeParameters
Outputs:
return_value

meshbest3d_moveToStartPosition#

Identifier:
bes.actors.meshbest3d_moveToStartPosition.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
motorInitialPositions*
mxcubeParameters
Outputs:
return_value

meshbest3d_prepareNextMesh2d#

Identifier:
bes.actors.meshbest3d_prepareNextMesh2d.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
indexMesh2d*
run_number*
newPhi
noMesh2d
mxcubeParameters
meshResultsJsonPath
Outputs:
return_value

moveOmega#

Identifier:
bes.actors.moveOmega.run
Task type:
ppfmethod
Inputs:
beamline*
raw_directory*
workflowParameters*
directory*
process_directory*
expTypePrefix*
prefix*
suffix*
grid_info*
gridOscillationRange*
gridExposureTime*
transmission*
run_number*
deltaOmega*
motorInitialPositions*
dozorAllFile
useFastMesh
meshZigZag
multi_wedge
mxcubeParameters
workflow_index
Outputs:
return_value

move_to_new_sample_position#

Identifier:
bes.actors.move_to_new_sample_position.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
newMotorPositions*
workflowParameters*
mxcubeParameters
Outputs:
return_value

move_to_start_sample_position#

Identifier:
bes.actors.move_to_start_sample_position.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
motorInitialPositions*
mxcubeParameters
Outputs:
return_value

mxPressContactUser#

Identifier:
bes.actors.mxPressContactUser.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
raw_directory*
sessionId
mxcubeParameters
Outputs:
return_value

mxpressCheckSymmetry#

Identifier:
bes.actors.mxpressCheckSymmetry.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
firstImagePath
cellSpaceGroup
forcedSpaceGroup
workflowParameters
resolution
mxcubeParameters
sampleInfo
openKappaForLowSymmetry
process_partial_data_sets
Outputs:
return_value

mxpressDiffPlanChoice#

Identifier:
bes.actors.mxpressDiffPlanChoice.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
proposal*
workflowParameters*
besParameters
sampleInfo
dataCollectionGroupComment
numberOfPositions
do_data_collect
doCharacterisation
anomalousData
do2DMeshOnly
doOnlyEDNAResolution
diffractionSignalDetection
findLargestMesh
aimedCompleteness
aimedMultiplicity
aimedResolution
observedResolution
dataCollectionResolution
minOscWidth
sampleSusceptibility
moreSamples
mesh_beam_diameter
collection_beam_diameter
doAutoMesh
aimedIOverSigmaAtHighestResolution
doPseudoHelical
mxcubeParameters
dozorThreshold
strategyOption
axisRange
doFbest
openKappaForLowSymmetry
runGphlWorkflow
doTwoMeshes
deltaOmega
synchronizeBestPosition
doDialsFindSpots
take_snapshots_before_mesh
workflow_note
investigationId
Outputs:
return_value

mxpressKappaSetAperture#

Identifier:
bes.actors.mxpressKappaSetAperture.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters
mxcubeParameters
newBeamSize
smallGridApertureSize
Outputs:
return_value

mxpressMoveKappaToZero#

Identifier:
bes.actors.mxpressMoveKappaToZero.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
workflowParameters
mxcubeParameters
Outputs:
return_value

mxpressMoveToNextPosition#

Identifier:
bes.actors.mxpressMoveToNextPosition.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
remainingPositions*
workflowParameters*
motorPositions*
multiPositionIndex
mxcubeParameters
position_id
autoMeshApertureSize
Outputs:
return_value

mxpressOpenKappa#

Identifier:
bes.actors.mxpressOpenKappa.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
workflowParameters
mxcubeParameters
newBeamSize
Outputs:
return_value

mxpress_setup_dialog#

Identifier:
bes.actors.mxpress_setup_dialog.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
workflowParameters*
collection_software
mxcubeParameters
Outputs:
return_value

mxpressr_180_setup_dialog#

Identifier:
bes.actors.mxpressr_180_setup_dialog.run
Task type:
ppfmethod
Inputs:
beamline*
targetFlux*
aimedResolution*
preferredApertureName*
workflowParameters*
directory*
numberOfPositions*
mxpressoOscRange*
mxpressoNoImages*
gridTransmission*
gridSize*
gridSteps*
diffractionSignalDetection*
forcedSpaceGroup*
collection_software
mxcubeParameters
take_snapshots_before_mesh
Outputs:
return_value

mxpressr_dehydration_setup_dialog#

Identifier:
bes.actors.mxpressr_dehydration_setup_dialog.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
collection_software*
startRH*
endRH*
step*
delay*
aimedResolution*
transmission*
no_reference_images*
angle_between_reference_images*
snapShots*
workflowParameters*
mxcubeParameters
Outputs:
return_value

mxpressr_setup_dialog#

Identifier:
bes.actors.mxpressr_setup_dialog.run
Task type:
ppfmethod
Inputs:
beamline*
aimedResolution*
preferredApertureName*
workflowParameters*
directory*
numberOfPositions*
gridTransmission*
aimedMultiplicity*
aimedCompleteness*
diffractionSignalDetection*
forcedSpaceGroup*
collection_software
mxcubeParameters
take_snapshots_before_mesh
Outputs:
return_value

ppfPort#

Identifier:
bes.actors.ppfPort.run
Task type:
ppfmethod
Outputs:
return_value

prepareCalibrateKappa#

Identifier:
bes.actors.prepareCalibrateKappa.run
Task type:
ppfmethod
Inputs:
directory
beamline
Outputs:
return_value

prepareCentrePin#

Identifier:
bes.actors.prepareCentrePin.run
Task type:
ppfmethod
Inputs:
directory
beamline
Outputs:
return_value

prepareCollectWithResolution#

Identifier:
bes.actors.prepareCollectWithResolution.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
motorPositions*
flux*
mxv1ResultCharacterisationFile*
highResolution
lowResolution
flux100
mxpressoNoImages
mxpressoOscRange
anomalousData
axisRange
firstImagePath
mxcubeParameters
Outputs:
return_value

prepareDefaultLinescanSettings#

Identifier:
bes.actors.prepareDefaultLinescanSettings.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
workflowParameters*
gridOscillationRange*
gridExposureTime*
transmission*
plateMode*
gridSnapShots*
lineScanLength*
lineScanOverSampling*
lowResolution*
highResolution*
doLineScans
lineScanStep
beamParameters
collection_software
token
do2MeshScans
allowZeroDegreeMeshScan
doCharacterisation
characterisationOscillationRange
characterisationExposureTime
characterisationTransmission
automatic_mode
doDistlSignalStrength
Outputs:
return_value

prepareFirstTestInversedLineScan#

Identifier:
bes.actors.prepareFirstTestInversedLineScan.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
workflowParameters*
run_number*
process_directory*
prefix*
suffix*
osc_range*
gridExposureTime*
isHorizontalRotationAxis*
gridTransmission
mxcubeParameters
Outputs:
return_value

prepareFirstVerticalXrayCentring#

Identifier:
bes.actors.prepareFirstVerticalXrayCentring.run
Task type:
ppfmethod
Inputs:
beamline*
raw_directory*
workflowParameters*
run_number*
process_directory*
prefix*
suffix*
gridOscillationRange*
sampx1*
sampy1*
phiy1*
phiz1*
gridExposureTime*
beamSizeAtSampleX
beamSizeAtSampleY
gridTransmission
perform_extra_1D_scan
do2DMeshOnly
centreRotationAxis
mxcubeParameters
workflow_index
Outputs:
return_value

prepareHelicalCharacterisation#

Identifier:
bes.actors.prepareHelicalCharacterisation.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
workflowParameters*
mxcubeParameters
Outputs:
return_value

prepareMeshAndBurnDataCollections#

Identifier:
bes.actors.prepareMeshAndBurnDataCollections.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
shape*
collection_software*
motorPositions*
run_number*
prefix*
suffix*
meshZigZag
meshHorizontalSeparation
meshVerticalSeparation
mxcubeParameters
Outputs:
return_value

prepareMeshCheckExperimentSettings#

Identifier:
bes.actors.prepareMeshCheckExperimentSettings.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
workflowParameters*
gridOscillationRange*
gridExposureTime*
transmission*
plateMode*
gridSnapShots*
lineScanLength*
lineScanOverSampling*
lowResolution*
highResolution*
doLineScans
lineScanStep
beamParameters
collection_software
mxcubeParameters
do2MeshScans
allowZeroDegreeMeshScan
doCharacterisation
characterisationOscillationRange
characterisationExposureTime
characterisationTransmission
automatic_mode
doDistlSignalStrength
largeBeam
Outputs:
return_value

prepareRDExpress#

Identifier:
bes.actors.prepareRDExpress.run
Task type:
ppfmethod
Inputs:
beamline*
Outputs:
return_value

prepareRefKappaCollection#

Identifier:
bes.actors.prepareRefKappaCollection.run
Task type:
ppfmethod
Inputs:
run_number*
Outputs:
return_value

prepareSecondTestInversedLineScan#

Identifier:
bes.actors.prepareSecondTestInversedLineScan.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
workflowParameters*
run_number*
process_directory*
prefix*
suffix*
osc_range*
gridExposureTime*
motorInitialPositions*
gridTransmission
mxcubeParameters
Outputs:
return_value

prepareSecondVerticalXrayCentring#

Identifier:
bes.actors.prepareSecondVerticalXrayCentring.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
workflowParameters*
run_number*
process_directory*
prefix*
suffix*
gridOscillationRange*
sampx2*
sampy2*
phiy2*
phiz2*
gridExposureTime*
beamSizeAtSampleX
beamSizeAtSampleY
gridTransmission
mxcubeParameters
Outputs:
return_value

prepareShortVerticalXrayCentring#

Identifier:
bes.actors.prepareShortVerticalXrayCentring.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
mxcubeParameters*
newBeamSize
doTwoMeshes
mesh_beam_diameter
Outputs:
return_value

prepareSmallXrayCentring#

Identifier:
bes.actors.prepareSmallXrayCentring.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
workflowParameters
resolution
mxcubeParameters
beamSizeAtSampleX
beamSizeAtSampleY
do1DXrayCentring
isHorizontalRotationAxis
do2MeshScans
lineScanStep
lineScanLength
Outputs:
return_value

prepareTestAutoMesh#

Identifier:
bes.actors.prepareTestAutoMesh.run
Task type:
ppfmethod
Inputs:
directory
beamline
Outputs:
return_value

prepareTestGphlWorkflow#

Identifier:
bes.actors.prepareTestGphlWorkflow.run
Task type:
ppfmethod
Inputs:
directory
beamline
Outputs:
return_value

prepareTestSetGridData#

Identifier:
bes.actors.prepareTestSetGridData.run
Task type:
ppfmethod
Inputs:
directory
beamline
Outputs:
return_value

prepareTestShortVerticalLineScan#

Identifier:
bes.actors.prepareTestShortVerticalLineScan.run
Task type:
ppfmethod
Inputs:
beamline*
Outputs:
return_value

prepareTroubleShooting#

Identifier:
bes.actors.prepareTroubleShooting.run
Task type:
ppfmethod
Inputs:
directory
beamline
Outputs:
return_value

prepare_collect_without_strategy#

Identifier:
bes.actors.prepare_collect_without_strategy.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
motorPositions*
flux*
resolution*
highResolution*
mxpressoNoImages
mxpressoOscRange
collectTransmission
collectExposureTime
axisRange
minOscWidth
anomalousData
checkForFlux
targetFlux
firstImagePath
sampleInfo
dataCollectionPosition
mxcubeParameters
doFbest
wavelength
doCharacterisation
crystalSizeX
crystalSizeY
crystalSizeZ
beamSizeAtSampleX
beamSizeAtSampleY
sampleSusceptibility
dozorVisibleResolutionVertical
dozorVisibleResolutionHorizontal
dozor2m_resolution
Outputs:
return_value

prepare_mesh_autoGridPositions#

Identifier:
bes.actors.prepare_mesh_autoGridPositions.run
Task type:
ppfmethod
Inputs:
beamline*
raw_directory*
process_directory*
motorPositions*
run_number*
expTypePrefix*
gridOscillationRange*
transmission*
highResolution*
prefix*
suffix*
workflow_working_dir*
workflowParameters*
gridExposureTime*
sampleInfo
meshZigZag
grid_info
gridTransmission
allowZeroDegreeMeshScan
aimedResolution
observedResolution
workflow_index
mxcubeParameters
Outputs:
return_value

prepare_mesh_getGridPositions#

Identifier:
bes.actors.prepare_mesh_getGridPositions.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
raw_directory*
process_directory*
workflow_type*
gridOscillationRange*
motorPositions*
beamParameters*
run_number*
expTypePrefix*
prefix*
suffix*
gridExposureTime*
transmission*
useFastMesh
meshZigZag
multi_wedge
collection_software
mxcubeParameters
shape
allowZeroDegreeMeshScan
workflow_index
simulated_data_dir
Outputs:
return_value

prepare_reference_image_collect#

Identifier:
bes.actors.prepare_reference_image_collect.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
raw_directory*
characterisationExposureTime*
beamParameters*
characterisationOscillationRange*
no_reference_images*
prefix*
expTypePrefix*
suffix*
run_number*
highResolution*
motorPositions*
sampleInfo
characterisationTransmission
angle_between_reference_images
resolution
mxcubeParameters
newDataCollection
wavelength
dozorVisibleResolutionVertical
dozorVisibleResolutionHorizontal
fineSlicedReferenceImages
fast_characterisation
lowResolution
aimedResolution
workflow_index
multiPositionIndex
collection_beam_diameter
Outputs:
return_value

prepare_serial_data_collection_positions#

Identifier:
bes.actors.prepare_serial_data_collection_positions.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
process_directory*
workflow_type*
osc_range*
phi*
kappa*
kappa_phi*
sampx*
sampy*
phix*
phiy*
phiz*
run_number*
expTypePrefix*
prefix*
suffix*
gridExposureTime*
transmission*
grid_info
meshZigZag
mxcubeParameters
shape
Outputs:
return_value

processBurnDataCollection#

Identifier:
bes.actors.processBurnDataCollection.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
raw_directory*
run_number*
expTypePrefix*
prefix*
suffix*
mxv1ResultCharacterisationFile*
workflow_working_dir*
workflow_index*
mxcubeParameters
Outputs:
return_value

radiationDamageCollectAndProcess#

Identifier:
bes.actors.radiationDamageCollectAndProcess.run
Task type:
ppfmethod
Outputs:
return_value

radiationDamageDataCollectionUserInput#

Identifier:
bes.actors.radiationDamageDataCollectionUserInput.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
data_collection_no_images*
data_collection_exposure_time*
data_collection_osc_range*
transmission*
data_collection_iterations*
resolution
automatic_mode
collection_software
mxcubeParameters
Outputs:
return_value

radiationDamageTestImage#

Identifier:
bes.actors.radiationDamageTestImage.run
Task type:
ppfmethod
Outputs:
return_value

radiationDamageTestImageUserInput#

Identifier:
bes.actors.radiationDamageTestImageUserInput.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
data_collection_no_images*
data_collection_exposure_time*
data_collection_osc_range*
transmission*
data_collection_iterations*
resolution
automatic_mode
collection_software
mxcubeParameters
Outputs:
return_value

rdExpressDC#

Identifier:
bes.actors.rdExpressDC.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
raw_directory*
process_directory*
prefix*
suffix*
expTypePrefix*
run_number*
motorPositions*
noCycles*
osc_range*
noImagesPerCycle*
tLimit*
transmission*
sampleInfo*
resolution
mxcubeParameters
Outputs:
return_value

rdExpressInput#

Identifier:
bes.actors.rdExpressInput.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
automatic_mode
resolution
collection_software
mxcubeParameters
Outputs:
return_value

read_motor_positions#

Identifier:
bes.actors.read_motor_positions.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
workflowParameters*
transmission
resolution
mxcubeParameters
Outputs:
return_value

requestStatusERROR#

Identifier:
bes.actors.requestStatusERROR.run
Task type:
ppfmethod
Inputs:
besParameters
Outputs:
return_value

requestStatusFINISHED#

Identifier:
bes.actors.requestStatusFINISHED.run
Task type:
ppfmethod
Outputs:
return_value

resetShortLineScanParameter#

Identifier:
bes.actors.resetShortLineScanParameter.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
mxcubeParameters*
newBeamSize
mesh_beam_diameter
Outputs:
return_value

runDIALSFindSpots#

Identifier:
bes.actors.runDIALSFindSpots.run
Task type:
ppfmethod
Inputs:
beamline*
proposal*
workflowParameters*
directory*
grid_info*
firstImagePath*
meshZigZag*
isHorizontalRotationAxis*
phi1*
phi2*
token*
dozorAllFile1*
dozorAllFile*
motorInitialPositions*
besParameters
numberOfPositions
reject_level
investigationId
Outputs:
return_value

runDIMPLE#

Identifier:
bes.actors.runDIMPLE.run
Task type:
ppfmethod
Inputs:
pdbFile*
workflowParameters*
mtzFile
proposal
autoprocintegrationURL
autoProcAttachmentURL
downloadAutoProcProgramAttachementURL
Outputs:
return_value

runDozorm2#

Identifier:
bes.actors.runDozorm2.run
Task type:
ppfmethod
Inputs:
beamline*
proposal*
workflowParameters*
directory*
grid_info*
firstImagePath*
meshZigZag*
isHorizontalRotationAxis*
phi1*
phi2*
mxcubeParameters*
dozorAllFile1*
dozorAllFile*
motorInitialPositions*
numberOfPositions
reject_level
investigationId
besParameters
largeBeam
Outputs:
return_value

runReprocess#

Identifier:
bes.actors.runReprocess.run
Task type:
ppfmethod
Inputs:
mxcubeParameters*
workflowParameters*
dataCollectionId*
start
end
cutoff
Outputs:
return_value

saveSamplePosition#

Identifier:
bes.actors.saveSamplePosition.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
mxcubeParameters
Outputs:
return_value

selectAperture#

Identifier:
bes.actors.selectAperture.run
Task type:
ppfmethod
Inputs:
beamline*
proposal*
directory*
workflowParameters*
doCharacterisation
characterisationExposureTime
firstImagePath
collection_beam_diameter
peakSizeX
peakSizeY
peakSizeZ
besParameters
investigationId
ispybApertureComment
ispybExposureTimeComment
mxcubeParameters
doFbest
dozorm2BeamSize
multiPositionIndex
adaptiveAperture
workflow_note
largeBeam
Outputs:
return_value

setMeshBeamSize#

Identifier:
bes.actors.setMeshBeamSize.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
sample_info
mxcubeParameters
Outputs:
return_value

set_damPar_strategyOption#

Identifier:
bes.actors.set_damPar_strategyOption.run
Task type:
ppfmethod
Inputs:
beamline*
radiation_damage_beta*
radiation_damage_gamma*
Outputs:
return_value

set_expTypePrefix_to_burn#

Identifier:
bes.actors.set_expTypePrefix_to_burn.run
Task type:
ppfmethod
Outputs:
return_value

submitSLURMJob#

Identifier:
bes.actors.submitSLURMJob.run
Task type:
ppfmethod
Inputs:
beamline
dataCollectionId
ednaDpLaunchPath
launchPath
procType
numberOfImages
proposal
nodes
core
workingDirectory
queue
host
mem
time
list_modules
Outputs:
return_value

takeSnapShots#

Identifier:
bes.actors.takeSnapShots.run
Task type:
ppfmethod
Inputs:
beamline*
directory*
run_number*
prefix*
expTypePrefix
dataCollectionId
mxcubeParameters
Outputs:
return_value

testActorTimeOut#

Identifier:
bes.actors.testActorTimeOut.run
Task type:
ppfmethod
Outputs:
return_value

testBest3DInput#

Identifier:
bes.actors.testBest3DInput.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
characterisationOscillationRange*
characterisationExposureTime*
transmission*
automatic_mode
resolution
collection_software
mxcubeParameters
Outputs:
return_value

testDataEmitter#

Identifier:
bes.actors.testDataEmitter.run
Task type:
ppfmethod
Outputs:
return_value

testDataReceiver#

Identifier:
bes.actors.testDataReceiver.run
Task type:
ppfmethod
Inputs:
none*
booleanTrue*
booleanFalse*
integer1*
float1*
string1*
dictionary1*
Outputs:
return_value

testMeshBest#

Identifier:
bes.actors.testMeshBest.run
Task type:
ppfmethod
Outputs:
return_value

testSetGridData#

Identifier:
bes.actors.testSetGridData.run
Task type:
ppfmethod
Inputs:
directory*
beamline*
motorPositions*
gridOscillationRange*
run_number*
prefix*
suffix*
workflowParameters*
shape
mxcubeParameters
Outputs:
return_value

troubleShootingAllTestsOk#

Identifier:
bes.actors.troubleShootingAllTestsOk.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
mxcubeParameters
Outputs:
return_value

troubleShootingDialog#

Identifier:
bes.actors.troubleShootingDialog.run
Task type:
ppfmethod
Inputs:
beamline*
prefix*
workflowParameters*
directory
collection_software
mxcubeParameters
Outputs:
return_value

two_mesh_and_collect_user_input#

Identifier:
bes.actors.two_mesh_and_collect_user_input.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
data_collection_max_positions*
transmission*
motorPositions*
resolution
collection_software
mxcubeParameters
automatic_mode
adaptiveAperture
Outputs:
return_value

two_mesh_no_position_found#

Identifier:
bes.actors.two_mesh_no_position_found.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
collection_software*
automatic_mode
mxcubeParameters
Outputs:
return_value

uploadFilesToExtISPyB#

Identifier:
bes.actors.uploadFilesToExtISPyB.run
Task type:
ppfmethod
Inputs:
workflowParameters*
extispyb*
startDate*
projectId*
runId*
extISPyBStatus*
token*
fileList
Outputs:
return_value

uploadToCrims#

Identifier:
bes.actors.uploadToCrims.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
prefix*
dataCollectionId
dataCollectionGroupId
mxcubeParameters
Outputs:
return_value

visual_kappa_calculate_angles#

Identifier:
bes.actors.visual_kappa_calculate_angles.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
phi*
sampx1*
sampy1*
phiy1*
sampx2*
sampy2*
phiy2*
mxcubeParameters
Outputs:
return_value

visual_kappa_save_first_pos#

Identifier:
bes.actors.visual_kappa_save_first_pos.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
mxcubeParameters
Outputs:
return_value

visual_kappa_save_second_pos#

Identifier:
bes.actors.visual_kappa_save_second_pos.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
mxcubeParameters
Outputs:
return_value

visual_kappa_set_angles_zero#

Identifier:
bes.actors.visual_kappa_set_angles_zero.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
mxcubeParameters
Outputs:
return_value

visual_kappa_set_new_angles#

Identifier:
bes.actors.visual_kappa_set_new_angles.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
newKappa*
newKappa_phi*
newPhi*
newSampx
newSampy
newPhiy
mxcubeParameters
Outputs:
return_value

waitForFirstAndLastImage#

Identifier:
bes.actors.waitForFirstAndLastImage.run
Task type:
ppfmethod
Inputs:
beamline*
dataCollectionId*
doWaitForImages
Outputs:
return_value

waitSLURMRunning#

Identifier:
bes.actors.waitSLURMRunning.run
Task type:
ppfmethod
Inputs:
workingDirectory
slurmJobId
Outputs:
return_value

waitSLURMTerminated#

Identifier:
bes.actors.waitSLURMTerminated.run
Task type:
ppfmethod
Inputs:
workingDirectory
slurmJobId
Outputs:
return_value

xrayCentringCheckChangeAperture#

Identifier:
bes.actors.xrayCentringCheckChangeAperture.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
collection_software*
dozorm2BeamSize
doCharacterisation
doChangeAperture
automatic_mode
mxcubeParameters
Outputs:
return_value

xrayCentringMoveToNewSamplePosition#

Identifier:
bes.actors.xrayCentringMoveToNewSamplePosition.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
motorPositions*
newMotorPositions*
mxcubeParameters
Outputs:
return_value

xrayCentring_checkMove90Degrees#

Identifier:
bes.actors.xrayCentring_checkMove90Degrees.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
phi*
newPhi*
mxcubeParameters
Outputs:
return_value

xrayCentring_move90Degrees#

Identifier:
bes.actors.xrayCentring_move90Degrees.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
directory*
motorPositions*
run_number*
mxcubeParameters
Outputs:
return_value

xrayCentring_prepare1Dscan#

Identifier:
bes.actors.xrayCentring_prepare1Dscan.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
raw_directory*
process_directory*
run_number*
expTypePrefix*
prefix*
suffix*
motorPositions*
gridExposureTime*
gridOscillationRange*
transmission*
lineScanLength*
lineScanOverSampling*
isHorizontalRotationAxis*
workflow_index
beamSizeAtSampleX
beamSizeAtSampleY
shortLineScan
gridTransmission
allowZeroDegreeMeshScan
mxcubeParameters
lineScanStep
bestPosition
Outputs:
return_value

xrayCentring_prepareMove90Degrees#

Identifier:
bes.actors.xrayCentring_prepareMove90Degrees.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
phi*
run_number*
mxcubeParameters
Outputs:
return_value

xrayCentring_prepareShort1Dscan#

Identifier:
bes.actors.xrayCentring_prepareShort1Dscan.run
Task type:
ppfmethod
Inputs:
beamline*
workflowParameters*
raw_directory*
process_directory*
run_number*
expTypePrefix*
prefix*
suffix*
motorPositions*
gridExposureTime*
gridOscillationRange*
transmission*
grid_info*
beamSizeAtSampleX
beamSizeAtSampleY
gridTransmission
workflow_index
mxcubeParameters
Outputs:
return_value
On this page
Show Source