Definitions

Constants

General constants to use throughout omc3, so they don’t have to be redefined all the time. Also helps with consistency.

Formats

Recurring formats are defined here.

omc3.definitions.formats.get_config_filename(script)[source]: Default Filename for config-files. Call from script with __file__.

Optics

Definitions for the optics measurements.

class omc3.definitions.optics.ColumnsAndLabels(_column: str, _error_column: str = None, _model_column: str = None, _delta_column: str = None, _error_delta_column: str = None, _expected_column: str = None, _error_expected_column: str = None, _diff_correction_column: str = None, _label: str = None, _delta_label: str = None, _text_label: str = None, _delta_rms_header: str = None, _expected_rms_header: str = None, needs_plane: bool = True)[source]

Bases: object

Class to store information about derived columns from the main column. For convenience, also labels (e.g. for plotting) related to that column are stored in this dataclass.

property column

property delta_column

property delta_label

property delta_masked_rms_header

property delta_rms_header

property diff_correction_column

property error_column

property error_delta_column

property error_expected_column

property expected_column

property expected_masked_rms_header

property expected_rms_header

property label

property model_column

needs_plane: bool = True

set_label_formatted(name: str) → ColumnsAndLabels[source]: Fixes the label in a new object (for RDTs).

set_plane(plane: str) → ColumnsAndLabels[source]: Fixes the plane in a new object.

property text_label

omc3.definitions.optics.FILE_COLUMN_MAPPING = {'beta_amplitude_': ColumnsAndLabels(_column='BET', _error_column=None, _model_column=None, _delta_column=None, _error_delta_column=None, _expected_column=None, _error_expected_column=None, _diff_correction_column=None, _label='$\\beta_{{{0}}} \\quad [m]$', _delta_label='$\\Delta \\beta_{{{0}}} \\; / \\; \\beta_{{{0}}}$', _text_label='beta', _delta_rms_header=None, _expected_rms_header=None, needs_plane=True), 'beta_kmod_': ColumnsAndLabels(_column='BET', _error_column=None, _model_column=None, _delta_column=None, _error_delta_column=None, _expected_column=None, _error_expected_column=None, _diff_correction_column=None, _label='$\\beta_{{{0}}} \\quad [m]$', _delta_label='$\\Delta \\beta_{{{0}}} \\; / \\; \\beta_{{{0}}}$', _text_label='beta', _delta_rms_header=None, _expected_rms_header=None, needs_plane=True), 'beta_phase_': ColumnsAndLabels(_column='BET', _error_column=None, _model_column=None, _delta_column=None, _error_delta_column=None, _expected_column=None, _error_expected_column=None, _diff_correction_column=None, _label='$\\beta_{{{0}}} \\quad [m]$', _delta_label='$\\Delta \\beta_{{{0}}} \\; / \\; \\beta_{{{0}}}$', _text_label='beta', _delta_rms_header=None, _expected_rms_header=None, needs_plane=True), 'dispersion_': ColumnsAndLabels(_column='D', _error_column=None, _model_column=None, _delta_column=None, _error_delta_column=None, _expected_column=None, _error_expected_column=None, _diff_correction_column=None, _label='D$_{{{0}}}$ [m]', _delta_label=None, _text_label='dispersion', _delta_rms_header=None, _expected_rms_header=None, needs_plane=True), 'normalised_dispersion_': ColumnsAndLabels(_column='ND', _error_column=None, _model_column=None, _delta_column=None, _error_delta_column=None, _expected_column=None, _error_expected_column=None, _diff_correction_column=None, _label='D$_{{{0}}} \\; / \\; \\sqrt{{\\beta_{{{0}}}}} \\quad \\left[\\sqrt{{\\rm m}}\\right]$', _delta_label=None, _text_label='normalized dispersion', _delta_rms_header=None, _expected_rms_header=None, needs_plane=True), 'orbit_': ColumnsAndLabels(_column='', _error_column=None, _model_column=None, _delta_column=None, _error_delta_column=None, _expected_column=None, _error_expected_column=None, _diff_correction_column=None, _label='Orbit {0} [m]', _delta_label=None, _text_label='orbit', _delta_rms_header=None, _expected_rms_header=None, needs_plane=True), 'phase_': ColumnsAndLabels(_column='PHASE', _error_column=None, _model_column=None, _delta_column=None, _error_delta_column=None, _expected_column=None, _error_expected_column=None, _diff_correction_column=None, _label='$\\phi_{{{0}}} \\quad [2\\pi]$', _delta_label=None, _text_label='phase', _delta_rms_header=None, _expected_rms_header=None, needs_plane=True), 'total_phase_': ColumnsAndLabels(_column='PHASE', _error_column=None, _model_column=None, _delta_column=None, _error_delta_column=None, _expected_column=None, _error_expected_column=None, _diff_correction_column=None, _label='$\\phi_{{{0}}} \\quad [2\\pi]$', _delta_label=None, _text_label='total phase', _delta_rms_header=None, _expected_rms_header=None, needs_plane=True)}: Find the Column Dataclass by column name for RDTs.

class omc3.definitions.optics.OpticsMeasurement(directory: Path, allow_write: bool | None = None)[source]

Bases: TfsCollection

Class to hold and load the measurements from omc3.optics_measurements.

Parameters:: directory -- The path to the measurement directory, usually the optics_measurements output directory.

INDEX = 'NAME'

property beta_amplitude_x

property beta_amplitude_y

property beta_kmod_x

property beta_kmod_y

property beta_phase_x

property beta_phase_y

property dispersion_x

property dispersion_y

property f1001

property f1010

property ip_kmod_x

property ip_kmod_y

property ip_x

property ip_y

property kick_x

property kick_y

property norm_dispersion_x

property norm_dispersion_y

property orbit_x

property orbit_y

property phase_driven_x

property phase_driven_y

property phase_x

property phase_y

read_tfs(filename: str) → TfsDataFrame[source]: Override for NAME convenience.

property total_phase_driven_x

property total_phase_driven_y

property total_phase_x

property total_phase_y

write_tfs(filename: str, data_frame: TfsDataFrame)[source]: Override for NAME convenience.

omc3.definitions.optics.POSITION_COLUMN_MAPPING = {'location': ColumnsAndLabels(_column='S', _error_column=None, _model_column=None, _delta_column=None, _error_delta_column=None, _expected_column=None, _error_expected_column=None, _diff_correction_column=None, _label='Location [m]', _delta_label=None, _text_label='longitudinal location', _delta_rms_header=None, _expected_rms_header=None, needs_plane=False), 'phase-advance': ColumnsAndLabels(_column='MU{0}MDL', _error_column=None, _model_column=None, _delta_column=None, _error_delta_column=None, _expected_column=None, _error_expected_column=None, _diff_correction_column=None, _label='Phase Advance [$2 \\pi$]', _delta_label=None, _text_label='phase advance', _delta_rms_header=None, _expected_rms_header=None, needs_plane=True)}: Map the file name to it’s main columns and the respective label for a plot.

omc3.definitions.optics.RDT_IMAG_COLUMN = ColumnsAndLabels(_column='IMAG', _error_column=None, _model_column=None, _delta_column=None, _error_delta_column=None, _expected_column=None, _error_expected_column=None, _diff_correction_column=None, _label='$\\Im({0})$', _delta_label=None, _text_label='imaginary', _delta_rms_header=None, _expected_rms_header=None, needs_plane=False): Map for the x-axis of plots.