BeamZgoubiDistribution

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

Bases: zgoubidoo.commands.beam.Beam

TODO

Command attributes

LABEL1=''

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

Type

str

LABEL2=''

Secondary label for the Zgoubi command.

Type

str

SLICE='0'

Active slice identifier. Note: this is not the number of slices, but the active slice number.

Type

int

IMAX='1'

Number of particles to be generated

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

Default initializer for all Commands.

Attributes Summary

PARAMETERS

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

mappings

TODO

slices

Number of slices.

Methods Summary

from_sequence(sequence[, statistics])

param sequence

generate_object()

TODO

post_init([objet_type, betablock, slices])

param objet_type

Attributes Documentation

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'), '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'), 'IMAX': (1, 'Number of particles to be generated'), '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'), 'SLICE': (0, 'Active slice identifier. *Note*: this is not the number of slices, but the active slice number.')}

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

mappings

TODO

slices

Number of slices.

Methods Documentation

classmethod from_sequence(sequence: _TwissSequence, statistics: Optional[int] = None, **kwargs)[source]
Parameters
  • sequence

  • statistics

Returns:

generate_object()[source]

TODO

Return:

post_init(objet_type: _ObjetType = <class 'zgoubidoo.commands.mcobjet.MCObjet3'>, betablock: _BetaBlock = None, slices: int = 1, *args, **kwargs)[source]
Parameters
  • objet_type

  • betablock

  • slices

  • *args

  • **kwargs

Returns: