at.lattice.particle_object#

Description of particles.

Classes

Particle([name])

Particle object: it defines the properties of the particles circulating in a ring.
class Particle(name='relativistic', **kwargs)[source]#

Bases: object

Particle object: it defines the properties of the particles circulating in a ring.

Parameters:

name (str | None) – Particle name. ‘electron’, ‘positron’, ‘proton’, ‘posmuon’, ‘negmuon’ are predefined. For other particles, the rest energy and charge must be provided as keywords. If name is blank or None, an attempt to identify the particle is done.

Keyword Arguments:

  • rest_energy – Particle rest energy [ev]

  • charge – Particle charge [elementary charge]

  • * – Other keywords will be set as attributes of the particle

to_dict()[source]#
property charge: float#

Particle charge [elementary charge].

property rest_energy: ndarray#

Particle rest energy [eV].