accml.core.utils package

Subpackages

• accml.core.utils.ophyd_async package
  • Submodules
  • accml.core.utils.ophyd_async.diff_channel module
    • DiffChannel
      • DiffChannel.set()
      • DiffChannel.stage()
      • DiffChannel.unstage()
    • NotInitalisedReferenceValue
  • accml.core.utils.ophyd_async.multiplexer_for_settable_devices module
    • MultiplexerProxy
      • MultiplexerProxy.connect()
      • MultiplexerProxy.stop()
  • accml.core.utils.ophyd_async.new_value module
    • aenumerate()
    • wait_for_new_value()
  • accml.core.utils.ophyd_async.pv_positioner_like_utils module
  • Module contents

Submodules

accml.core.utils.basic_measurement_execution_engine module

class accml.core.utils.basic_measurement_execution_engine.BasicMeasurementExecutionEngine(*, backend, cmd_rewriter, storage, expected_view_for_output, num_readings)

Bases: MeasurementExecutionEngine

Common functionality of the measurement execution engine

Parameters:

• backend (BackendRW)

• cmd_rewriter (CommandRewriterBase)

• storage (StorageInterface)

• expected_view_for_output (str)

• num_readings (int)

async execute(commands_collection, detectors, *, md, **kwargs)

The commands collections is missing Context i.e. in which view it is operating.

Return type:

str

Parameters:

• commands_collection (Sequence[TransactionCommand])

• detectors (Sequence[ReadCommand])

Todo

evaluate if a set / read method should be provided as separate methods

get_data(uuid)

get_expected_view_for_output()

Return type:

str

async set(cmds)

execute these commands together

Parameters:

cmds (Sequence[Command])

async trigger_read(rcmds)

Return type:

ReadTogether

Parameters:

rcmds (Sequence[ReadCommand])

Todo

review handling context or view:

• design / device

Can commands be only converted once?

command rewriter: separate function for read commands? i.e. a delegation to liaison manager

accml.core.utils.basic_measurement_execution_engine.convert_data(cmd_rewriter, detectors, data)

Here only command rewritter is used. As always the same command is used one could just look up the translation object once and then do batch processing.

Early optimisation …

Return type:

Sequence[ReadTogether]

Parameters:

• cmd_rewriter (CommandRewriterBase)

• detectors (Sequence[ReadCommand])

• data (Sequence[Mapping[str, object]])

accml.core.utils.basic_measurement_execution_engine.convert_data_seq(*, cmd_rewriter, detectors, data, output_view, backend_view)

Return type:

Sequence[SingleReading]

Parameters:

• cmd_rewriter (CommandRewriterBase)

• detectors (Sequence[ReadCommand])

• data (Sequence[SingleReading])

• output_view (str)

• backend_view (str)

Todo

merge with convert_data

accml.core.utils.basic_measurement_execution_engine.convert_read_commands(*, cmd_rewriter, commands, output_view, backend_view)

Parameters:

• cmd_rewriter (CommandRewriterBase)

• commands (Sequence[ReadCommand])

• output_view (str)

• backend_view (str)

accml.core.utils.basic_measurement_execution_engine.convert_set_commands(*, cmd_rewriter, commands, output_view, backend_view)

Parameters:

• cmd_rewriter (CommandRewriterBase)

• commands (Sequence[Command])

• output_view (str)

• backend_view (str)

accml.core.utils.basic_measurement_execution_engine.convert_transaction_commands_design_to_device(cmd_rewriter, transaction)

Return type:

Sequence[Command]

Parameters:

• cmd_rewriter (CommandRewriterBase)

• transaction (Sequence[Command])

Warning

not tested code

accml.core.utils.basic_measurement_execution_engine.convert_transaction_commands_device_to_design(cmd_rewriter, transaction)

Return type:

Sequence[Command]

Parameters:

• cmd_rewriter (CommandRewriterBase)

• transaction (Sequence[Command])

async accml.core.utils.basic_measurement_execution_engine.execute(backend, detectors, commands, num_readings)

Return type:

Sequence[ReadTogether]

Parameters:

• backend (BackendRW)

• detectors (Sequence[ReadCommand])

• commands (Sequence[TransactionCommand])

• num_readings (int)

async accml.core.utils.basic_measurement_execution_engine.execute_step(backend, detectors, transaction_commands, num_readings)

Handle transactional commands

Return type:

Sequence[ReadTogether]

Parameters:

• backend (BackendRW)

• detectors (Sequence[ReadCommand])

• transaction_commands (Sequence[Command])

• num_readings (int)

async accml.core.utils.basic_measurement_execution_engine.read(backend, detectors)

Return type:

Sequence[Any]

Parameters:

• backend (BackendRW)

• detectors (Sequence[ReadCommand])

async accml.core.utils.basic_measurement_execution_engine.read_and_encapsulate(backend, detectors)

put data into a ReadToGether envelope

Return type:

ReadTogether

Parameters:

• backend (BackendRW)

• detectors (Sequence[ReadCommand])

async accml.core.utils.basic_measurement_execution_engine.set_(backend, transaction_commands)

Return type:

None

Parameters:

• backend (BackendRW)

• transaction_commands (Sequence[Command])

async accml.core.utils.basic_measurement_execution_engine.trigger(backend, detectors)

Return type:

None

Parameters:

• backend (BackendRW)

• detectors (Sequence[ReadCommand])

accml.core.utils.simple_storage module

class accml.core.utils.simple_storage.SimpleDataStorage

Bases: StorageInterface

add(data)

return identifier for the object stored

Return type:

str

clear()

get(uuid)

Parameters:

uuid (str)

keys()

Module contents