Drift

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

Bases: zgoubidoo.commands.magnetique.CartesianMagnet

Field free drift space.

TODO

>>> Drift(XL=10 * _ureg.cm)

Command attributes

LABEL1=''

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

Type

str

LABEL2=''

Secondary label for the Zgoubi command.

Type

str

HEIGHT='20 centimeter'

Height of the magnet (distance between poles), used by plotting functions.

Type

Quantity

POLE_WIDTH='30 centimeter'

Pole width (used for plotting only).

Type

Quantity

PIPE_THICKNESS='2 centimeter'

Thickness of the pipe, used by plotting functions.

Type

Quantity

PIPE_COLOR='grey'

Color of the pipe, used by plotting functions.

Type

str

REFERENCE_FIELD_COMPONENT='BZ'

Orientation of the reference field (used by field maps)

Type

str

KINEMATICS='None'

A kinematics object.

Type

NoneType

APERTURE_LEFT='10 centimeter'

Aperture size of the magnet, left side (used for plotting only).

Type

Quantity

APERTURE_RIGHT='10 centimeter'

Aperture size of the magnet, right side (used for plotting only).

Type

Quantity

APERTURE_TOP='10 centimeter'

Aperture size of the magnet, top side (used for plotting only).

Type

Quantity

APERTURE_BOTTOM='10 centimeter'

Aperture size of the magnet, bottom side (used for plotting only).

Type

Quantity

COLOR='None'

Color used when plotting the element.

Type

NoneType

LENGTH_IS_ARC_LENGTH='False'

Type

bool

IL='0'

Type

int

XL='0 centimeter'

Drift length

Type

Quantity

SPLIT='True'

Split the drift in multiple steps.

Type

bool

SPLITS='10'

If SPLITS > 1, the drift will be split in multiple steps.

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.
entry_s	Returns:

Methods Summary

adjust_tracks_variables(tracks)
parse(stream)	TODO

Attributes Documentation

KEYWORD: str = 'DRIFT'

Keyword of the command used for the Zgoubi input data.

PARAMETERS: dict = {'APERTURE_BOTTOM': (<Quantity(10, 'centimeter')>, 'Aperture size of the magnet, bottom side (used for plotting only).'), 'APERTURE_LEFT': (<Quantity(10, 'centimeter')>, 'Aperture size of the magnet, left side (used for plotting only).'), 'APERTURE_RIGHT': (<Quantity(10, 'centimeter')>, 'Aperture size of the magnet, right side (used for plotting only).'), 'APERTURE_TOP': (<Quantity(10, 'centimeter')>, 'Aperture size of the magnet, top side (used for plotting only).'), 'COLOR': (None, 'Color used when plotting the element.'), 'HEIGHT': (<Quantity(20, 'centimeter')>, 'Height of the magnet (distance between poles), used by plotting functions.'), 'IL': (0, ''), 'KINEMATICS': (None, 'A kinematics object.'), 'LABEL1': ('', 'Primary label for the Zgoubi command (default: auto-generated hash).'), 'LABEL2': ('', 'Secondary label for the Zgoubi command.'), 'LENGTH_IS_ARC_LENGTH': (False, ''), 'PIPE_COLOR': ('grey', 'Color of the pipe, used by plotting functions.'), 'PIPE_THICKNESS': (<Quantity(2, 'centimeter')>, 'Thickness of the pipe, used by plotting functions.'), 'POLE_WIDTH': (<Quantity(30, 'centimeter')>, 'Pole width (used for plotting only).'), 'REFERENCE_FIELD_COMPONENT': ('BZ', 'Orientation of the reference field (used by field maps)'), 'SPLIT': (True, 'Split the drift in multiple steps.'), 'SPLITS': (10, 'If SPLITS > 1, the drift will be split in multiple steps.'), 'XL': (<Quantity(0, 'centimeter')>, 'Drift length')}

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

entry_s

Returns:

Methods Documentation

adjust_tracks_variables(tracks: pandas.core.frame.DataFrame)

classmethod parse(stream: str)

TODO