MCObjet3

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

Bases: zgoubidoo.commands.mcobjet.MCObjet

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

ALPHA_Y='0.0'

Horizontal (Y) alpha function

Type

float

BETA_Y='1.0 meter'

Horizontal (Y) beta function

Type

Quantity

EMIT_Y='1e-09 meter * radian'

Horizontal (Y) normalized emittance

Type

Quantity

D_Y='0.0 meter'

Horizontal (Y) dispersion

Type

Quantity

D_YP='0.0'

Horizontal (Y) dispersion prime

Type

float

N_CUTOFF_Y='10'

Cut-off value for the horizontal distribution

Type

int

N_CUTOFF2_Y='0'

Secondary cut-off value for the horizontal distribution

Type

int

ALPHA_Z='0.0'

Vertical (Z) alpha function

Type

float

BETA_Z='1.0 meter'

Vertical (Z) beta function

Type

Quantity

EMIT_Z='1e-09 meter * radian'

Vertical (Z) normalized emittance

Type

Quantity

D_Z='0.0 meter'

Vertical (Z) dispersion

Type

Quantity

D_ZP='0.0'

Vertical (Z) dispersion prime

Type

float

N_CUTOFF_Z='10'

Cut-off value for the vertical distribution

Type

int

N_CUTOFF2_Z='0'

Secondary cut-off value for the vertical distribution

Type

int

ALPHA_X='0.0'

Longitudinal (X) alpha function

Type

float

BETA_X='1.0 meter'

Longitudinal (X) beta function

Type

Quantity

EMIT_X='1e-09 meter * radian'

Longitudinal (X) normalized emittance

Type

Quantity

N_CUTOFF_X='10'

Cut-off value for the longitudinal distribution

Type

int

N_CUTOFF2_X='0'

Secondary cut-off value for the longitudinal distribution

Type

int

I1='1'

Random sequence seed

Type

int

I2='2'

Random sequence seed

Type

int

I3='3'

Random sequence seed

Type

int

Default initializer for all Commands.

Attributes Summary

KEYWORD
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'

PARAMETERS: dict = {'ALPHA_X': (0.0, 'Longitudinal (X) alpha function'), 'ALPHA_Y': (0.0, 'Horizontal (Y) alpha function'), 'ALPHA_Z': (0.0, 'Vertical (Z) alpha function'), 'BETA_X': (<Quantity(1.0, 'meter')>, 'Longitudinal (X) beta function'), 'BETA_Y': (<Quantity(1.0, 'meter')>, 'Horizontal (Y) beta function'), 'BETA_Z': (<Quantity(1.0, 'meter')>, 'Vertical (Z) beta function'), 'BORO': (<Quantity(1.0, 'meter * tesla')>, 'Reference rigidity'), 'D0': (1, 'Mean value'), 'D_Y': (<Quantity(0.0, 'meter')>, 'Horizontal (Y) dispersion'), 'D_YP': (0.0, 'Horizontal (Y) dispersion prime'), 'D_Z': (<Quantity(0.0, 'meter')>, 'Vertical (Z) dispersion'), 'D_ZP': (0.0, 'Vertical (Z) dispersion prime'), 'EMIT_X': (<Quantity(1e-09, 'meter * radian')>, 'Longitudinal (X) normalized emittance'), 'EMIT_Y': (<Quantity(1e-09, 'meter * radian')>, 'Horizontal (Y) normalized emittance'), 'EMIT_Z': (<Quantity(1e-09, 'meter * radian')>, 'Vertical (Z) normalized emittance'), 'I1': (1, 'Random sequence seed'), 'I2': (2, 'Random sequence seed'), 'I3': (3, 'Random sequence seed'), '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.'), 'N_CUTOFF2_X': (0, 'Secondary cut-off value for the longitudinal distribution'), 'N_CUTOFF2_Y': (0, 'Secondary cut-off value for the horizontal distribution'), 'N_CUTOFF2_Z': (0, 'Secondary cut-off value for the vertical distribution'), 'N_CUTOFF_X': (10, 'Cut-off value for the longitudinal distribution'), 'N_CUTOFF_Y': (10, 'Cut-off value for the horizontal distribution'), 'N_CUTOFF_Z': (10, 'Cut-off value for the vertical distribution'), '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).