public class EnvelopeProbeState extends BunchProbeState<EnvelopeProbeState>
Modifier and Type | Field and Description |
---|---|
protected static java.lang.String |
ALPHA_X_LABEL |
protected static java.lang.String |
ALPHA_Y_LABEL |
protected static java.lang.String |
ALPHA_Z_LABEL |
protected static java.lang.String |
BETA_X_LABEL |
protected static java.lang.String |
BETA_Y_LABEL |
protected static java.lang.String |
BETA_Z_LABEL |
protected static java.lang.String |
CENTROID_LABEL
element tag for centroid data
|
protected static java.lang.String |
EMIT_X_LABEL |
protected static java.lang.String |
EMIT_Y_LABEL |
protected static java.lang.String |
EMIT_Z_LABEL |
protected static java.lang.String |
ENVELOPE_LABEL
element tag for envelope data
|
STATE_LABEL, TYPE_LABEL
LightSpeed
Constructor and Description |
---|
EnvelopeProbeState()
Default constructor.
|
EnvelopeProbeState(EnvelopeProbe probe)
Initializing Constructor.
|
EnvelopeProbeState(EnvelopeProbeState prsEnv)
Copy constructor for EnvelopeProbeState.
|
Modifier and Type | Method and Description |
---|---|
protected void |
addPropertiesTo(DataAdaptor container)
Save the state values particular to
EnvelopeProbeState objects
to the data sink. |
CovarianceMatrix |
centralCovariance()
Convenience Method: Returns the covariance matrix of this state in
homogeneous phase space coordinates.
|
EnvelopeProbeState |
copy()
Implements the cloning operation required by the base class
ProbeState . |
CovarianceMatrix |
getCovarianceMatrix()
Returns the correlation matrix of this state in homogeneous
phase space coordinates.
|
PhaseMatrix |
getPerturbationMatrix()
Get the first-order response matrix of current element slice
|
PhaseMatrix |
getResponseMatrix()
Get the first-order response matrix accumulated by the Envelope since its initial
state.
|
PhaseMatrix |
getResponseMatrixNoSpaceCharge()
Get the first-order response matrix accumulated by the Envelope since its initial
state.
|
boolean |
getSaveTwissFlag()
Deprecated.
associated with the redundant state variable
twissParams |
PhaseVector |
phaseMean()
Convenience Method: Return the phase space coordinates of the centroid
in homogeneous coordinates.
|
protected void |
readPropertiesFrom(DataAdaptor container)
Recover the state values particular to
EnvelopeProbeState objects
from the data source. |
double[] |
rmsEmittances()
Convenience Method: Returns the rms emittances for this state as
determined by the correlation matrix.
|
void |
saveStateAsTwiss(DataAdaptor daSink)
Save the state values particular to
EnvelopeProbeState objects
to the data sink. |
void |
setCovariance(CovarianceMatrix matTau)
Set the correlation matrix for this probe (7x7 matrix in homogeneous coordinates).
|
void |
setPerturbationMatrix(PhaseMatrix matPerturb)
Set the first-order response matrix of the current element slice
|
void |
setResponseMatrix(PhaseMatrix matResp)
Set the first-order response matrix accumulated by the Envelope since its initial
state.
|
void |
setResponseMatrixNoSpaceCharge(PhaseMatrix matResp)
Set the first-order response matrix accumulated by the Envelope since its initial
state.
|
void |
setSaveTwissFlag(boolean bolSaveTwiss)
Deprecated.
Storing only the Twiss parameters leaves an incomplete state
and may lead to erroneous results
|
java.lang.String |
toString()
Write out state information to a string.
|
Twiss[] |
twissParameters()
Return the twiss parameters for this state calculated from the
covariance matrix.
|
beamPerveance, bunchCharge, getBeamCurrent, getBunchFrequency, setBeamCurrent, setBunchFrequency
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 ENVELOPE_LABEL
protected static final java.lang.String CENTROID_LABEL
protected static final java.lang.String ALPHA_X_LABEL
protected static final java.lang.String BETA_X_LABEL
protected static final java.lang.String EMIT_X_LABEL
protected static final java.lang.String ALPHA_Y_LABEL
protected static final java.lang.String BETA_Y_LABEL
protected static final java.lang.String EMIT_Y_LABEL
protected static final java.lang.String ALPHA_Z_LABEL
protected static final java.lang.String BETA_Z_LABEL
protected static final java.lang.String EMIT_Z_LABEL
public EnvelopeProbeState()
EnvelopeProbeState object.
public EnvelopeProbeState(EnvelopeProbeState prsEnv)
EnvelopeProbeState
objects with the state attributes
of the given EnvelopeProbeState
.EnvelopeProbeState
- initializing statepublic EnvelopeProbeState(EnvelopeProbe probe)
EnvelopeProbeState
object and
initialize it to the state of the probe argument.probe
- EnvelopeProbe
containing initializing state informationpublic EnvelopeProbeState copy()
ProbeState
.copy
in class ProbeState<EnvelopeProbeState>
ProbeState.copy()
@Deprecated public void setSaveTwissFlag(boolean bolSaveTwiss)
Changes the behavior of the persistence methods (from the
DataAdaptor
methods).
By setting this flag to true
the Twiss
parameter attributes will be saved instead to a DataAdapter
interface rather that the full correlation matrix. The default behavior for this class
is to save the correlation matrix.
bolSaveTwiss
- behavior of save state methodsaddPropertiesTo(DataAdaptor)
public void setPerturbationMatrix(PhaseMatrix matPerturb)
matPerturb
- first-order response matrix in homogeneous coordinatespublic void setResponseMatrix(PhaseMatrix matResp)
matResp
- first-order response matrix in homogeneous coordinatespublic void setResponseMatrixNoSpaceCharge(PhaseMatrix matResp)
matResp
- first-order response matrix in homogeneous coordinatespublic void setCovariance(CovarianceMatrix matTau)
matTau
- new phase space covariance matrix of this probeCovarianceMatrix
public PhaseMatrix getResponseMatrix()
public PhaseMatrix getResponseMatrixNoSpaceCharge()
public PhaseMatrix getPerturbationMatrix()
public CovarianceMatrix getCovarianceMatrix()
EnvelopeProbe
objects.@Deprecated public boolean getSaveTwissFlag()
twissParams
DataAdaptor
object.
NOTES:
This can be dangerous as we have the
potential to loss a lot of information. In particular,
if the probe has pasted through a bend or a steering
magnet, the Twiss parameters do not contain enough information
to restart the probe.Probe.save(DataAdaptor)
,
Probe.applyState(ProbeState)
public CovarianceMatrix centralCovariance()
CovarianceMatrix.computeCentralCovariance()
public double[] rmsEmittances()
twissParams
local attribute.public Twiss[] twissParameters()
Return the twiss parameters for this state calculated from the covariance matrix.
public PhaseVector phaseMean()
CovarianceMatrix.getMean()
public void saveStateAsTwiss(DataAdaptor daSink)
Save the state values particular to EnvelopeProbeState
objects
to the data sink. In particular we save only the data in the 2x2 diagonal
blocks of the correlation matrix, and as Twiss parameters.
EnvelopeProbeState
information in the save format as
the load()/save() methods do, but you cannot restore an EnvelopeProbe
object from these data.
daSink
- data sink represented by DataAdaptor
interfaceprotected void addPropertiesTo(DataAdaptor container)
EnvelopeProbeState
objects
to the data sink.addPropertiesTo
in class BunchProbeState<EnvelopeProbeState>
container
- data sink represented by DataAdaptor
interfaceprotected void readPropertiesFrom(DataAdaptor container) throws ParsingException
EnvelopeProbeState
objects
from the data source.readPropertiesFrom
in class BunchProbeState<EnvelopeProbeState>
container
- data source represented by a DataAdaptor
interfaceParsingException
- state information in data source is malformattedpublic java.lang.String toString()
toString
in class BunchProbeState<EnvelopeProbeState>