Measurement groups¶
A measurement group is a container for counters. The measurement group helps to deal with a coherent set of counters. For example, a measurement group can represent counters related to a detector, a hutch or an experiment.
Measurement groups are loaded by the session Beacon plugin, thus it
is possible to configure those:
* directly in a session YAML file
* somewhere else with plugin: session
- class: MeasurementGroup plugin: session name: align_counters counters: [simct1, simct2, simct3] - class: MeasurementGroup plugin: session name: MG1 counters: [simct2, simct3]
Note
MeasurementGroup objects must be added in the list of objects to load in the
session (config-objects list)
counters must be a list of names, corresponding to Counter objects.
Read more about Counter objects
Usage¶
Once a measurement group is created, it can be added in the list of objects to load in the session in order to use it in a BLISS session:
DEMO [1]: align_counters Out [1]: MeasurementGroup: align_counters (default) Enabled Disabled ------- ------- simct1 simct2 simct3
One or many measurement groups can be passed as argument to a scan
or ct procedure to indicate, which counters to use:
DEMO [20]: print(MG1.available, MG2.available) # 4 counters defined ['simct2', 'simct3'] ['simct4', 'simct5'] DEMO [21]: timescan(0.1, MG1, MG2, npoints=3) Scan 15 Wed Feb 21 16:31:48 2018 /tmp/scans/cyril/ cyril user = guilloud timescan 0.1 # dt(s) simct2 simct3 simct4 simct5 0 0.0347409 0.50349 0.494272 0.501698 0.496145 1 0.13725 0.49622 0.503753 0.500348 0.500601 2 0.2391 0.502216 0.500213 0.494356 0.493359 Took 0:00:00.395435
List of measurement groups¶
To get the list of all available measurement groups:
DEMO [23]: from bliss.common import measurementgroup DEMO [24]: measurementgroup.get_all_names() Out [24]: ['align_counters', 'MG2', 'MG1']
Active measurement group¶
There is only ever one active measurement group at a time.
ACTIVE_MG is the global variable indicating the one ‘active’ measurement group.
DEMO [31]: ACTIVE_MG Out [31]: MeasurementGroup: align_counters (default) Enabled Disabled ------- ------- simct2 simct1 simct3
This active measurement group is the default used by a scan or a ct:
DEMO [32]: ct(0.1) Wed Feb 21 15:38:51 2018 dt(s) = 0.0161161422729 ( 0.161161422729/s) simct2 = 0.499050226458 ( 4.99050226458/s)
Note that only simct2 is counting, since the two others are disabled.
To change the active measurement group, use set_active() method:
DEMO [33]: ACTIVE_MG Out [33]: MeasurementGroup: align_counters (default) Enabled Disabled ------- ------- simct2 simct1 simct3 DEMO [34]: MG2.set_active() DEMO [35]: ACTIVE_MG Out [35]: MeasurementGroup: MG2 (default) Enabled Disabled ------- ------- simct4 simct5
Adding or removing counters¶
A counter can be added/removed to/from a measurement group.
DEMO [4]: MG1 Out [4]: MeasurementGroup: MG1 (state='default') - Existing states : 'default' Enabled Disabled ------- ------- simct1 simct2 DEMO [5]: MG1.add(emeter2.counters.e1) DEMO [6]: MG1 Out [6]: MeasurementGroup: MG1 (state='default') - Existing states : 'default' Enabled Disabled ------- ------- simct1 simct2 e1 DEMO [7]: MG1.remove(emeter2.counters.e1) DEMO [8]: MG1 Out [8]: MeasurementGroup: MG1 (state='default') - Existing states : 'default' Enabled Disabled ------- ------- simct1 simct2
Enabling/disabling counters¶
Counters can be enabled or disabled in a measurement group, using
.enable(*cnt) or .disable(*cnt).
Include measurement group’s counters¶
Counters of a measurement group can be included into another
measurement group using include keyword in the YML file:
- class: MeasurementGroup name: MG2 counters: - simct3 - simct4 include: - MG1
This will make MG2 to look like:
DEMO [2]: MG2 Out [2]: MeasurementGroup: MG2 (state='default') - Existing states : 'default' Enabled Disabled ------- ------- simct3 simct4 simct1 simct2
States¶
A measurement group can have many states to denote different
usages. For example, it is possible to disable some counters during an
alignment and, in case of problem, switch to the state, where
diagnostic counters are enabled.
At creation, a measurement group is in the default state:
DEMO [41]: align_counters Out [41]: MeasurementGroup: align_counters (default) # <-- default state Enabled Disabled ------- ------- simct2 simct1 # <-- counters simct1 and simct2 simct3 # were previously disabled
switch_state(<new_state_name>)
method:
DEMO [42]: align_counters.switch_state("diag_mono") DEMO [43]: print align_counters MeasurementGroup: align_counters (diag_mono) # new "diag_mono" state Enabled Disabled ------- ------- simct1 # with all counters enabled simct2 simct3
To customize the status of each counter within this state:
DEMO [46]: align_counters.disable = "simct3"
The state_names property returns the list of available states:
DEMO [47]: align_counters.state_names Out [47]: ['diag_mono', 'default']
Then, it is possible to switch from a state to another:
DEMO [50]: align_counters.switch_state("default") DEMO [51]: print align_counters MeasurementGroup: align_counters (default) Enabled Disabled ------- ------- simct2 simct1 simct3 DEMO [52]: ct(1) Wed Feb 21 15:52:31 2018 dt(s) = 0.00573420524597 ( 0.00573420524597/s) simct2 = 0.499528833799 ( 0.499528833799/s) DEMO [53]: align_counters.switch_state("diag_mono") DEMO [55]: print align_counters MeasurementGroup: align_counters (diag_mono) Enabled Disabled ------- ------- simct1 simct3 simct2