Bpm documentation

`Bpm(in_parameters=None, index=None)`

Bases: Element

A class used to store the BPM 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 "Bpm".

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", "resolution", "reading_x", "reading_y", 
"transmitted_charge", "scale_x", "scale_y", "store_bunches", "hcorrector", 
"hcorrector_step_size", "vcorrector", "vcorrector_step_size"]

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`