poolmeasurementgroup

This module is part of the Python Pool library. It defines the base classes for

Functions

build_measurement_configuration()

Classes

PoolMeasurementGroup ConfigurationItem ControllerConfiguration

TimerableControllerConfiguration ExternalControllerConfiguration ChannelConfiguration

SynchronizerConfiguration MeasurementConfiguration

build_measurement_configuration(user_elements)

Create a minimal measurement configuration data structure from the user_elements list.

Minimal configuration data structure:

dict <str, dict> with keys:
- 'controllers' : where value is a dict<str, dict> where:
    - key: controller's full name
    - value: dict<str, dict> with keys:
        - 'channels' where value is a dict<str, obj> where:
            - key: channel's full name
            - value: dict<str, obj> with keys:
                - 'index' : where value is the channel's index <int>

Note

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

PoolMeasurementGroup

class PoolMeasurementGroup(**kwargs)

Bases: PoolGroupElement

init_attribute_values(attr_values=None)

Initialize attributes with values.

Set values to attributes as passed in attr_values. In lack of attribute value do nothing.

Parameters:

attr_values (Optional[Dict[str, Any]]) – map of attribute names and values

Return type:

None

on_element_changed(evt_src, evt_type, evt_value)

get_pool_controllers()

get_pool_controller_by_name(name)

add_user_element(element, index=None)

Override the base behavior, so the TriggerGate elements are silently skipped if used multiple times in the group

rename_element(old_name, new_name, propagate=1)

Rename element in the controller.

Parameters:

• old_name (str) – old name of the element

• new_name (str) – new name of the element

• propagate (int) – 0 for not propagating, 1 to propagate, 2 propagate with priority

Return type:

None

property configuration

set_configuration(config=None, propagate=1)

set_configuration_from_user(cfg, propagate=1)

get_user_configuration()

get_integration_time()

set_integration_time(integration_time, propagate=1)

property integration_time

the current integration time

get_monitor_count()

set_monitor_count(monitor_count, propagate=1)

property monitor_count

the current monitor count

get_acquisition_mode()

set_acquisition_mode(acquisition_mode, propagate=1)

property acquisition_mode

the current acquisition mode

get_synch_description()

set_synch_description(description, propagate=1)

property synch_description

the current synchronization description

get_moveable()

set_moveable(moveable, propagate=1, to_fqdn=True)

property moveable

moveable source used in synchronization description

get_latency_time()

property latency_time

latency time between two consecutive acquisitions

get_software_synchronizer_initial_domain()

set_software_synchronizer_initial_domain(domain)

property software_synchronizer_initial_domain

software synchronizer initial domain (SynchDomain.Time or SynchDomain.Position)

get_nb_starts()

set_nb_starts(nb_starts, propagate=1)

property nb_starts

current number of starts

prepare()

Prepare for measurement.

Delegate measurement preparation to the acquisition action.

start_acquisition(value=None)

Start measurement.

Delegate start measurement to the acquisition action. Provide backwards compatibility for starts without previous prepare.

set_acquisition(acq_cache)

get_acquisition()

property acquisition

acquisition object

stop()

abort()

release()

ConfigurationItem

class ConfigurationItem(element, attrs=None)

Bases: object

Container of configuration attributes related to a given element.

Wrap an element to pretend its API. Manage the element’s configuration. Hold an information whether the element is enabled. By default it is enabled.

Note

The ConfigurationItem 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.

get_element()

Returns the element associated with this item

set_element(element)

Sets the element for this item

property element

Returns the element associated with this item

ControllerConfiguration

class ControllerConfiguration(element, attrs=None)

Bases: ConfigurationItem

Container of configuration attributes related to a given controller.

Inherit behavior from ConfigurationItem and additionally hold information about its enabled/disabled channels. By default it is disabled.

Note

The ControllerConfiguration 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.

add_channel(channel_item)

Aggregate a channel configuration item.

remove_channel(channel_item)

Remove a channel configuration item.

update_state()

Update internal state based on the aggregated channels.

get_channels(enabled=None)

Return aggregated channels.

Parameters:

enabled (Optional[bool]) – which channels to return - True - only enabled - False - only disabled - None - all

Return type:

List[Any]

validate()

TimerableControllerConfiguration

class TimerableControllerConfiguration(element, attrs=None)

Bases: ControllerConfiguration

Container of configuration attributes related to a given timerable controller.

Inherit behavior from ControllerConfiguration and additionally validate timer and monitor configuration.

Note

The TimerableControllerConfiguration 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.

update_timer()

update_monitor()

validate()

ExternalControllerConfiguration

class ExternalControllerConfiguration(element, attrs=None)

Bases: ControllerConfiguration

Container of configuration attributes related to a given external controller.

Inherit behavior from ControllerConfiguration.

Note

The ExternalControllerConfiguration 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.

ChannelConfiguration

class ChannelConfiguration(element, attrs=None)

Bases: ConfigurationItem

Container of configuration attributes related to a given experimental channel.

Inherit behavior from ConfigurationItem.

Note

The ChannelConfiguration 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.

SynchronizerConfiguration

class SynchronizerConfiguration(element, attrs=None)

Bases: ConfigurationItem

Container of configuration attributes related to a given synchronizer element.

Inherit behavior from ConfigurationItem. By default it is disabled.

Note

The ChannelConfiguration 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.

MeasurementConfiguration

class MeasurementConfiguration(parent=None)

Bases: object

Configuration of a measurement.

Accepts import and export from/to a serializable data structure (based on dictionaries/lists and strings). Provides getter methods that facilitate extracting of information e.g. controllers of different types, master timers/monitors, etc.

Note

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

DFT_DESC = 'General purpose measurement configuration'

get_acq_synch_by_channel(channel)

Return acquisition synchronization configured for this element.

Parameters:

channel – channel to look for its acquisition synchronization or ChannelConfiguration

Returns:

acquisition synchronization

get_acq_synch_by_controller(controller)

Return acquisition synchronization configured for this controller.

Parameters:

controller (Union[PoolController, ControllerConfiguration]) – controller to look for its acquisition synchronization or ControllerConfiguration

Return type:

AcqSynch

Returns:

acquisition synchronization

get_timerable_ctrls(acq_synch=None, enabled=None)

Return timerable controllers.

Allow to filter controllers based on acquisition synchronization or whether these are enabled/disabled.

Parameters:

• acq_synch (Optional[AcqSynch]) – (optional) filter controller based on acquisition synchronization

• enabled (Optional[bool]) –

  (optional) filter controllers whether these are enabled/disabled:

  • True - enabled only

  • False - disabled only

  • None - all

Return type:

List[ControllerConfiguration]

Returns:

timerable controllers that fulfils the filtering criteria

get_timerable_channels(acq_synch=None, enabled=None)

Return timerable channels.

Allow to filter channels based on acquisition synchronization or whether these are enabled/disabled.

Parameters:

• acq_synch (Optional[AcqSynch]) – (optional) filter controller based on acquisition synchronization

• enabled (Optional[bool]) –

  (optional) filter controllers whether these are enabled/disabled:

  • True - enabled only

  • False - disabled only

  • None - all

Return type:

List[ChannelConfiguration]

Returns:

timerable channels that fulfils the filtering criteria

get_zerod_ctrls(enabled=None)

Return 0D controllers.

Allow to filter controllers whether these are enabled/disabled.

Parameters:

enabled (Optional[bool]) –

(optional) filter controllers whether these are enabled/disabled:

• True - enabled only

• False - disabled only

• None - all

Return type:

List[ControllerConfiguration]

Returns:

0D controllers that fulfils the filtering criteria

get_synch_ctrls(enabled=None)

Return synchronizer (currently only trigger/gate) controllers.

Allow to filter controllers whether these are enabled/disabled.

Parameters:

enabled (Optional[bool]) –

(optional) filter controllers whether these are enabled/disabled:

• True - enabled only

• False - disabled only

• None - all

Return type:

List[ControllerConfiguration]

Returns:

synchronizer controllers that fulfils the filtering criteria

get_synchs(enabled=None)

Return synchronizers (currently only trigger/gate).

Allow to filter synchronizers whether these are enabled/disabled.

Parameters:

enabled (Optional[bool]) –

(optional) filter synchronizers whether these are enabled/disabled:

• True - enabled only

• False - disabled only

• None - all

Return type:

List[SynchronizerConfiguration]

Returns:

synchronizers that fulfils the filtering criteria

get_master_timer_software()

Return master timer in software acquisition.

Return type:

ChannelConfiguration

Returns:

master timer in software acquisition

get_master_monitor_software()

Return master monitor in software acquisition.

Return type:

ChannelConfiguration

Returns:

master monitor in software acquisition

get_master_timer_software_start()

Return master timer in software start acquisition.

Return type:

ChannelConfiguration

Returns:

master timer in software start acquisition

get_master_monitor_software_start()

Return master monitor in software start acquisition.

Return type:

ChannelConfiguration

Returns:

master monitor in software start acquisition

get_configuration_for_user()

Return measurement configuration serializable data structure.

set_configuration_from_user(cfg)

Set measurement configuration from serializable data structure.

Setting of the configuration includes the validation process. Setting of invalid configuration raises an exception and leaves the object as it was before the setting process. Thanks to that it is not necessary that the client application does the validation.

The configuration parameters for given channels/controllers may differ depending on their types e.g. 0D channel does not support timer parameter while C/T does.

Todo

Raise exceptions when setting _Synchronization_ parameter for external channels, 0D and PSeudoCounters.