tune_monitor#

class ConfigModel(*, name, description=None, lattice_names=None, tune_h, tune_v, rf_plant_name=None)[source]#

Bases: ElementConfigModel

Configuration model for BetatronTuneMonitor

Parameters:

  • tune_h (DeviceAccess, optional) – Horizontal betatron tune device

  • tune_v (DeviceAccess, optional) – Vertical betatron tune device

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

rf_plant_name: str | None#
tune_h: DeviceAccess | None#
tune_v: DeviceAccess | None#
class BetatronTuneMonitor(cfg)[source]#

Bases: Element, ABetatronTuneMonitor

Class providing access to a betatron tune monitor of a physical or simulated lattice. The monitor provides horizontal and vertical betatron tune measurements.

Construct a BetatronTuneMonitor

Parameters:

cfg (ConfigModel) – Configuration for the BetatronTuneMonitor, including device access for horizontal and vertical tunes.

attach(peer, betatron_tune)[source]#

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

Parameters:

  • peer (object) – The peer object (simulator or control system)

  • betatron_tune (ReadFloatArray) – The betatron tune array to monitor

Returns:

Self – A new attached instance of TuneMonitor

set_harmonic(h)[source]#

Sets the harmonic number (number of bucket) on this element

property frequency: ReadFloatArray#

Get the betatron tune values in frequency

Returns:

ReadFloatArray – Array of tune values in frequency [horizontal, vertical]

property tune: ReadFloatArray#

Get the betatron tune values.

Returns:

ReadFloatArray – Array of tune values [horizontal, vertical]