structure module

Define helper functions to visualize elements.

Todo

Information on the objective under the cursor (hover).

patch_kwargs(elt, x_axis, idx=None, color=None, alpha=None, pos='in')

Give kwargs for the patch function.

In particular: position and color.

Parameters:

• elt (Element) – The element corresponding to the patch.

• x_axis (Literal['z_abs', 'elt_idx']) – Nature of current x axis.

• idx (int | None, default: None) – Element index.

• color (tuple[float, float, float] | str | tuple[float, float, float, float] | tuple[tuple[float, float, float] | str, float] | tuple[tuple[float, float, float, float], float] | None, default: None) – Color the patch.

• alpha (float | None, default: None) – Transparency of the patch.

• pos (Literal['in', 'out'], default: 'in') – Where the patch should start. Set it to "out" to mark an Objective position, which are generally evaluated at the exit of an Element.

Return type:

dict[str, Any]

_limits(elts, x_axis)

Give the limits of the plot.

Parameters:

• elts (ListOfElements)

• x_axis (Literal['z_abs', 'elt_idx'])

Return type:

tuple[float, float]

plot_structure(elts, ax, x_axis='z_abs')

Plot structure of the linac under study.

Parameters:

• elts (ListOfElements)

• ax (Axes)

• x_axis (Literal['z_abs', 'elt_idx'], default: 'z_abs')

Return type:

None

_plot_aperture(x_0, width, **kwargs)

Add a thin line to show an aperture.

Parameters:

• x_0 (float)

• width (float)

Return type:

Rectangle

_plot_bend(x_0, width, **kwargs)

Add a greyed rectangle to show a bend.

Parameters:

• x_0 (float)

• width (float)

Return type:

Rectangle

_plot_drift(x_0, width, **kwargs)

Add a little rectangle to show a drift.

Parameters:

• x_0 (float)

• width (float)

Return type:

Rectangle

_plot_field_map(x_0, width, elt, **kwargs)

Add an ellipse to show a field_map.

Parameters:

• x_0 (float)

• width (float)

• elt (FieldMap)

Return type:

Ellipse

_plot_edge(x_0, width, **kwargs)

Add a thin line to show an edge.

Parameters:

• x_0 (float)

• width (float)

Return type:

Rectangle

_plot_quad(x_0, width, **kwargs)

Add a crossed large rectangle to show a quad.

Parameters:

• x_0 (float)

• width (float)

Return type:

Polygon

outline_sections(elts, ax, x_axis='z_abs')

Add light grey rectangles behind the plot to show the sections.

Parameters:

• elts (ListOfElements)

• ax (Axes)

• x_axis (Literal['z_abs', 'elt_idx'] | Literal['last_elt_of_sec'], default: 'z_abs')

Return type:

None