Package xal.app.knobs

Class BumpShapeAdaptor

java.lang.Object

xal.app.knobs.BumpShapeAdaptor

public abstract class BumpShapeAdaptor
extends Object

adaptor for generating bumps of specific shapes

Field Summary

Fields

Modifier and Type	Field	Description
protected static xal.app.knobs.BumpAngleAdaptor	_bumpAngleAdaptor	bump angle adaptor
protected static xal.app.knobs.BumpOffsetAdaptor	_bumpOffsetAdaptor	bump offset adaptor

Constructor Summary

Constructors

Constructor	Description
BumpShapeAdaptor()

Method Summary

Modifier and Type	Method	Description
abstract double	getAmplitudeScale()	get the amplitude scale of the distortion per unit of knob
static xal.app.knobs.BumpAngleAdaptor	getBumpAngleAdaptor()	get the bump angle adaptor instance
static xal.app.knobs.BumpOffsetAdaptor	getBumpOffsetAdaptor()	get the bump offset adaptor instance
abstract String	getLabel()	get the label
abstract int	getMinimumElementCount()	get the minimum number of elements for the particular shape
abstract double[]	getOrbit(xal.tools.beam.calc.SimResultsAdaptor simulator, PlaneAdaptor planeAdaptor, xal.model.probe.traj.ProbeState<?> bumpState, xal.model.probe.traj.ProbeState<?> endState, int elementCount)	get the orbit
int	getOrbitSize(int elementCount)	get the orbit size for the specified element count

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_bumpOffsetAdaptor

protected static xal.app.knobs.BumpOffsetAdaptor _bumpOffsetAdaptor

bump offset adaptor

_bumpAngleAdaptor

protected static xal.app.knobs.BumpAngleAdaptor _bumpAngleAdaptor

bump angle adaptor

Constructor Detail

BumpShapeAdaptor

public BumpShapeAdaptor()

Method Detail

getBumpOffsetAdaptor

public static xal.app.knobs.BumpOffsetAdaptor getBumpOffsetAdaptor()

get the bump offset adaptor instance

getBumpAngleAdaptor

public static xal.app.knobs.BumpAngleAdaptor getBumpAngleAdaptor()

get the bump angle adaptor instance

getLabel

public abstract String getLabel()

get the label

getMinimumElementCount

public abstract int getMinimumElementCount()

get the minimum number of elements for the particular shape

getAmplitudeScale

public abstract double getAmplitudeScale()

get the amplitude scale of the distortion per unit of knob

getOrbit

public abstract double[] getOrbit(xal.tools.beam.calc.SimResultsAdaptor simulator,
                                  PlaneAdaptor planeAdaptor,
                                  xal.model.probe.traj.ProbeState<?> bumpState,
                                  xal.model.probe.traj.ProbeState<?> endState,
                                  int elementCount)

get the orbit

getOrbitSize

public int getOrbitSize(int elementCount)

get the orbit size for the specified element count