DipoleM¶
-
class
zgoubidoo.commands.magnetique.DipoleM(label1: str = '', label2: str = '', *params, **kwargs)[source]¶ Bases:
zgoubidoo.commands.magnetique.PolarMagnetTODO.
Zgoubi manual description
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
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.
Attributes Documentation
-
KEYWORD: str = 'DIPOLE-M'¶ Keyword of the command used for the Zgoubi input data.
-
PARAMETERS: dict = {'ACENT': (0,), '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': (0,), 'B': (0,), 'B0': (<Quantity(0, 'kilogauss')>,), 'C0_E': (0,), 'C0_L': (0,), 'C0_S': (0,), 'C1_E': (0,), 'C1_L': (0,), 'C1_S': (0,), 'C2_E': (0,), 'C2_L': (0,), 'C2_S': (0,), 'C3_E': (0,), 'C3_L': (0,), 'C3_S': (0,), 'C4_E': (0,), 'C4_L': (0,), 'C4_S': (0,), 'C5_E': (0,), 'C5_L': (0,), 'C5_S': (0,), 'COLOR': ('blue',), 'DELTAB': (0,), 'DP': (0,), 'G': (0,), 'HEIGHT': (<Quantity(20, 'centimeter')>, 'Height of the magnet (distance between poles), used by plotting functions.'), 'IAMAX': (0,), 'IC': (0,), 'IL': (0,), 'IORDRE': (4,), 'IRMAX': (0,), 'KINEMATICS': (None, 'A kinematics object.'), 'KPOS': (2,), 'LABEL1': ('', 'Primary label for the Zgoubi command (default: auto-generated hash).'), 'LABEL2': ('', 'Secondary label for the Zgoubi command.'), 'LAM_E': (0,), 'LAM_L': (0,), 'LAM_S': (0,), 'N': (0,), 'NBS': (0,), 'NCE': (0,), 'NCL': (0,), 'NCS': (0,), 'NFACE': (2,), 'OMEGA_E': (0,), 'OMEGA_L': (0,), 'OMEGA_S': (0,), '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).'), 'R0': (0,), 'R1_E': (1000000000.0,), 'R1_L': (1000000000.0,), 'R1_S': (1000000000.0,), 'R2_E': (1000000000.0,), 'R2_L': (1000000000.0,), 'R2_S': (1000000000.0,), 'RE': (0,), 'REFERENCE_FIELD_COMPONENT': ('BZ', 'Orientation of the reference field (used by field maps)'), 'RM': (0,), 'RM3': (0,), 'RMAX': (0,), 'RMIN': (0,), 'RS': (0,), 'SHIFT_E': (0,), 'SHIFT_L': (0,), 'SHIFT_S': (0,), 'SHIM_ALPHA': [], 'SHIM_BETA': [], 'SHIM_GAMMA': [], 'SHIM_LAMBDA': [], 'SHIM_MU': [], 'SHIM_R1': [], 'SHIM_R2': [], 'SHIM_THETA1': [], 'SHIM_THETA2': [], 'TE': (0,), 'THETA_0': (0,), 'THETA_E': (0,), 'THETA_L': (0,), 'THETA_S': (0,), 'TS': (0,), 'U1_E': (-1000000000.0,), 'U1_L': (-1000000000.0,), 'U1_S': (-1000000000.0,), 'U2_E': (1000000000.0,), 'U2_L': (1000000000.0,), 'U2_S': (1000000000.0,), 'XI_E': (0,), 'XI_L': (0,), 'XI_S': (0,), 'XPAS': (0.1,)}¶ Parameters of the command, with their default value, their description and optinally an index used by other commands (e.g. fit).
-