Patchable¶

class zgoubidoo.commands.patchable.Patchable[source]¶

Bases: object

Patchable elements are Zgoubi commands that affect the placement of the reference frame.

A default implementation of the placement methods is provided for subclasses. It only places the entrance frame at the location of the placement frame and all other frames are set to the entrance frame (‘point-like’ element).

Initializes a un-patched patchable element.

Attributes Summary

`center`	Center frame.
`entry`	Entrance frame.
`entry_patched`	Entrance patched frame.
`entry_s`	Returns:
`exit`	Exit frame.
`exit_patched`	Exit patched frame.
`exit_s`	Returns:
`frenet_orientation`
`length`	Length of the element.
`optical_length`	Returns:
`reference_trajectory`	Returns:

Methods Summary

`adjust_tracks_variables`(tracks)
`clear_placement`()	Clears all the frames.
`place`(frame)	Place the element with a reference frame.

Attributes Documentation

center¶

Center frame.

Returns: the frame of the center of the element.

entry¶

Entrance frame.

Returns: the frame of the entrance of the element.

entry_patched¶

Entrance patched frame.

Returns: the frame of the entrance of the element with the patch applied.

entry_s¶: Returns:

exit¶

Exit frame.

Returns: the frame of the exit of the element.

exit_patched¶

Exit patched frame.

Returns: the frame of the exit of the element with the patch applied.

exit_s¶: Returns:

frenet_orientation¶

length¶

Length of the element.

Returns: the length of the element with units.

optical_length¶: Returns:

reference_trajectory¶: Returns:

Methods Documentation

adjust_tracks_variables(tracks: pandas.core.frame.DataFrame)[source]¶

clear_placement()[source]¶: Clears all the frames.

place(frame: georges_core.frame.Frame)[source]¶

Place the element with a reference frame.

All the frames of the element are reset and the entrance frame is then placed with respect to the reference frame.

Parameters: frame – the reference frame for the placement of the entrance frame.