CartesianMesh¶

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

Bases: zgoubidoo.commands.commands.Command

2-D Cartesian uniform mesh magnetic field map.

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

IC='2'

Print the map

Type: int

IL='2'

Print field and coordinates along trajectories

Type: int

BNORM='1.0'

Field normalization coefficient

Type: float

XN='1.0'

X coordinate normalization coefficient

Type: float

YN='1.0'

Y coordinate normalization coefficient

Type: float

TITL='CARTEMES_FIELD_MAP'

Title. Start with ‘FLIP’ to get field map X-flipped

Type: str

IX='1'

Number of longitudinal nodes of the map

Type: int

JY='1'

Number of transverse nodes of the map

Type: int

FNAME='field_map.map'

File name

Type: str

ID='0'

Integration boundary

Type: int

IORDRE='25'

Degree of interpolation polynomial

Type: int

XPAS='1 centimeter'

Integration step

Type: Quantity

KPOS='1'

Alignment

Type: int

XCE='0 centimeter'

Misalignment X shift

Type: Quantity

YCE='0 centimeter'

Misalignment Y shift

Type: Quantity

ALE='0 radian'

Misalignment tilt

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.

Attributes Documentation

KEYWORD: str = 'CARTEMES'¶: Keyword of the command used for the Zgoubi input data.

PARAMETERS: dict = {'A': (0.0,), 'ALE': (<Quantity(0, 'radian')>, 'Misalignment tilt'), 'AP': [0.0], 'B': (0.0,), 'BNORM': (1.0, 'Field normalization coefficient'), 'BP': [0.0], 'C': (0.0,), 'CP': [0.0], 'FNAME': ('field_map.map', 'File name'), 'IC': (2, 'Print the map'), 'ID': (0, 'Integration boundary'), 'IL': (2, 'Print field and coordinates along trajectories'), 'IORDRE': (25, 'Degree of interpolation polynomial'), 'IX': (1, 'Number of longitudinal nodes of the map'), 'JY': (1, 'Number of transverse nodes of the map'), 'KPOS': (1, 'Alignment'), 'LABEL1': ('', 'Primary label for the Zgoubi command (default: auto-generated hash).'), 'LABEL2': ('', 'Secondary label for the Zgoubi command.'), 'TITL': ('CARTEMES_FIELD_MAP', "Title. Start with 'FLIP' to get field map X-flipped"), 'XCE': (<Quantity(0, 'centimeter')>, 'Misalignment X shift'), 'XN': (1.0, 'X coordinate normalization coefficient'), 'XPAS': (<Quantity(1, 'centimeter')>, 'Integration step'), 'YCE': (<Quantity(0, 'centimeter')>, 'Misalignment Y shift'), 'YN': (1.0, 'Y coordinate normalization coefficient')}¶: Parameters of the command, with their default value, their description and optinally an index used by other commands (e.g. fit).