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, dat_idx=None, **kwargs)[source]

Bases: Element

A dummy object.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

base_name = 'D'

increment_lattice_idx = False

is_implemented: bool = False

__init__(line, dat_idx=None, **kwargs)[source]

Force an element with null-length, with no index.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

Return type:

None

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

class DiagCurrent(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure current.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

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

class DiagDCurrent(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure delta current.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

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

class DiagPosition(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure position.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

is_implemented: bool = True

n_attributes: int | range | Collection = 4

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

class DiagDPosition(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure delta position.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

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

class DiagDivergence(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure divergences.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

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

class DiagDDivergence(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure delta divergences.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

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

class DiagSizeFWHM(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure full width at half maximum.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

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

class DiagSize(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure sizes.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

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

class DiagSizeP(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure divergences.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

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

class DiagDSizeFWHM(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure delta full width at half maximum.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

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

class DiagDSize(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure delta size.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

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

class DiagDSize2FWHM(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure delta full width at half maximum between two positions.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

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

class DiagDSize2(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure delta size between two positions.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

is_implemented: bool = True

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

__init__(line, dat_idx=None, **kwargs)[source]

Force an element with null-length, with no index.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

Return type:

None

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

class DiagDSize3(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure delta phase spread between two positions.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

is_implemented: bool = True

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

__init__(line, dat_idx=None, **kwargs)[source]

Force an element with null-length, with no index.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

Return type:

None

classmethod _args_to_line(number, rms_delta_phase_spread=0.0, accuracy=0.0, low_pass_filter_frequency=None)[source]

Convert list of arguments to corresponding line of dat file.

Parameters:

number (int)
rms_delta_phase_spread (float, default: 0.0)
accuracy (float, default: 0.0)
low_pass_filter_frequency (float | None, default: None)

Return type:

str

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

class DiagDSize4(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure something?

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

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

class DiagDPSize2(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure delta divergence between two positions.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

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

class DiagPhase(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure phase.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

n_attributes: int | range | Collection = 2

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

class DiagEnergy(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure energy.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

n_attributes: int | range | Collection = 3

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

class DiagDEnergy(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure difference between beam energy and perfect linac energy.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

n_attributes: int | range | Collection = 3

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

class DiagDPhase(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure difference between beam phase and perfect linac phase.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

n_attributes: int | range | Collection = 2

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

class DiagLuminosity(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure luminosity.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

n_attributes: int | range | Collection = 3

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

class DiagWaist(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure waist setting.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

n_attributes: int | range | Collection = 4

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

class DiagAchromat(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure achromat setting.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

n_attributes: int | range | Collection = 5

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

class DiagEmit(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure RMS emittance setting.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

n_attributes: int | range | Collection = 4

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

class DiagEmit99(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure 99% emittance setting.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

n_attributes: int | range | Collection = 4

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

class DiagHalo(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure halo setting.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

n_attributes: int | range | Collection = 4

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

class DiagSetMatrix(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure transfer matrix setting.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

n_attributes: int | range | Collection = 6

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

class DiagTwiss(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure beam Twiss parameters settings.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

n_attributes: int | range | Collection = 7

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

class DiagDTwiss(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

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

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

n_attributes: int | range | Collection = 7

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

class DiagDTwiss2(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Make equal transverse Twiss parameters at diagnostic position.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

n_attributes: int | range | Collection = 3

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

class DiagSeparation(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure beam separation setting.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

n_attributes: int | range | Collection = 6

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

class DiagSizeMax(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Limit beam size max.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

n_attributes: int | range | Collection = 6

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

class DiagSizeMin(line, dat_idx=None, **kwargs)[source]

Bases: DiagSizeMax

Limit beam size min.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

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

class DiagPhaseAdv(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure beam phase advance.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

n_attributes: int | range | Collection = 4

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

class DiagBeta(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure beam beta.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

n_attributes: int | range | Collection = 6

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

class DiagDBeta(line, dat_idx=None, **kwargs)[source]

Bases: Diagnostic

Measure delta beam beta.

Parameters:

line (DatLine)
dat_idx (int | None, default: None)
kwargs (str)

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

n_attributes: int | range | Collection = 4