Cavity documentation

`Cavity(in_parameters=None, index=None, **extra_params)`

Bases: Element

A class used to store the cavity information.

Attributes:

Name	Type	Description
`settings`	`dict`	Dictionary containing the element settings.
`girder`	`Optional[Girder]`	The girder reference the `Element` is placed on. This parameter is only relevant when being the part of the lattice. Upon creation is set to `None`.
`type`	`str`	The type of the element. It is set to "Cavity".

The list of acceptable settings:

["name", "comment", "s", "x", "y", "xp", "yp", "roll", "tilt", "tilt_deg", 
"length", "synrad", "six_dim", "thin_lens", "e0", "aperture_x", "aperture_y", 
"aperture_losses", "aperture_shape", "tclcall_entrance", "tclcall_exit", 
"short_range_wake", "gradient", "phase", "type", "lambda", "frequency", 
"bookshelf_x", "bookshelf_y", "bookshelf_phase", "bpm_offset_x", "bpm_offset_y", 
"bpm_reading_x", "bpm_reading_y", "dipole_kick_x", "dipole_kick_y", "pi_mode"]

Parameters:

Name	Type	Description	Default
`in_parameters`	`Optional[dict]`	The dict with input settings.	`None`
`girder`		The number of the girder element is placed.	required
`index`	`Optional[int]`	The index of the element in the lattice.	`None`

Other Parameters:

Name	Type	Description
`angle`	`bool`	If `True` (default is `True`), the phase is given in degrees, otherwise radians.

`to_placet()`

Convert the element to a Placet readable format.

Returns:

Type	Description
`str`	The string containing the element