Beam

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

Bases: zgoubidoo.commands.commands.Command

Command attributes

LABEL1=''

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

Type

str

LABEL2=''

Secondary label for the Zgoubi command.

Type

str

Default initializer for all Commands.

Attributes Summary

PARAMETERS

kinematics

The beam’s kinematics properties.

mappings

TODO

particle

The beam’s particle type.

Methods Summary

generate_object()

TODO

post_init(objet_type, kinematics[, particle])

param objet_type

Attributes Documentation

PARAMETERS: dict = {'LABEL1': ('', 'Primary label for the Zgoubi command (default: auto-generated hash).'), 'LABEL2': ('', 'Secondary label for the Zgoubi command.')}
kinematics

The beam’s kinematics properties.

mappings

TODO

particle

The beam’s particle type.

Methods Documentation

generate_object()[source]

TODO

Return:

post_init(objet_type: zgoubidoo.commands.objet.ObjetType, kinematics: Union[georges_core.kinematics.Kinematics, float, pint.quantity.build_quantity_class.<locals>.Quantity], particle: zgoubidoo.commands.particules.ParticuleType = <class 'zgoubidoo.commands.particules.Proton'>, *args, **kwargs)[source]
Parameters
  • objet_type

  • kinematics

  • particle

  • *args

  • **kwargs

Returns: