ChangRef

class zgoubidoo.commands.commands.ChangRef(label1: str = '', label2: str = '', *params, **kwargs)[source]

Bases: zgoubidoo.commands.commands.Command, zgoubidoo.commands.patchable.Patchable

Transformation to a new reference frame.

Supports only Zgoubi “new style” ChangeRef. To recover the “old style”, do XS, YS, ZR.

::note: ChangRef supports the Patchable interface and the transformations will thus be taken into account when surveying the line.

Zgoubi manual description

TODO

Command attributes

LABEL1=''

Primary label for the Zgoubi command (default: auto-generated hash).

Type

str

LABEL2=''

Secondary label for the Zgoubi command.

Type

str

TRANSFORMATIONS='[]'

List of transformations for new style ChangeRef

Type

list

Default initializer for all Commands.

Attributes Summary

KEYWORD

Keyword of the command used for the Zgoubi input data.

PARAMETERS

Parameters of the command, with their default value, their description and optinally an index used by other commands (e.g.

entry_patched

Returns:

length

Returns:

Attributes Documentation

KEYWORD: str = 'CHANGREF'

Keyword of the command used for the Zgoubi input data.

PARAMETERS: dict = {'LABEL1': ('', 'Primary label for the Zgoubi command (default: auto-generated hash).'), 'LABEL2': ('', 'Secondary label for the Zgoubi command.'), 'TRANSFORMATIONS': ([], 'List of transformations for new style ChangeRef')}

Parameters of the command, with their default value, their description and optinally an index used by other commands (e.g. fit).

entry_patched

Returns:

length

Returns: