pyaml.diagnostics.tune_monitor#

Betatron tune monitor element and runtime data bindings.

The monitor identifies tune measurements, attaches them to a runtime peer, and optionally converts tune fractions to frequencies using an RF plant.

Classes

BetatronTuneMonitor(name[, description, ...])

Betatron tune monitor.

class pyaml.diagnostics.tune_monitor.BetatronTuneMonitor(name, description=None, tune_h=None, tune_v=None, rf_plant_name=None)#

Bases: Element, DynamicValidation, ABetatronTuneMonitor

Betatron tune monitor.

Represents a betatron tune monitor in the accelerator lattice and provides access to the measured horizontal and vertical betatron tunes. Optionally, the monitor can be associated with an RF plant used to convert tune measurements to frequency values.

Parameters:

name (str) – Name of the betatron tune monitor.
description (str | None, optional) – Description of the monitor.
tune_h (str | None, optional) – Device catalog key for the horizontal betatron tune measurement.
tune_v (str | None, optional) – Device catalog key for the vertical betatron tune measurement.
rf_plant_name (str | None, optional) – Name of the associated RF plant element used by the monitor.

Attributes

`tune_h`	Return the horizontal tune device catalog key.
`tune_v`	Return the vertical tune device catalog key.
`tune`	Get the betatron tune values.
`frequency`	Return the betatron tune values converted to frequency.

Methods

`set_harmonic()`	Set the harmonic number used for tune-frequency conversion.
`attach()`	Attach the tune monitor to a peer with betatron tune data.

Configuration

- type: pyaml.diagnostics.tune_monitor
  name: BETATRON_TUNE
  tune_h: DEVICE/HORIZONTAL_TUNE
  tune_v: DEVICE/VERTICAL_TUNE
  rf_plant_name: RF

attach(peer, betatron_tune)#

Attach the tune monitor to a peer with betatron tune data.

Parameters:

peer (object) – Simulator or control-system peer providing the RF plant.
betatron_tune (ReadFloatArray) – Readable array containing the measured horizontal and vertical tunes.

Returns:

Self – A shallow copy of this monitor bound to peer and betatron_tune.

Return type:

Self

set_harmonic(h)#

Set the harmonic number used for tune-frequency conversion.

Parameters:: h (int) – Harmonic number relating the RF frequency to the measured betatron tune frequency.

property frequency: ReadFloatArray#

Return the betatron tune values converted to frequency.

Returns:: ReadFloatArray – Readable array containing horizontal and vertical frequencies.

property tune: ReadFloatArray#

Get the betatron tune values.

Returns:: ReadFloatArray – Readable array containing the horizontal and vertical tunes.

property tune_h: str | None#: Return the horizontal tune device catalog key.

property tune_v: str | None#: Return the vertical tune device catalog key.