diagnostic module

Define Diagnostic.

As for now, diagnostics are not used by LightWin. However, LightWin can add diagnostics (as well as ADJUST) to the final .dat in order to perform a “pass beauty”.

Note

Functionalities still under implementation. In particular, the number of attributes were not checked.

Note

This is TraceWin’s equivalent of Objective.

class Diagnostic(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Element

A dummy object.

base_name = 'D'

increment_lattice_idx = False

is_implemented: bool = False

__init__(line: DatLine, dat_idx: int | None = None, **kwargs: str) → None: Force an element with null-length, with no index.

_abc_impl = <_abc._abc_data object at 0x7f36f987a000>

class DiagCurrent(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure current.

_abc_impl = <_abc._abc_data object at 0x7f36f987a1c0>

class DiagDCurrent(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure delta current.

_abc_impl = <_abc._abc_data object at 0x7f36f987a300>

class DiagPosition(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure position.

is_implemented: bool = True

n_attributes: int | range | Collection = 4

_abc_impl = <_abc._abc_data object at 0x7f36f987a440>

class DiagDPosition(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure delta position.

_abc_impl = <_abc._abc_data object at 0x7f36f987a780>

class DiagDivergence(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure divergences.

_abc_impl = <_abc._abc_data object at 0x7f36f987a880>

class DiagDDivergence(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure delta divergences.

_abc_impl = <_abc._abc_data object at 0x7f36f987a940>

class DiagSizeFWHM(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure full width at half maximum.

_abc_impl = <_abc._abc_data object at 0x7f36f987aa00>

class DiagSize(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure sizes.

_abc_impl = <_abc._abc_data object at 0x7f36f987aac0>

class DiagSizeP(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure divergences.

_abc_impl = <_abc._abc_data object at 0x7f36f987ab40>

class DiagDSizeFWHM(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure delta full width at half maximum.

_abc_impl = <_abc._abc_data object at 0x7f36f987ac00>

class DiagDSize(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure delta size.

_abc_impl = <_abc._abc_data object at 0x7f36f987ac80>

class DiagDSize2FWHM(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure delta full width at half maximum between two positions.

_abc_impl = <_abc._abc_data object at 0x7f36f987ad80>

class DiagDSize2(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure delta size between two positions.

is_implemented: bool = True

n_attributes: int | range | Collection = (3, 4)

__init__(line: DatLine, dat_idx: int | None = None, **kwargs: str) → None: Force an element with null-length, with no index.

_abc_impl = <_abc._abc_data object at 0x7f36f987ae80>

class DiagDSize3(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure delta phase spread between two positions.

is_implemented: bool = True

n_attributes: int | range | Collection = (3, 4)

__init__(line: DatLine, dat_idx: int | None = None, **kwargs: str) → None: Force an element with null-length, with no index.

classmethod _args_to_line(number: int, rms_delta_phase_spread: float = 0.0, accuracy: float = 0.0, low_pass_filter_frequency: float | None = None) → str: Convert list of arguments to corresponding line of dat file.

_abc_impl = <_abc._abc_data object at 0x7f36f987b100>

class DiagDSize4(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure something?

_abc_impl = <_abc._abc_data object at 0x7f36f987b180>

class DiagDPSize2(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure delta divergence between two positions.

_abc_impl = <_abc._abc_data object at 0x7f36f987b200>

class DiagPhase(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure phase.

n_attributes: int | range | Collection = 2

_abc_impl = <_abc._abc_data object at 0x7f36f987b280>

class DiagEnergy(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure energy.

n_attributes: int | range | Collection = 3

_abc_impl = <_abc._abc_data object at 0x7f36f987b300>

class DiagDEnergy(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure difference between beam energy and perfect linac energy.

n_attributes: int | range | Collection = 3

_abc_impl = <_abc._abc_data object at 0x7f36f987b380>

class DiagDPhase(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure difference between beam phase and perfect linac phase.

n_attributes: int | range | Collection = 2

_abc_impl = <_abc._abc_data object at 0x7f36f987b440>

class DiagLuminosity(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure luminosity.

n_attributes: int | range | Collection = 3

_abc_impl = <_abc._abc_data object at 0x7f36f987b4c0>

class DiagWaist(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure waist setting.

n_attributes: int | range | Collection = 4

_abc_impl = <_abc._abc_data object at 0x7f36f987b540>

class DiagAchromat(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure achromat setting.

n_attributes: int | range | Collection = 5

_abc_impl = <_abc._abc_data object at 0x7f36f987b5c0>

class DiagEmit(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure RMS emittance setting.

n_attributes: int | range | Collection = 4

_abc_impl = <_abc._abc_data object at 0x7f36f987b640>

class DiagEmit99(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure 99% emittance setting.

n_attributes: int | range | Collection = 4

_abc_impl = <_abc._abc_data object at 0x7f36f987b6c0>

class DiagHalo(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure halo setting.

n_attributes: int | range | Collection = 4

_abc_impl = <_abc._abc_data object at 0x7f36f987b740>

class DiagSetMatrix(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure transfer matrix setting.

n_attributes: int | range | Collection = 6

_abc_impl = <_abc._abc_data object at 0x7f36f987b7c0>

class DiagTwiss(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure beam Twiss parameters settings.

n_attributes: int | range | Collection = 7

_abc_impl = <_abc._abc_data object at 0x7f36f987b840>

class DiagDTwiss(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Make equal two beam Twiss parameters between two positions or more.

n_attributes: int | range | Collection = 7

_abc_impl = <_abc._abc_data object at 0x7f36f987b8c0>

class DiagDTwiss2(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Make equal transverse Twiss parameters at diagnostic position.

n_attributes: int | range | Collection = 3

_abc_impl = <_abc._abc_data object at 0x7f36f987b980>

class DiagSeparation(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure beam separation setting.

n_attributes: int | range | Collection = 6

_abc_impl = <_abc._abc_data object at 0x7f36f987ba00>

class DiagSizeMax(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Limit beam size max.

n_attributes: int | range | Collection = 6

_abc_impl = <_abc._abc_data object at 0x7f36f987ba80>

class DiagSizeMin(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: DiagSizeMax

Limit beam size min.

_abc_impl = <_abc._abc_data object at 0x7f36f987bb40>

class DiagPhaseAdv(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure beam phase advance.

n_attributes: int | range | Collection = 4

_abc_impl = <_abc._abc_data object at 0x7f36f987bbc0>

class DiagBeta(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure beam beta.

n_attributes: int | range | Collection = 6

_abc_impl = <_abc._abc_data object at 0x7f36f987bc40>

class DiagDBeta(line: DatLine, dat_idx: int | None = None, **kwargs: str)

Bases: Diagnostic

Measure delta beam beta.

_abc_impl = <_abc._abc_data object at 0x7f36f987bcc0>

n_attributes: int | range | Collection = 4