pooldefs

This file contains the basic pool definitions.

Constants

ControllerAPI = 1.1

A constant defining the controller API version currently supported

Enumerations

AcqSynch

Inheritance diagram of AcqSynch
class AcqSynch(value)[source]

Bases: IntEnum

Enumeration of synchronization options.

Uses software/hardware naming to refer to internal (software synchronizer) or external (hardware synchronization device) synchronization modes. See AcqSynchType to get more details about the synchronization type e.g. trigger, gate or start.

SoftwareTrigger = 0

Internal (software) trigger

../../../../_images/acqsynch_softtrig.png
HardwareTrigger = 1

External (hardware) trigger

../../../../_images/acqsynch_hardtrig.png
SoftwareGate = 2

Internal (software) gate - not implemented

HardwareGate = 3

External (hardware) gate

../../../../_images/acqsynch_hardgate.png
SoftwareStart = 4

Internal (software) start (triggers just the first acquisition)

../../../../_images/acqsynch_softstart.png
HardwareStart = 5

External (hardware) start (triggers just the first acquisition)

../../../../_images/acqsynch_hardstart.png
classmethod from_synch_type(software, synch_type)[source]

Helper obtain AcqSynch from information about software/hardware nature of synchronization element and AcqSynchType

AcqSynchType

AcqSynchType = Enumeration('AcqSynchType', ['Trigger', 'Gate', 'Start'])

Enumeration of synchronization types.

Options:

  • Trigger - Start each acquisition (experimental channel will decide on itself when to end, based on integration time / monitor count)

  • Gate - Start and end each acquisition

  • Start - Start only the first acquisition (experimental channel will drive the acquisition based on integration time / monitor count, latency time and number of repetitions)

Todo

convert to python enums, but having in mind problems with JSON serialization: https://bugs.python.org/issue18264

SynchParam

Inheritance diagram of SynchParam
class SynchParam(value)[source]

Bases: SynchEnum

Enumeration of synchronization description group parameters.

  • Delay - initial delay (relative to the synchronization start)

  • Total - total interval

  • Active - active interval (part of the total interval)

  • Repeats - number of repetitions within the group

  • Initial - initial point (absolute)

Note

The SynchParam class has been included in Sardana on a provisional basis. Backwards incompatible changes (up to and including removal of the class) may occur if deemed necessary by the core developers.

Delay = 0
Total = 1
Active = 2
Repeats = 3
Initial = 4

SynchDomain

Inheritance diagram of SynchDomain
class SynchDomain(value)[source]

Bases: SynchEnum

Enumeration of synchronization domains.

  • Time - describes the synchronization in time domain

  • Position - describes the synchronization in position domain

  • Monitor - not used at the moment but foreseen for synchronization on monitor

Note

The SynchDomain class has been included in Sardana on a provisional basis. Backwards incompatible changes (up to and including removal of the class) may occur if deemed necessary by the core developers.

Time = 0
Position = 1
Monitor = 2