public class TwissProbeState extends BunchProbeState<TwissProbeState>
TwissProbe
at a particular instance.Modifier and Type | Field and Description |
---|---|
protected static java.lang.String |
ATTR_VALUE
general value attribute tag
|
protected static java.lang.String |
LABEL_CENT
element label for centroid vector
|
protected static java.lang.String |
LABEL_PHASE
element label for betatron phase
|
protected static java.lang.String |
LABEL_RESP
element label for response matrix
|
protected static java.lang.String |
LABEL_TWISS
element label for twiss parameters
|
protected static java.lang.String |
LABEL_TWISSPROBE
element label for twiss probe data
|
STATE_LABEL, TYPE_LABEL
LightSpeed
Constructor and Description |
---|
TwissProbeState()
Default constructor.
|
TwissProbeState(TwissProbe probe)
Initializing Constructor.
|
TwissProbeState(TwissProbeState twissProbeState)
Copy constructor for TwissProbeState.
|
Modifier and Type | Method and Description |
---|---|
protected void |
addPropertiesTo(DataAdaptor daSink)
Save the state values particular to
TwissProbeState objects
to the data sink. |
TwissProbeState |
copy()
Implements the clone operation required by the base class
ProbeState . |
R3 |
getBetatronPhase()
Returns the betatron phase with space charge for all three phase
planes.
|
PhaseVector |
getCentroid()
Get the centroid location of the beam bunch in homogeneous
coordinates.
|
PhaseVector |
getFixedOrbit()
Get the fixed orbit about which betatron oscillations occur.
|
PhaseVector |
getPhaseCoordinates()
Returns homogeneous phase space coordinates of the centroid.
|
PhaseMatrix |
getResponseMatrix()
Get the first-order response matrix accumulated by the probe since its initial
state.
|
Twiss[] |
getTwiss()
Returns the array of Twiss parameters for this
state for all three planes.
|
Twiss |
getTwiss(Twiss3D.IND_3D iPlane)
Returns the Twiss parameters for the given phase plane.
|
Twiss3D |
getTwiss3D()
Returns the Twiss parameters for this state for all three planes.
|
protected void |
readPropertiesFrom(DataAdaptor daSource)
Recover the state values particular to
TwissProbeState objects
from the data source. |
double[] |
rmsEmittances()
Convenience Method: Returns the rms emittances for this state as
from the individual Twiss parameters.
|
void |
setBetatronPhase(R3 vecPhase)
Set the betatron phase with space charge for each phase plane.
|
void |
setCentroid(PhaseVector vecCentroid)
Set the centroid location of the beam bunch in homogeneous
coordinates.
|
void |
setResponseMatrix(PhaseMatrix matResp)
Set the first-order response matrix accumulated by the Envelope since its initial
state.
|
void |
setTwiss(Twiss3D.IND_3D iPlane,
Twiss twiss)
Set the Twiss parameters for the given phase plane.
|
void |
setTwiss(Twiss3D arrTwiss)
Set all the twiss parameters for the probe
|
beamPerveance, bunchCharge, getBeamCurrent, getBunchFrequency, setBeamCurrent, setBunchFrequency, toString
computeBetaFromGamma, computeGammaFromBeta, computeGammaFromW, getBeta, getBetaGamma, getElementId, getGamma, getHardwareNodeId, getKineticEnergy, getMomentum, getPosition, getSpeciesCharge, getSpeciesRestEnergy, getTime, load, save, setElementId, setHardwareNodeId, setKineticEnergy, setPosition, setSpeciesCharge, setSpeciesRestEnergy, setTime
protected static final java.lang.String LABEL_TWISSPROBE
protected static final java.lang.String LABEL_CENT
protected static final java.lang.String LABEL_RESP
protected static final java.lang.String LABEL_PHASE
protected static final java.lang.String LABEL_TWISS
protected static final java.lang.String ATTR_VALUE
public TwissProbeState()
EnvelopeProbeState object.
public TwissProbeState(TwissProbeState twissProbeState)
TwissProbeState
objects with the state attributes
of the given TwissProbeState
.twissProbeState
- initializing statepublic TwissProbeState(TwissProbe probe)
TwissProbeState
object and
initialize it to the state of the probe argument.probe
- TwissProbe
containing initializing state informationpublic void setCentroid(PhaseVector vecCentroid)
vecCentroid
- new centroid of the bunch (x,x',y,y',z,z',1)public void setResponseMatrix(PhaseMatrix matResp)
matResp
- first-order response matrix in homogeneous coordinatespublic void setBetatronPhase(R3 vecPhase)
vecPhase
- vector (ψx,ψy,ψz)
of betatron phases in radians public void setTwiss(Twiss3D.IND_3D iPlane, Twiss twiss)
iPlane
- phase plane indextwiss
- twiss parameterspublic void setTwiss(Twiss3D arrTwiss)
arrTwiss
- new 3 dimensional array of Twiss objects (hor, vert,long)Twiss3D
public PhaseVector getCentroid()
public PhaseMatrix getResponseMatrix()
public Twiss getTwiss(Twiss3D.IND_3D iPlane)
iPlane
- phase plane indexpublic Twiss3D getTwiss3D()
public double[] rmsEmittances()
public PhaseVector getPhaseCoordinates()
Returns homogeneous phase space coordinates of the centroid. The units are meters and radians.
IPhaseState
interface
getCentroid()
public PhaseVector getFixedOrbit()
public Twiss[] getTwiss()
public R3 getBetatronPhase()
public TwissProbeState copy()
ProbeState
.copy
in class ProbeState<TwissProbeState>
ProbeState.copy()
protected void addPropertiesTo(DataAdaptor daSink)
TwissProbeState
objects
to the data sink.addPropertiesTo
in class BunchProbeState<TwissProbeState>
daSink
- data sink represented by DataAdaptor
interfaceprotected void readPropertiesFrom(DataAdaptor daSource) throws ParsingException
TwissProbeState
objects
from the data source.readPropertiesFrom
in class BunchProbeState<TwissProbeState>
daSource
- data source represented by a DataAdaptor
interfaceParsingException
- state information in data source is malformatted