MCObjet

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

Bases: zgoubidoo.commands.commands.Command

Monte-Carlo generation of a 6-D object.

Command attributes

LABEL1=''

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

Type

str

LABEL2=''

Secondary label for the Zgoubi command.

Type

str

BORO='1.0 meter * tesla'

Reference rigidity

Type

Quantity

IMAX='1'

Number of particles to be generated

Type

int

KY='2'

1 - Uniform, 2 - Gaussian, 3 - Parabolic

Type

int

KT='2'

1 - Uniform, 2 - Gaussian, 3 - Parabolic

Type

int

KZ='2'

1 - Uniform, 2 - Gaussian, 3 - Parabolic

Type

int

KP='2'

1 - Uniform, 2 - Gaussian, 3 - Parabolic

Type

int

KX='2'

1 - Uniform, 2 - Gaussian, 3 - Parabolic

Type

int

KD='1'

1 - Uniform, 2 - Exponential, 3 - Kinematic

Type

int

Y0='0 centimeter'

Mean value

Type

Quantity

T0='0 radian'

Mean value

Type

Quantity

Z0='0 centimeter'

Mean value

Type

Quantity

P0='0 radian'

Mean value

Type

Quantity

X0='0 centimeter'

Mean value

Type

Quantity

D0='1'

Mean value

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

Keyword of the command used for the Zgoubi input data.

PARAMETERS: dict = {'BORO': (<Quantity(1.0, 'meter * tesla')>, 'Reference rigidity'), 'D0': (1, 'Mean value'), 'IMAX': (1, 'Number of particles to be generated'), 'KD': (1, '1 - Uniform, 2 - Exponential, 3 - Kinematic'), 'KP': (2, '1 - Uniform, 2 - Gaussian, 3 - Parabolic'), 'KT': (2, '1 - Uniform, 2 - Gaussian, 3 - Parabolic'), 'KX': (2, '1 - Uniform, 2 - Gaussian, 3 - Parabolic'), 'KY': (2, '1 - Uniform, 2 - Gaussian, 3 - Parabolic'), 'KZ': (2, '1 - Uniform, 2 - Gaussian, 3 - Parabolic'), 'LABEL1': ('', 'Primary label for the Zgoubi command (default: auto-generated hash).'), 'LABEL2': ('', 'Secondary label for the Zgoubi command.'), 'P0': (<Quantity(0, 'radian')>, 'Mean value'), 'T0': (<Quantity(0, 'radian')>, 'Mean value'), 'X0': (<Quantity(0, 'centimeter')>, 'Mean value'), 'Y0': (<Quantity(0, 'centimeter')>, 'Mean value'), 'Z0': (<Quantity(0, 'centimeter')>, 'Mean value')}

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