gov.sns.xal.model.probe.traj
Class BeamProbeState

java.lang.Object
  |
  +--gov.sns.xal.model.probe.traj.ProbeState
        |
        +--gov.sns.xal.model.probe.traj.BeamProbeState

All Implemented Interfaces:

IArchive

Direct Known Subclasses:

EnsembleProbeState, EnvelopeProbeState

public abstract class BeamProbeState

extends ProbeState

Encapsulates a BeamProbe's state at a point in time.

Field Summary

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

STATE_LABEL

Constructor Summary

BeamProbeState()
Default constructor.

BeamProbeState(BeamProbe probe)
Initializing constructor.

Method Summary

protected void	addPropertiesTo(DataAdaptor container) Save the state values particular to BeamProbeState objects to the data sink.
double	getBeamCharge() Returns the total beam charge
double	getBeamCurrent() Returns the total beam current
abstract CorrelationMatrix	phaseCorrelation() Abstract - Returns the correlation matrix (sigma matrix) in homogeneous phase space coordinates.
CorrelationMatrix	phaseCovariance() Returns the covariance matrix of this state in homogeneous phase space coordinates.
PhaseVector	phaseMean() Abstract - Return the phase space coordinates of the centroid in homogeneous coordinates
protected void	readPropertiesFrom(DataAdaptor container) Recover the state values particular to BeamProbeState objects from the data source.
double[]	rmsEmittances() Returns the rms emittances for this state.
void	setBeamCharge(double c) Set the total beam charge
void	setBeamCurrent(double c) Set the total beam current
java.lang.String	toString() Write out state information to a string.
Twiss[]	twissParameters() Return the twiss parameters for this state calculated from the correlation matrix

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

getElementId, getKineticEnergy, getPosition, getSpeciesCharge, getSpeciesRestEnergy, getTime, load, readFrom, save, setElementId, setKineticEnergy, setPosition, setSpeciesCharge, setSpeciesRestEnergy, setTime

Methods inherited from class java.lang.Object

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

Constructor Detail

BeamProbeState

public BeamProbeState()

Default constructor. Creates an empty BeamProbeState.

BeamProbeState

public BeamProbeState(BeamProbe probe)

Initializing constructor. Creates a new BeamProbe object initialized to the argument's state.

Parameters:

probe - probe object with which to initialize this state

Method Detail

phaseCorrelation

public abstract CorrelationMatrix phaseCorrelation()

Abstract - Returns the correlation matrix (sigma matrix) in homogeneous phase space coordinates.

Returns:

=| | | | ...

See Also:

PhaseMatrix

setBeamCurrent

public void setBeamCurrent(double c)

Set the total beam current

setBeamCharge

public void setBeamCharge(double c)

Set the total beam charge

getBeamCurrent

public double getBeamCurrent()

Returns the total beam current

Returns:

beam current in amps

getBeamCharge

public double getBeamCharge()

Returns the total beam charge

Returns:

beam charge in coulombs

phaseCovariance

public CorrelationMatrix phaseCovariance()

Returns the covariance matrix of this state in homogeneous phase space coordinates.

Returns:

- ^T

rmsEmittances

public double[] rmsEmittances()

Returns the rms emittances for this state.

Returns:

array (ex,ey,ez) of rms emittances

twissParameters

public Twiss[] twissParameters()

Return the twiss parameters for this state calculated from the correlation matrix

phaseMean

public PhaseVector phaseMean()

Abstract - Return the phase space coordinates of the centroid in homogeneous coordinates

Returns:

= (, , , , , , 1)^T

toString

public java.lang.String toString()

Write out state information to a string.

Overrides:

toString in class ProbeState

Returns:

text version of internal state data

addPropertiesTo

protected void addPropertiesTo(DataAdaptor container)

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

Overrides:

addPropertiesTo in class ProbeState

Parameters:

container - data sink represented by DataAdaptor interface

readPropertiesFrom

protected void readPropertiesFrom(DataAdaptor container)
                           throws ParsingException

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

Overrides:

readPropertiesFrom in class ProbeState

Parameters:

container - data source represented by a DataAdaptor interface

Throws:

ParsingException - state information in data source is malformatted