CartesianMagnet¶

class zgoubidoo.commands.magnetique.CartesianMagnet(label1: str = '', label2: str = '', *params, **kwargs)[source]¶

Bases: zgoubidoo.commands.magnetique.Magnet

Base class for magnetic elements in cartesian coordinates.

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='black'

Magnet color for plotting.

Type: str

LENGTH_IS_ARC_LENGTH='False'

Type: bool

Default initializer for all Commands.

Attributes Summary

`PARAMETERS`	Parameters of the command, with their default value, their description and optinally an index used by other commands (e.g.
`entry_patched`	Returns:
`exit`	Returns:
`exit_patched`	Returns:
`length`	Returns:
`rotation`	Returns:
`x_offset`	Returns:
`y_offset`	Returns:

Methods Summary

post_init(**kwargs)

param field_map

Attributes Documentation

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': ('black', 'Magnet color for plotting.'), 'HEIGHT': (<Quantity(20, 'centimeter')>, 'Height of the magnet (distance between poles), used by plotting functions.'), '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)')}¶: Parameters of the command, with their default value, their description and optinally an index used by other commands (e.g. fit).

entry_patched¶: Returns:

exit¶: Returns:

exit_patched¶: Returns:

length¶: Returns:

rotation¶: Returns:

x_offset¶: Returns:

y_offset¶: Returns:

Methods Documentation

post_init(**kwargs)[source]¶

Parameters

field_map –
**kwargs –

Returns: