Optics¶

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

Bases: zgoubidoo.commands.commands.Command

Write out optical functions.

OPTICS normally appears next to object definition, it normally works in conjunction with element label(s). OPTICS causes the transport and write out, in zgoubi.res, of the 6×6 beam matrix, following options KOPT and ’label ’, below.

IF KOPT=0 : Off IF KOPT=1 : Will transport the optical functions with initial values as specified in OBJET, option KOBJ=5.01.

Note: The initial values in OBJET[KOBJ=5.01] may be the periodic ones, as obtained, for instance, from a first run using MATRIX[IFOC=11].

A second argument, ’label ’, allows

if label = all : printing out, into zgoubi.res, after all keywords of the zgoubi.dat structure,

otherwise, printing out at all keyword featuring LABEL ≡ label as a first label (see section 4.6.5, page 162, regarding the labelling of keywords).

A third argument, IMP=1, will cause saving of the transported beta functions into file zgoubi.OPTICS.out.

Command attributes

LABEL1=''

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

Type: str

LABEL2=''

Secondary label for the Zgoubi command.

Type: str

LABEL='all'

If IFOC=11, periodic parameters (single pass)

Type: str

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.

Attributes Documentation

KEYWORD: str = 'OPTICS'¶: Keyword of the command used for the Zgoubi input data.

PARAMETERS: dict = {'IMP': (1,), 'IOPT': (1,), 'LABEL': ('all', 'If IFOC=11, periodic parameters (single pass)'), 'LABEL1': ('', 'Primary label for the Zgoubi command (default: auto-generated hash).'), 'LABEL2': ('', 'Secondary label for the Zgoubi command.')}¶: Parameters of the command, with their default value, their description and optinally an index used by other commands (e.g. fit).