happi.containers.IPM

class happi.containers.IPM(**kwargs)

Beam intensity monitors. These are often used as a sanity check for beam presence, though they can also be used to track shot to shot intensity and estimate beam position. These devices have a data attribute in addition to the standard entries to link the device with its scalar output. These devices will be assigned the diagnostic system by default.

prefix

str – The base PV should be the prefix one level up from the diode and target state PVs. Note that this is NOT the motor record, it is neither the diode nor the target state PV, and it may not even be a valid PV name. For example, if the command PV to set the target position to a state is “XPP:SB3:IPM:TARGET:GO” and the command PV to move the diode to a state is “XPP:SB3:IPM:DIODE:GO”, then the base PV is the shared prefix “XPP:SB3:IPM”. A regex will be used to check that “IPM” is found in the base PV.

data

str – The data PV should be the IPM PV that most reliably predicts beam prescence. This will, in general, be the sum of the channels.

z

float – If the diode and target have subtly different recorded z-positions, use the diode position for the purposes of this database.

__init__(**kwargs)

Methods

__init__(**kwargs)
post()	Create a document to be loaded into the happi database
save()	Overwritten when the device is loaded from the client
show_info([handle])	Show the device information in a PrettyTable