Quadrupole

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

Bases: zgoubidoo.commands.magnetique.CartesianMagnet

Quadrupole magnet.

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

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='#FF0000'

Magnet color for plotting.

Type

str

LENGTH_IS_ARC_LENGTH='False'

Type

bool

IL='0'

Print field and coordinates along trajectories

Type

int

XL='0 centimeter'

Magnet length

Type

Quantity

R0='1.0 centimeter'

Radius of the pole tips

Type

Quantity

B0='0 kilogauss'

Field at pole tips

Type

Quantity

X_E='0 centimeter'

Entrance face integration zone for the fringe field

Type

Quantity

LAM_E='0 centimeter'

Entrance face fringe field extent

Type

Quantity

C0_E='0'

Fringe field coefficient C0

Type

int

C1_E='1'

Fringe field coefficient C1

Type

int

C2_E='0'

Fringe field coefficient C2

Type

int

C3_E='0'

Fringe field coefficient C3

Type

int

C4_E='0'

Fringe field coefficient C4

Type

int

C5_E='0'

Fringe field coefficient C5

Type

int

X_S='0 centimeter'

Exit face integration zone for the fringe field

Type

Quantity

LAM_S='0 centimeter'

Exit face fringe field extent

Type

Quantity

C0_S='0'

Fringe field coefficient C0

Type

int

C1_S='1'

Fringe field coefficient C1

Type

int

C2_S='0'

Fringe field coefficient C2

Type

int

C3_S='0'

Fringe field coefficient C3

Type

int

C4_S='0'

Fringe field coefficient C4

Type

int

C5_S='0'

Fringe field coefficient C5

Type

int

XPAS='0.1 centimeter'

Integration step

Type

Quantity

KPOS='1'

Misalignment type

Type

int

XCE='0 centimeter'

x offset

Type

Quantity

YCE='0 centimeter'

y offset

Type

Quantity

ALE='0 radian'

misalignment rotation

Type

Quantity

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.
gradient	Quadrupolar gradient (field at pole tip divided by the bore radius.

Methods Summary

post_init(**kwargs)

param **kwargs

Attributes Documentation

KEYWORD: str = 'QUADRUPO'

Keyword of the command used for the Zgoubi input data.

PARAMETERS: dict = {'ALE': (<Quantity(0, 'radian')>, 'misalignment rotation', 73), '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).'), 'B0': (<Quantity(0, 'kilogauss')>, 'Field at pole tips', 12), 'C0_E': (0, 'Fringe field coefficient C0', 31), 'C0_S': (0, 'Fringe field coefficient C0', 51), 'C1_E': (1, 'Fringe field coefficient C1', 32), 'C1_S': (1, 'Fringe field coefficient C1', 52), 'C2_E': (0, 'Fringe field coefficient C2', 33), 'C2_S': (0, 'Fringe field coefficient C2', 53), 'C3_E': (0, 'Fringe field coefficient C3', 34), 'C3_S': (0, 'Fringe field coefficient C3', 54), 'C4_E': (0, 'Fringe field coefficient C4', 35), 'C4_S': (0, 'Fringe field coefficient C4', 55), 'C5_E': (0, 'Fringe field coefficient C5', 36), 'C5_S': (0, 'Fringe field coefficient C5', 56), 'COLOR': ('#FF0000', 'Magnet color for plotting.'), 'HEIGHT': (<Quantity(20, 'centimeter')>, 'Height of the magnet (distance between poles), used by plotting functions.'), 'IL': (0, 'Print field and coordinates along trajectories', 1), 'KINEMATICS': (None, 'A kinematics object.'), 'KPOS': (1, 'Misalignment type', 70), 'LABEL1': ('', 'Primary label for the Zgoubi command (default: auto-generated hash).'), 'LABEL2': ('', 'Secondary label for the Zgoubi command.'), 'LAM_E': (<Quantity(0, 'centimeter')>, 'Entrance face fringe field extent', 21), 'LAM_S': (<Quantity(0, 'centimeter')>, 'Exit face fringe field extent', 41), '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).'), 'R0': (<Quantity(1.0, 'centimeter')>, 'Radius of the pole tips', 11), 'REFERENCE_FIELD_COMPONENT': ('BZ', 'Orientation of the reference field (used by field maps)'), 'XCE': (<Quantity(0, 'centimeter')>, 'x offset', 71), 'XL': (<Quantity(0, 'centimeter')>, 'Magnet length', 10), 'XPAS': (<Quantity(0.1, 'centimeter')>, 'Integration step', 60), 'X_E': (<Quantity(0, 'centimeter')>, 'Entrance face integration zone for the fringe field', 20), 'X_S': (<Quantity(0, 'centimeter')>, 'Exit face integration zone for the fringe field', 40), 'YCE': (<Quantity(0, 'centimeter')>, 'y offset', 72)}

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

gradient

Quadrupolar gradient (field at pole tip divided by the bore radius.

Methods Documentation

post_init(**kwargs)

Parameters

**kwargs –

Returns: