class YAQItem(HappiItem):
port = EntryInfo("TCP port.", enforce=int, optional=False)
host = EntryInfo("Host.", optional=True, default="localhost")
kwargs = copy.copy(HappiItem.kwargs)
kwargs.default = {
"port": "{{port}}",
"host": "{{host}}",
"name": "{{name}}"
}
device_class = EntryInfo(default="yaqc_bluesky.Device")
class StraightLineOrientation(HappiItem):
#offsets, pitches, tilts
TILT = EntryInfo('Rotation of the element in the x,y plane', optional=True, enforce=float)
X_PITCH = EntryInfo('Rotation about the element center s.t. exit face is diplaced in the corresponding x direction', optional=True, enforce=float)
Y_PITCH = EntryInfo('Rotation about the element center s.t. exit face is diplaced in the corresponding y direction', optional=True, enforce=float)
X_OFFSET = EntryInfo('Translation of element in the local x direction', optional=True, enforce=float)
Y_OFFSET = EntryInfo('Translation of element in the local y direction', optional=True, enforce=float)
Z_OFFSET = EntryInfo('Translation of element in the local z direction', optional=True, enforce=float)
class ApertureLimits(HappiItem):
X1_LIMIT = EntryInfo('Horizontal, negative side, aperture limit', optional=True, enforce=float)
X2_LIMIT = EntryInfo('Horizontal, positive side, aperture limit', optional=True, enforce=float)
Y1_LIMIT = EntryInfo('Vertical, negative side, aperture limit', optional=True, enforce=float)
Y2_LIMIT = EntryInfo('Vertical, positive side, aperture limit', optional=True, enforce=float)
# maybe
APERTURE_AT = EntryInfo('What end is the aperture at', optional=True, enforce=str)
APERTURE_TYPE = EntryInfo('What type of aperture is this', optional=True, enforce=str)
class Wiggler(Base, Length, StraightLineOrientation, Kick, ApertureLimits, Floor):
element_type = "wiggler"
B_MAX = EntryInfo('Maximum magnetic field on the wiggler centerline', optional=True, enforce=float)
L_PERIOD = EntryInfo('Length over which field vector returns to the same orientation', optional=True, enforce=float)
N_PERIOD = EntryInfo('The number of periods', optional=True, enforce=float)
POLARITY = EntryInfo('For scaling the field', optional=True, enforce=float)
#KX = EntryInfo('Planar wiggler horizontal wave number', optional=True, enforce=float)
#K1X = EntryInfo('Planar wiggler horizontal defocusing strength', optional=True, enforce=float)
#k1y = EntryInfo('Planar wiggler vertical focusing strength', optional=True, enforce=float)
G_MAX = EntryInfo('Maximum bending strength', optional=True, enforce=float)
OSC_AMPLITUDE = EntryInfo('Amplitude of the particle oscillations', optional=True, enforce=float)
class GirderBendExtension(GirderExtension):
TILT_TOT = EntryInfo('Rotation of bend around the z axis including Girder orientation', optional=True, enforce=float)
class GirderExtension(HappiItem):
X_PITCH_TOT = EntryInfo('Rotation about the element center s.t. exit face is diplaced in the corresponding x direction, including girder pitch', optional=True, enforce=float)
Y_PITCH_TOT = EntryInfo('Rotation about the element center s.t. exit face is diplaced in the corresponding y direction, including girder pitch', optional=True, enforce=float)
X_OFFSET_TOT = EntryInfo('Total translation of element in the x direction including Girder tilt', optional=True, enforce=float)
Y_OFFSET_TOT = EntryInfo('Total translation of element in the y direction including Girder tilt', optional=True, enforce=float)
Z_OFFSET_TOT = EntryInfo('Total translation of element in the z direction including Girder tilt', optional=True, enforce=float)
class BendOrientation(StraightLineOrientation):
REF_TILT = EntryInfo('Rotation of bend around the z axis', optional=True, enforce=float)
ROLL =EntryInfo('Vertical kick assigned to beam', optional=True, enforce=float)
class Quadrupole(Base, Kick, ApertureLimits, StraightLineOrientation, Twiss, Length, Floor):
element_type = "quadrupole"
B1_GRADIENT = EntryInfo('Field strength', optional=True, enforce=float)
#K1 = EntryInfo('Quadrupole field strength', optional=True, enforce=float)
FQ1 = EntryInfo('Soft edge fringe parameter', optional=True, enforce=float)
FQ2 = EntryInfo('Soft edge fringe parameter', optional=True, enforce=float)
class Length(HappiItem):
L = EntryInfo('Length path of the reference particle', optional=True, enforce=float) # bend?
class Kick(HappiItem):
HKICK = EntryInfo('Integrated horizontal field kick', optional=True, enforce=float)
VKICK = EntryInfo('Integrated vertical field kick', optional=True, enforce=float)
BL_HKICK = EntryInfo('Integrated horizontal field kick in meters-Tesla', optional=True, enforce=float)
BL_VKICK = EntryInfo('Integrated vertical field kick in meters-Tesla', optional=True, enforce=float)
class RBend(Base, ApertureLimits, Kick, Bend, BendOrientation, Floor):
element_type = "rbend"
L_ARC = EntryInfo('Arc length', optional=True, enforce=str) # r bends only
L = EntryInfo('Chord length of bend', optional=True, enforce=float)
class Floor(HappiItem):
# Global floor coords at end of element
# reference
Reference_X = EntryInfo('X offset from origin without misalignments',
optional=True, enforce=float)
Reference_Y = EntryInfo('Y offset from origin without misalignments',
optional=True, enforce=float)
Reference_Z = EntryInfo('Z offset from origin without misalignments',
optional=True, enforce=float)
Reference_Theta = EntryInfo('Angle on floor without misalignments',
optional=True, enforce=float)
Reference_Phi = EntryInfo('Angle of attack without misalignments',
optional=True, enforce=float)
Reference_Psi = EntryInfo('Roll angle without misalignments',
optional=True, enforce=float)
# actual
Actual_X = EntryInfo('X offset from origin with offset/pitch/tilt misalignments',
optional=True, enforce=float)
Actual_Y = EntryInfo('Y offset from origin with offset/pitch/tilt misalignments',
optional=True, enforce=float)
Actual_Z = EntryInfo('Z offset from origin with offset/pitch/tilt misalignments',
optional=True, enforce=float)
Actual_Theta = EntryInfo('Angle on floor with offset/pitch/tilt misalignments',
optional=True, enforce=float)
Actual_Phi = EntryInfo('Angle of attack with offset/pitch/tilt misalignments',
optional=True, enforce=float)
Actual_Psi = EntryInfo('Roll angle with offset/pitch/tilt misalignments',
optional=True, enforce=float)
# delta ref
delta_Ref_X = EntryInfo('X offset delta with respect to preceding element',
optional=True, enforce=float)
delta_Ref_Y = EntryInfo('Y offset delta with respect to preceding element',
optional=True, enforce=float)
delta_Ref_Z = EntryInfo('Z offset delta with respect to preceding element',
optional=True, enforce=float)
delta_Ref_Theta = EntryInfo('Angle on floor delta with respect to preceding element',
optional=True, enforce=float)
delta_Ref_Phi = EntryInfo('Angle of attack delta with respect to preceding element',
optional=True, enforce=float)
delta_Ref_Psi = EntryInfo('Roll angle delta with respect to preceding element',
optional=True, enforce=float)
class Base(HappiItem):
S = EntryInfo('Longitudinal position at the downstream end', optional=True, enforce=float)
S_start = EntryInfo('Longitudinal reference position at entrance end', optional=True, enforce=float)
branch_line = EntryInfo('branchline', optional=True, enforce=str)
label = EntryInfo('device label', optional=True, enforce=str)
description = EntryInfo('Description', optional=True, enforce=str)
class Lcavity(Base, Twiss, Length, ApertureLimits, StraightLineOrientation, Kick, Floor):
element_type = "lcavity"
CAVITY_TYPE = EntryInfo('Solenoid strength', optional=True, enforce=float)
GRADIENT =EntryInfo('Accelerating gradient', optional=True, enforce=float)
GRADIENT_ERR = EntryInfo('Accelerating gradient error', optional=True, enforce=float)
PHI0 = EntryInfo('Phase of the reference particle with respect to RF', optional=True, enforce=float)
PHI0_MULTIPASS = EntryInfo('Phase with respect to a multipass lord', optional=True, enforce=float)
PHI0_ERR = EntryInfo('Phase error', optional=True, enforce=float)
E_LOSS = EntryInfo('Loss parameter for short range wakefields', optional=True, enforce=float)
RF_FREQUENCY = EntryInfo('RF frequence', optional=True, enforce=float)
VOLTAGE = EntryInfo('Cavity voltage', optional=True, enforce=float)
L_ACTIVE = EntryInfo('Active region length', optional=True, enforce=float)
N_CELL = EntryInfo('Number of cavity cells', optional=True, enforce=float)
LONGITUDINAL_MODE = EntryInfo('Longitudinal mode', optional=True, enforce=float)
class Solenoid(Base, Length, ApertureLimits, StraightLineOrientation, Kick, Floor, GirderBendExtension):
#KS = EntryInfo('Solenoid strength', optional=True, enforce=float)
element_type = "solenoid"
BS_FIELD = EntryInfo('Field strength', optional=True, enforce=float)
L_SOFT_EDGE = EntryInfo('For modeling a soft fringe', optional=True, enforce=float)
R_SOLENOID = EntryInfo('Solenoid radius', optional=True, enforce=float)
class SBend(Base, ApertureLimits, Kick, Bend, BendOrientation, Floor):
element_type = "sbend"
L = EntryInfo('Length of bend', optional=True, enforce=float)
class Twiss(HappiItem):
# Twiss elements
Beta_A = EntryInfo('A mode beta', optional=True, enforce=float)
Beta_B = EntryInfo('B mode beta', optional=True, enforce=float)
Alpha_A = EntryInfo('A mode alpha', optional=True, enforce=float)
Alpha_B = EntryInfo('B mode alpha', optional=True, enforce=float)
Gamma_A = EntryInfo('A mode gamma', optional=True, enforce=float)
Gamma_B = EntryInfo('B mode gamma', optional=True, enforce=float)
Phi_A = EntryInfo('A mode phase', optional=True, enforce=float)
Phi_B = EntryInfo('B mode phase', optional=True, enforce=float)
Eta_X = EntryInfo('x-axis dispersion', optional=True, enforce=float)
Eta_Y = EntryInfo('y-axis dispersion', optional=True, enforce=float)
Eta_Z = EntryInfo('z-axis dispersion', optional=True, enforce=float)
Etap_X = EntryInfo('x-axis dispersion derivative', optional=True, enforce=float)
Etap_Y = EntryInfo('y-axis dispersion derivative', optional=True, enforce=float)
Etap_Z = EntryInfo('z-axis dispersion derivative', optional=True, enforce=float)
class Bend(HappiItem):
ANGLE = EntryInfo('Design bend angle', optional=True, enforce=float)
B_FIELD = EntryInfo('Design field strength', optional=True, enforce=float)
DB_FIELD = EntryInfo('', optional=True, enforce=float)
B1_GRADIENT = EntryInfo('Quadrupole field strength', optional=True, enforce=float)
B2_GRADIENT = EntryInfo('Sextupole field strength', optional=True, enforce=float)
E1 = EntryInfo('Entrance pole face angle', optional=True, enforce=float)
E2 = EntryInfo('Exit pole face angle', optional=True, enforce=float)
G = EntryInfo('Design bend strength', optional=True, enforce=float)
DG = EntryInfo('Difference between actual and design bend strength', optional=True, enforce=float)
#H1 = EntryInfo('Entrance face curvature', optional=True, enforce=float)
#H2 = EntryInfo('Exit face curvature', optional=True, enforce=float)
K1 = EntryInfo('Quadrupole strength', optional=True, enforce=float)
K2 = EntryInfo('Sextupole strength', optional=True, enforce=float)
L_CHORD = EntryInfo('Chord length', optional=True, enforce=float)
L_SAGITTA = EntryInfo('Sagittal length', optional=True, enforce=float)
RHO = EntryInfo('Design bend radius', optional=True, enforce=float)
class InstrumentalMeasurements(HappiItem):
X_GAIN_ERR = EntryInfo('Horizontal gain error', optional=True, enforce=float)
Y_GAIN_ERR = EntryInfo('V ertical gain error', optional=True, enforce=float)
CRUNCH = EntryInfo('Crunch angle', optional=True, enforce=float)
TILT_CALIB = EntryInfo('Tilt angle calibration', optional=True, enforce=float)
X_OFFSET_CALIB = EntryInfo('Horizontal offset calibration', optional=True, enforce=float)
Y_OFFSET_CALIB = EntryInfo('Vertical offset calibration', optional=True, enforce=float)
X_GAIN_CALIB = EntryInfo('Horizontal gain calibration', optional=True, enforce=str)
Y_GAIN_CALIB = EntryInfo('Vertical gain calibration', optional=True, enforce=float)
CRUNCH_CALIB = EntryInfo('Crunch angle calibration', optional=True, enforce=float)
NOISE = EntryInfo('Noise factor', optional=True, enforce=float)
DE_ETA_MEAS = EntryInfo('Percent change in energy', optional=True, enforce=float)
X_DISPERSION_ERR = EntryInfo('Horizontal dispersion error', optional=True, enforce=float)
Y_DISPERSION_ERR = EntryInfo('Vertical dispersion error', optional=True, enforce=float)
X_DISPERSION_CALIB = EntryInfo('Horizontal dispersion calibration', optional=True, enforce=float)
Y_DISPERSION_CALIB = EntryInfo('Vertical dispersion calibration', optional=True, enforce=float)
N_SAMPLE = EntryInfo('Number of sampling points', optional=True, enforce=float)
OSC_AMPLITUDE = EntryInfo('Oscillation amplitude', optional=True, enforce=float)
class VKicker(Base, Length, ApertureLimits, Kick, StraightLineOrientation, Floor):
element_type = "vkicker"
KICK = EntryInfo('Integrated kick', optional=True, enforce=float)