FaiStore

class zgoubidoo.commands.commands.FaiStore(label1: str = '', label2: str = '', *params, **kwargs)

Bases: zgoubidoo.commands.commands.Command

Store coordinates at labeled elements.

Zgoubi manual description

Store coordinates every IP other pass at labeled elements.

If either FNAME or first LABEL is ’none’ then no storage occurs. Store occurs at all elements if first LABEL is ’all’ or ’ALL’.

Command attributes

LABEL1=''

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

Type

str

LABEL2=''

Secondary label for the Zgoubi command.

Type

str

FNAME='zgoubi.fai'

Storage file name.

Type

str

LABELS='ALL'

Label(s) of the element(s) at the exit of which the storage occurs (10 labels maximum).

Type

str

IP='1'

Store every IP other pass (when using REBELOTE with NPASS ≥ IP − 1).

Type

int

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 = 'FAISTORE'

Keyword of the command used for the Zgoubi input data.

PARAMETERS: dict = {'FNAME': ('zgoubi.fai', 'Storage file name.'), 'IP': (1, 'Store every IP other pass (when using REBELOTE with NPASS ≥ IP − 1).'), 'LABEL1': ('', 'Primary label for the Zgoubi command (default: auto-generated hash).'), 'LABEL2': ('', 'Secondary label for the Zgoubi command.'), 'LABELS': ('ALL', 'Label(s) of the element(s) at the exit of which the storage occurs (10 labels maximum).')}

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