xal.model.probe.traj

Class EnsembleProbeState

java.lang.Object

xal.model.probe.traj.ProbeState<S>

xal.model.probe.traj.BunchProbeState<EnsembleProbeState>

xal.model.probe.traj.EnsembleProbeState

All Implemented Interfaces:

IProbeState, IArchive

public class EnsembleProbeState
extends BunchProbeState<EnsembleProbeState>

Encapsulates the state of an EnsembleProbe at a particular point in time.

Field Summary

Fields inherited from class xal.model.probe.traj.ProbeState

STATE_LABEL, TYPE_LABEL

Fields inherited from interface xal.model.probe.traj.IProbeState

LightSpeed

Constructor Summary

Constructors

Constructor and Description
EnsembleProbeState() Default constructor.
EnsembleProbeState(EnsembleProbe probe) Initializing Constructor.
EnsembleProbeState(EnsembleProbeState ensembleProbeState) Copy constructor for EnsembleProbeState.

Method Summary

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 Ensembles
void	setFieldCalculation(int fc) Set the field calculation method
java.lang.String	toString() Write out state information to a string.

Methods inherited from class xal.model.probe.traj.BunchProbeState

beamPerveance, bunchCharge, getBeamCurrent, getBunchFrequency, setBeamCurrent, setBunchFrequency

Methods inherited from class xal.model.probe.traj.ProbeState

computeBetaFromGamma, computeGammaFromBeta, computeGammaFromW, getBeta, getBetaGamma, getElementId, getGamma, getHardwareNodeId, getKineticEnergy, getMomentum, getPosition, getSpeciesCharge, getSpeciesRestEnergy, getTime, load, save, setElementId, setHardwareNodeId, setKineticEnergy, setPosition, setSpeciesCharge, setSpeciesRestEnergy, setTime

Methods inherited from class java.lang.Object

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

Constructor Detail

EnsembleProbeState

public EnsembleProbeState()

Default constructor. Create a new, empty EnsembleProbeState object.

EnsembleProbeState

public EnsembleProbeState(EnsembleProbeState ensembleProbeState)

Copy constructor for EnsembleProbeState. Initializes the new EnsembleProbeState objects with the state attributes of the given EnsembleProbeState.

Parameters:

ensembleProbeState - initializing state

Since:

Jun 26, 2014

EnsembleProbeState

public EnsembleProbeState(EnsembleProbe probe)

Initializing Constructor. Create a new EnsembleProbeState object and initialize it to the state of the probe argument.

Parameters:

probe - EnsembleProbe containing initializing state information

Method Detail

setFieldCalculation

public void setFieldCalculation(int fc)

Set the field calculation method

Parameters:

fc - field calculation method enumeration

setEnsemble

public void setEnsemble(Ensemble ens)

Set the state to the value of the argument NOTE: the copy operation can be expansive for large Ensembles

Parameters:

ens - Ensemble object to be copied

getFieldCalculation

public int getFieldCalculation()

Return the field calculation method

getEnsemble

public Ensemble getEnsemble()

Return the Ensemble state object

electricField

public R3 electricField(R3 ptFld)

Get the electric field at a point in R3 from the ensemble.

Parameters:

ptFld - field point to evaluation ensemble field

Returns:

electric field at field point

phaseMean

public PhaseVector phaseMean()

Return the coordinates of the ensemble centroid.

Returns:

(homogeneous) phase space coordinates of ensemble centroid

phaseCovariance

public CovarianceMatrix phaseCovariance()

Return the correlation matrix of the distribution

Returns:

symmetric 7x7 covariance matrix in homogeneous coordinates

See Also:

CovarianceMatrix

copy

public EnsembleProbeState copy()

Implements the clone operation required by the base class ProbeState

Specified by:

copy in class ProbeState<EnsembleProbeState>

Returns:

a deep copy of this object.

Since:

Jun 27, 2014

See Also:

ProbeState.copy()

addPropertiesTo

protected void addPropertiesTo(DataAdaptor container)

Save the state values particular to EnsembleProbeState objects to the data sink.

Overrides:

addPropertiesTo in class BunchProbeState<EnsembleProbeState>

Parameters:

container - data sink represented by DataAdaptor interface

readPropertiesFrom

protected void readPropertiesFrom(DataAdaptor container)
                           throws ParsingException

Recover the state values particular to EnsembleProbeState objects from the data source.

Overrides:

readPropertiesFrom in class BunchProbeState<EnsembleProbeState>

Parameters:

container - data source represented by a DataAdaptor interface

Throws:

ParsingException - state information in data source is malformatted

toString

public java.lang.String toString()

Write out state information to a string.

Overrides:

toString in class BunchProbeState<EnsembleProbeState>

Returns:

text version of internal state data