Dipoles¶
-
class
zgoubidoo.commands.magnetique.Dipoles(label1: str = '', label2: str = '', *params, **kwargs)[source]¶ Bases:
zgoubidoo.commands.magnetique.PolarMultiMagnetDipole magnet N-tuple, polar frame.
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='150 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
-
IL='0' Print field and coordinates along trajectories
- Type
int
-
N='1' Number of magnets (maximum 5).
- Type
int
-
AT='0.0 degree' Total angular extent of the N dipoles.
- Type
Quantity
-
RM='0.0 centimeter' Reference radius: mean radius used for the positioning of field boundaries
- Type
Quantity
-
ACN='[0.0 0.0 0.0 0.0 0.0] degree' Azimuth for dipole positioning
- Type
Quantity
-
DRM='[0.0 0.0 0.0 0.0 0.0] centimeter' Offset for the reference radius of each magnet : RM_i = RM +DELTA_RM
- Type
Quantity
-
B0='[0.0 0.0 0.0 0.0 0.0] kilogauss' Dipole fields of each magnets.
- Type
Quantity
-
BI='[[], [], [], [], []]' Lists of field coefficients for each magnets.
- Type
list
-
G0_E='[1e-08 0.0 0.0 0.0 0.0] centimeter' Reference gaps for the entrance fringe fields of each magnets.
- Type
Quantity
-
K_E='[0, 0, 0, 0, 0]' Fringe field parameter kappa
- Type
list
-
C0_E='[0, 0, 0, 0, 0]' Fringe field coefficient C0
- Type
list
-
C1_E='[1, 1, 1, 1, 1]' Fringe field coefficient C1
- Type
list
-
C2_E='[0, 0, 0, 0, 0]' Fringe field coefficient C2
- Type
list
-
C3_E='[0, 0, 0, 0, 0]' Fringe field coefficient C3
- Type
list
-
C4_E='[0, 0, 0, 0, 0]' Fringe field coefficient C4
- Type
list
-
C5_E='[0, 0, 0, 0, 0]' Fringe field coefficient C5
- Type
list
-
SHIFT_E='[0.0 0.0 0.0 0.0 0.0] centimeter' Shift of the EFB
- Type
Quantity
-
OMEGA_E='[0.0 0.0 0.0 0.0 0.0] degree' - Type
Quantity
-
THETA_E='[0.0 0.0 0.0 0.0 0.0] degree' Entrance face wedge angle
- Type
Quantity
-
R1_E='[1000000000.0 1000000000.0 1000000000.0 1000000000.0 1000000000.0] centimeter' Entrance EFB radius
- Type
Quantity
-
U1_E='[-1000000000.0 -1000000000.0 -1000000000.0 1000000000.0 1000000000.0] centimeter' Entrance EFB linear extent
- Type
Quantity
-
U2_E='[1000000000.0 1000000000.0 1000000000.0 1000000000.0 1000000000.0] centimeter' Entrance EFB linear extent
- Type
Quantity
-
R2_E='[1000000000.0 1000000000.0 1000000000.0 1000000000.0 1000000000.0] centimeter' Entrance EFB radius
- Type
Quantity
-
G0_S='[1e-08 0.0 0.0 0.0 0.0] centimeter' Reference gaps for the exit fringe fields of each magnet.
- Type
Quantity
-
K_S='[0, 0, 0, 0, 0]' Fringe field parameter kappa
- Type
list
-
C0_S='[0, 0, 0, 0, 0]' Fringe field coefficient C0
- Type
list
-
C1_S='[1, 1, 1, 1, 1]' Fringe field coefficient C1
- Type
list
-
C2_S='[0, 0, 0, 0, 0]' Fringe field coefficient C2
- Type
list
-
C3_S='[0, 0, 0, 0, 0]' Fringe field coefficient C3
- Type
list
-
C4_S='[0, 0, 0, 0, 0]' Fringe field coefficient C4
- Type
list
-
C5_S='[0, 0, 0, 0, 0]' Fringe field coefficient C5
- Type
list
-
SHIFT_S='[0.0 0.0 0.0 0.0 0.0] centimeter' Shift of the EFB
- Type
Quantity
-
OMEGA_S='[0.0 0.0 0.0 0.0 0.0] degree' - Type
Quantity
-
THETA_S='[0.0 0.0 0.0 0.0 0.0] degree' Entrance face wedge angle
- Type
Quantity
-
R1_S='[1000000000.0 1000000000.0 1000000000.0 1000000000.0 1000000000.0] centimeter' Exit EFB radius
- Type
Quantity
-
U1_S='[-1000000000.0 -1000000000.0 -1000000000.0 1000000000.0 1000000000.0] centimeter' Exit EFB linear extent
- Type
Quantity
-
U2_S='[1000000000.0 1000000000.0 1000000000.0 1000000000.0 1000000000.0] centimeter' Exit EFB linear extent
- Type
Quantity
-
R2_S='[1000000000.0 1000000000.0 1000000000.0 1000000000.0 1000000000.0] centimeter' Exit EFB radius
- Type
Quantity
-
G0_L='[0.0 0.0 0.0 0.0 0.0] centimeter' UNUSED Reference gaps for the lateral fringe fields of each dipole.
- Type
Quantity
-
K_L='[0, 0, 0, 0, 0]' UNUSED Fringe field parameter kappa
- Type
list
-
C0_L='[0, 0, 0, 0, 0]' UNUSED Fringe field coefficient C0
- Type
list
-
C1_L='[0, 0, 0, 0, 0]' UNUSED Fringe field coefficient C1
- Type
list
-
C2_L='[0, 0, 0, 0, 0]' UNUSED Fringe field coefficient C2
- Type
list
-
C3_L='[0, 0, 0, 0, 0]' UNUSED Fringe field coefficient C3
- Type
list
-
C4_L='[0, 0, 0, 0, 0]' UNUSED Fringe field coefficient C4
- Type
list
-
C5_L='[0, 0, 0, 0, 0]' UNUSED Fringe field coefficient C5
- Type
list
-
SHIFT_L='[0.0 0.0 0.0 0.0 0.0] centimeter' UNUSED Shift of the EFB
- Type
Quantity
-
OMEGA_L='[0.0 0.0 0.0 0.0 0.0] degree' UNUSED
- Type
Quantity
-
THETA_L='[0.0 0.0 0.0 0.0 0.0] degree' UNUSED Entrance face wedge angle
- Type
Quantity
-
R1_L='[0.0 0.0 0.0 0.0 0.0] centimeter' UNUSED Lateral EFB radius
- Type
Quantity
-
U1_L='[0.0 0.0 0.0 0.0 0.0] centimeter' UNUSED Lateral EFB linear extent
- Type
Quantity
-
U2_L='[0.0 0.0 0.0 0.0 0.0] centimeter' UNUSED Lateral EFB linear extent
- Type
Quantity
-
R2_L='[0.0 0.0 0.0 0.0 0.0] centimeter' UNUSED Lateral EFB radius
- Type
Quantity
-
RM3='[0.0 0.0 0.0 0.0 0.0] centimeter' Unused.
- Type
Quantity
-
KIRD='2' Analytical computation (KIRD = 0) or numerical interpolation (KIRD = 2,4, 25) of field derivatives
- Type
int
-
RESOL='2' - Type
int
-
XPAS='1.0 millimeter' Integration step
- Type
Quantity
-
KPOS='2' - Type
int
-
RE='0.0 centimeter' - Type
Quantity
-
TE='0.0 radian' - Type
Quantity
-
RS='0.0 centimeter' - Type
Quantity
-
TS='0.0 radian' - Type
Quantity
-
DP='0.0' - Type
float
Default initializer for all Commands.
Attributes Summary
Keyword of the command used for the Zgoubi input data.
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 = 'DIPOLES'¶ Keyword of the command used for the Zgoubi input data.
-
PARAMETERS: dict = {'ACN': (<Quantity([0. 0. 0. 0. 0.], 'degree')>, 'Azimuth for dipole positioning', 5), '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).'), 'AT': (<Quantity(0.0, 'degree')>, 'Total angular extent of the N dipoles.', 3), 'B0': (<Quantity([0. 0. 0. 0. 0.], 'kilogauss')>, 'Dipole fields of each magnets.', 7), 'BI': ([[], [], [], [], []], 'Lists of field coefficients for each magnets.', 8), 'C0_E': ([0, 0, 0, 0, 0], 'Fringe field coefficient C0', 12), 'C0_L': ([0, 0, 0, 0, 0], 'UNUSED Fringe field coefficient C0', 44), 'C0_S': ([0, 0, 0, 0, 0], 'Fringe field coefficient C0', 28), 'C1_E': ([1, 1, 1, 1, 1], 'Fringe field coefficient C1', 13), 'C1_L': ([0, 0, 0, 0, 0], 'UNUSED Fringe field coefficient C1', 45), 'C1_S': ([1, 1, 1, 1, 1], 'Fringe field coefficient C1', 29), 'C2_E': ([0, 0, 0, 0, 0], 'Fringe field coefficient C2', 14), 'C2_L': ([0, 0, 0, 0, 0], 'UNUSED Fringe field coefficient C2', 46), 'C2_S': ([0, 0, 0, 0, 0], 'Fringe field coefficient C2', 30), 'C3_E': ([0, 0, 0, 0, 0], 'Fringe field coefficient C3', 15), 'C3_L': ([0, 0, 0, 0, 0], 'UNUSED Fringe field coefficient C3', 47), 'C3_S': ([0, 0, 0, 0, 0], 'Fringe field coefficient C3', 31), 'C4_E': ([0, 0, 0, 0, 0], 'Fringe field coefficient C4', 16), 'C4_L': ([0, 0, 0, 0, 0], 'UNUSED Fringe field coefficient C4', 48), 'C4_S': ([0, 0, 0, 0, 0], 'Fringe field coefficient C4', 32), 'C5_E': ([0, 0, 0, 0, 0], 'Fringe field coefficient C5', 17), 'C5_L': ([0, 0, 0, 0, 0], 'UNUSED Fringe field coefficient C5', 49), 'C5_S': ([0, 0, 0, 0, 0], 'Fringe field coefficient C5', 33), 'COLOR': ('#4169E1',), 'DP': (0.0, '', 62), 'DRM': (<Quantity([0. 0. 0. 0. 0.], 'centimeter')>, 'Offset for the reference radius of each magnet : RM_i = RM +DELTA_RM', 6), 'G0_E': (<Quantity([1.e-08 0.e+00 0.e+00 0.e+00 0.e+00], 'centimeter')>, 'Reference gaps for the entrance fringe fields of each magnets.', 9), 'G0_L': (<Quantity([0. 0. 0. 0. 0.], 'centimeter')>, 'UNUSED Reference gaps for the lateral fringe fields of each dipole.', 41), 'G0_S': (<Quantity([1.e-08 0.e+00 0.e+00 0.e+00 0.e+00], 'centimeter')>, 'Reference gaps for the exit fringe fields of each magnet.', 25), '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.'), 'KIRD': (2, 'Analytical computation (KIRD = 0) or numerical interpolation (KIRD = 2,4, 25) of field derivatives', 58), 'KPOS': (2, '', 61), 'K_E': ([0, 0, 0, 0, 0], 'Fringe field parameter kappa', 10), 'K_L': ([0, 0, 0, 0, 0], 'UNUSED Fringe field parameter kappa', 42), 'K_S': ([0, 0, 0, 0, 0], 'Fringe field parameter kappa', 26), 'LABEL1': ('', 'Primary label for the Zgoubi command (default: auto-generated hash).'), 'LABEL2': ('', 'Secondary label for the Zgoubi command.'), 'N': (1, 'Number of magnets (maximum 5).', 2), 'OMEGA_E': (<Quantity([0. 0. 0. 0. 0.], 'degree')>, '', 19), 'OMEGA_L': (<Quantity([0. 0. 0. 0. 0.], 'degree')>, 'UNUSED ', 51), 'OMEGA_S': (<Quantity([0. 0. 0. 0. 0.], 'degree')>, '', 35), '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(150, 'centimeter')>, 'Pole width (used for plotting only).'), 'R1_E': (<Quantity([1.e+09 1.e+09 1.e+09 1.e+09 1.e+09], 'centimeter')>, 'Entrance EFB radius', 21), 'R1_L': (<Quantity([0. 0. 0. 0. 0.], 'centimeter')>, 'UNUSED Lateral EFB radius', 53), 'R1_S': (<Quantity([1.e+09 1.e+09 1.e+09 1.e+09 1.e+09], 'centimeter')>, 'Exit EFB radius', 37), 'R2_E': (<Quantity([1.e+09 1.e+09 1.e+09 1.e+09 1.e+09], 'centimeter')>, 'Entrance EFB radius', 24), 'R2_L': (<Quantity([0. 0. 0. 0. 0.], 'centimeter')>, 'UNUSED Lateral EFB radius', 56), 'R2_S': (<Quantity([1.e+09 1.e+09 1.e+09 1.e+09 1.e+09], 'centimeter')>, 'Exit EFB radius', 40), 'RE': (<Quantity(0.0, 'centimeter')>, '', 62), 'REFERENCE_FIELD_COMPONENT': ('BZ', 'Orientation of the reference field (used by field maps)'), 'RESOL': (2, '', 59), 'RM': (<Quantity(0.0, 'centimeter')>, 'Reference radius: mean radius used for the positioning of field boundaries', 4), 'RM3': (<Quantity([0. 0. 0. 0. 0.], 'centimeter')>, 'Unused.', 57), 'RS': (<Quantity(0.0, 'centimeter')>, '', 64), 'SHIFT_E': (<Quantity([0. 0. 0. 0. 0.], 'centimeter')>, 'Shift of the EFB', 18), 'SHIFT_L': (<Quantity([0. 0. 0. 0. 0.], 'centimeter')>, 'UNUSED Shift of the EFB', 50), 'SHIFT_S': (<Quantity([0. 0. 0. 0. 0.], 'centimeter')>, 'Shift of the EFB', 34), 'TE': (<Quantity(0.0, 'radian')>, '', 63), 'THETA_E': (<Quantity([0. 0. 0. 0. 0.], 'degree')>, 'Entrance face wedge angle', 20), 'THETA_L': (<Quantity([0. 0. 0. 0. 0.], 'degree')>, 'UNUSED Entrance face wedge angle', 52), 'THETA_S': (<Quantity([0. 0. 0. 0. 0.], 'degree')>, 'Entrance face wedge angle', 36), 'TS': (<Quantity(0.0, 'radian')>, '', 65), 'U1_E': (<Quantity([-1.e+09 -1.e+09 -1.e+09 1.e+09 1.e+09], 'centimeter')>, 'Entrance EFB linear extent', 22), 'U1_L': (<Quantity([0. 0. 0. 0. 0.], 'centimeter')>, 'UNUSED Lateral EFB linear extent', 54), 'U1_S': (<Quantity([-1.e+09 -1.e+09 -1.e+09 1.e+09 1.e+09], 'centimeter')>, 'Exit EFB linear extent', 38), 'U2_E': (<Quantity([1.e+09 1.e+09 1.e+09 1.e+09 1.e+09], 'centimeter')>, 'Entrance EFB linear extent', 23), 'U2_L': (<Quantity([0. 0. 0. 0. 0.], 'centimeter')>, 'UNUSED Lateral EFB linear extent', 55), 'U2_S': (<Quantity([1.e+09 1.e+09 1.e+09 1.e+09 1.e+09], 'centimeter')>, 'Exit EFB linear extent', 39), 'XPAS': (<Quantity(1.0, 'millimeter')>, 'Integration step', 60)}¶ Parameters of the command, with their default value, their description and optinally an index used by other commands (e.g. fit).
Methods Documentation
-