Bend

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

Bases: zgoubidoo.commands.magnetique.CartesianMagnet

Bending magnet, Cartesian frame.

Note

This is mostly a sector bend element defined in cartesian coordinates.

Zgoubi manual description

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='#4169E1'

Magnet color for plotting.

Type

str

LENGTH_IS_ARC_LENGTH='True'

Type

bool

IL='0'

Print field and coordinates along trajectories

Type

int

XL='0.0 centimeter'

Magnet length (straight reference frame)

Type

Quantity

SK='0.0 radian'

Skew angle

Type

Quantity

B1='0.0 kilogauss'

Dipole field

Type

Quantity

X_E='0.0 centimeter'

Integration zone extension (entrance face)

Type

Quantity

LAM_E='0.0 centimeter'

Fringe field extension (entrance face)

Type

Quantity

W_E='0.0 radian'

Wedge angle (entrance face)

Type

Quantity

C0_E='0.0'

Entrance fringe field coefficient C0

Type

float

C1_E='1.0'

Entrance fringe field coefficient C1

Type

float

C2_E='0.0'

Entrance fringe field coefficient C2

Type

float

C3_E='0.0'

Entrance fringe field coefficient C3

Type

float

C4_E='0.0'

Entrance fringe field coefficient C4

Type

float

C5_E='0.0'

Entrance fringe field coefficient C5

Type

float

X_S='0.0 centimeter'

Integration zone extension (exit face)

Type

Quantity

LAM_S='0.0 centimeter'

Fringe field extension (exit face)

Type

Quantity

W_S='0.0 radian'

Wedge angle (exit face)

Type

Quantity

C0_S='0.0'

Exit fringe field coefficient C0

Type

float

C1_S='1.0'

Exit fringe field coefficient C1

Type

float

C2_S='0.0'

Exit fringe field coefficient C2

Type

float

C3_S='0.0'

Exit fringe field coefficient C3

Type

float

C4_S='0.0'

Exit fringe field coefficient C4

Type

float

C5_S='0.0'

Exit fringe field coefficient C5

Type

float

XPAS='1.0 centimeter'

Integration step

Type

Quantity

KPOS='2'

Alignment parameter

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.

Methods Summary

post_init(**kwargs)

param **kwargs

Attributes Documentation

KEYWORD: str = 'BEND'

Keyword of the command used for the Zgoubi input data.

PARAMETERS: dict = {'ALE': (<Quantity(0.0, 'radian')>,), '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).'), 'B1': (<Quantity(0.0, 'kilogauss')>, 'Dipole field', 12), 'C0_E': (0.0, 'Entrance fringe field coefficient C0'), 'C0_S': (0.0, 'Exit fringe field coefficient C0'), 'C1_E': (1.0, 'Entrance fringe field coefficient C1'), 'C1_S': (1.0, 'Exit fringe field coefficient C1'), 'C2_E': (0.0, 'Entrance fringe field coefficient C2'), 'C2_S': (0.0, 'Exit fringe field coefficient C2'), 'C3_E': (0.0, 'Entrance fringe field coefficient C3'), 'C3_S': (0.0, 'Exit fringe field coefficient C3'), 'C4_E': (0.0, 'Entrance fringe field coefficient C4'), 'C4_S': (0.0, 'Exit fringe field coefficient C4'), 'C5_E': (0.0, 'Entrance fringe field coefficient C5'), 'C5_S': (0.0, 'Exit fringe field coefficient C5'), 'COLOR': ('#4169E1', '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': (2, 'Alignment parameter'), 'LABEL1': ('', 'Primary label for the Zgoubi command (default: auto-generated hash).'), 'LABEL2': ('', 'Secondary label for the Zgoubi command.'), 'LAM_E': (<Quantity(0.0, 'centimeter')>, 'Fringe field extension (entrance face)'), 'LAM_S': (<Quantity(0.0, 'centimeter')>, 'Fringe field extension (exit face)'), 'LENGTH_IS_ARC_LENGTH': (True, ''), '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)'), 'SK': (<Quantity(0.0, 'radian')>, 'Skew angle', 11), 'W_E': (<Quantity(0.0, 'radian')>, 'Wedge angle (entrance face)'), 'W_S': (<Quantity(0.0, 'radian')>, 'Wedge angle (exit face)'), 'XCE': (<Quantity(0.0, 'centimeter')>,), 'XL': (<Quantity(0.0, 'centimeter')>, 'Magnet length (straight reference frame)', 10), 'XPAS': (<Quantity(1.0, 'centimeter')>, 'Integration step'), 'X_E': (<Quantity(0.0, 'centimeter')>, 'Integration zone extension (entrance face)'), 'X_S': (<Quantity(0.0, 'centimeter')>, 'Integration zone extension (exit face)'), 'YCE': (<Quantity(0.0, 'centimeter')>,)}

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

Methods Documentation

post_init(**kwargs)

Parameters

**kwargs –

Returns: