public class EnsembleProbeState extends BunchProbeState<EnsembleProbeState>
STATE_LABEL, TYPE_LABEL
LightSpeed
Constructor and Description |
---|
EnsembleProbeState()
Default constructor.
|
EnsembleProbeState(EnsembleProbe probe)
Initializing Constructor.
|
EnsembleProbeState(EnsembleProbeState ensembleProbeState)
Copy constructor for EnsembleProbeState.
|
Modifier and Type | Method and Description |
---|---|
protected void |
addPropertiesTo(DataAdaptor container)
Save the state values particular to
EnsembleProbeState objects
to the data sink. |
EnsembleProbeState |
copy()
Implements the clone operation required by the base class
ProbeState |
R3 |
electricField(R3 ptFld)
Get the electric field at a point in R3 from the ensemble.
|
Ensemble |
getEnsemble()
Return the Ensemble state object
|
int |
getFieldCalculation()
Return the field calculation method
|
CovarianceMatrix |
phaseCovariance()
Return the correlation matrix of the distribution
|
PhaseVector |
phaseMean()
Return the coordinates of the ensemble centroid.
|
protected void |
readPropertiesFrom(DataAdaptor container)
Recover the state values particular to
EnsembleProbeState objects
from the data source. |
void |
setEnsemble(Ensemble ens)
Set the state to the value of the argument
NOTE: the copy operation can be expansive for large
Ensemble s |
void |
setFieldCalculation(int fc)
Set the field calculation method
|
java.lang.String |
toString()
Write out state information to a string.
|
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
public EnsembleProbeState()
EnsembleProbeState object.
public EnsembleProbeState(EnsembleProbeState ensembleProbeState)
EnsembleProbeState
objects with the state attributes
of the given EnsembleProbeState
.ensembleProbeState
- initializing statepublic EnsembleProbeState(EnsembleProbe probe)
EnsembleProbeState
object and
initialize it to the state of the probe argument.probe
- EnsembleProbe
containing initializing state informationpublic void setFieldCalculation(int fc)
fc
- field calculation method enumerationpublic void setEnsemble(Ensemble ens)
Ensemble
sens
- Ensemble
object to be copiedpublic int getFieldCalculation()
public Ensemble getEnsemble()
public R3 electricField(R3 ptFld)
ptFld
- field point to evaluation ensemble fieldpublic PhaseVector phaseMean()
public CovarianceMatrix phaseCovariance()
CovarianceMatrix
public EnsembleProbeState copy()
ProbeState
copy
in class ProbeState<EnsembleProbeState>
ProbeState.copy()
protected void addPropertiesTo(DataAdaptor container)
EnsembleProbeState
objects
to the data sink.addPropertiesTo
in class BunchProbeState<EnsembleProbeState>
container
- data sink represented by DataAdaptor
interfaceprotected void readPropertiesFrom(DataAdaptor container) throws ParsingException
EnsembleProbeState
objects
from the data source.readPropertiesFrom
in class BunchProbeState<EnsembleProbeState>
container
- data source represented by a DataAdaptor
interfaceParsingException
- state information in data source is malformattedpublic java.lang.String toString()
toString
in class BunchProbeState<EnsembleProbeState>