Collimateur¶

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

Bases: zgoubidoo.commands.commands.Command

Collimator.

Zgoubi manual description

COLLIMA acts as a mathematical aperture of zero length. It causes the identification, counting and stop- ping of particles that reach the aperture limits.

Command attributes

LABEL1=''

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

Type: str

LABEL2=''

Secondary label for the Zgoubi command.

Type: str

IA='2'

Element active or not (0 - inactive, 1 - active, 2 - active and prints information.

Type: int

IFORM='1'

Aperture shape (1 - rectangular, 2 - elliptic (other options, see documentation).

Type: int

J='0'

Description of the aperture coordinates system.

Type: int

C1='0 centimeter'

Half opening (Y).

Type: Quantity

C2='0 centimeter'

Half opening (Z).

Type: Quantity

C3='0 centimeter'

Center of the aperture (Y).

Type: Quantity

C4='0 centimeter'

Center of the aperture (Z).

Type: Quantity

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 = 'COLLIMA'¶: Keyword of the command used for the Zgoubi input data.

PARAMETERS: dict = {'C1': (<Quantity(0, 'centimeter')>, 'Half opening (Y).'), 'C2': (<Quantity(0, 'centimeter')>, 'Half opening (Z).'), 'C3': (<Quantity(0, 'centimeter')>, 'Center of the aperture (Y).'), 'C4': (<Quantity(0, 'centimeter')>, 'Center of the aperture (Z).'), 'IA': (2, 'Element active or not (0 - inactive, 1 - active, 2 - active and prints information.'), 'IFORM': (1, 'Aperture shape (1 - rectangular, 2 - elliptic (other options, see documentation).'), 'J': (0, 'Description of the aperture coordinates system.'), '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).