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

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

All Implemented Interfaces:

IArchive

public class EnvelopeProbeState

extends BeamProbeState

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

Field Summary

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	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

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

STATE_LABEL

Constructor Summary

EnvelopeProbeState()
Default constructor.

EnvelopeProbeState(EnvelopeProbe probe)
Initializing Constructor.

Method Summary

protected void	addPropertiesTo(DataAdaptor container) Save the state values particular to EnvelopeProbeState objects to the data sink.
R3	getBetatronPhase() Returns the betatron phase with space charge for all three phase planes.
double	getChromDispersionX() Convenience function for returning the x plane chromatic dispersion as defined by D.C.
double	getChromDispersionY() Convenience function for returning the y plane chromatic dispersion as defined by D.C.
PhaseMatrix	getResponseMatrix() Get the first-order response matrix accumulated by the Envelope since its initial state.
Twiss[]	getTwiss() returns the array of twiss objects for this state for all three planes
CorrelationMatrix	phaseCorrelation() Returns the covariance matrix (sigma matrix) in homogeneous phase space coordinates.
protected void	readPropertiesFrom(DataAdaptor container) Recover the state values particular to EnvelopeProbeState objects from the data source.
void	setBetatronPhase(R3 vecPhase) Set the betatron phase with space charge for each phase plane.
void	setCorrelation(CorrelationMatrix matChi) Set the correlation matrix for this probe (7x7 matrix in homogeneous coordinates).
void	setResponseMatrix(PhaseMatrix matResp) Set the first-order response matrix accumulated by the Envelope since its initial state.
void	setTwiss(Twiss[] twiss) Set the twiss parameters for the probe
java.lang.String	toString() Write out state information to a string.

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

getBeamCharge, getBeamCurrent, phaseCovariance, phaseMean, rmsEmittances, setBeamCharge, setBeamCurrent, twissParameters

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

Field Detail

ENVELOPE_LABEL

protected static final java.lang.String ENVELOPE_LABEL

element tag for envelope data

See Also:

Constant Field Values

ALPHA_X_LABEL

protected static final java.lang.String ALPHA_X_LABEL

See Also:

Constant Field Values

BETA_X_LABEL

protected static final java.lang.String BETA_X_LABEL

See Also:

Constant Field Values

EMIT_X_LABEL

protected static final java.lang.String EMIT_X_LABEL

See Also:

Constant Field Values

ALPHA_Y_LABEL

protected static final java.lang.String ALPHA_Y_LABEL

See Also:

Constant Field Values

BETA_Y_LABEL

protected static final java.lang.String BETA_Y_LABEL

See Also:

Constant Field Values

EMIT_Y_LABEL

protected static final java.lang.String EMIT_Y_LABEL

See Also:

Constant Field Values

ALPHA_Z_LABEL

protected static final java.lang.String ALPHA_Z_LABEL

See Also:

Constant Field Values

BETA_Z_LABEL

protected static final java.lang.String BETA_Z_LABEL

See Also:

Constant Field Values

EMIT_Z_LABEL

protected static final java.lang.String EMIT_Z_LABEL

See Also:

Constant Field Values

Constructor Detail

EnvelopeProbeState

public EnvelopeProbeState()

Default constructor. Create a new, empty EnvelopeProbeState object.

EnvelopeProbeState

public EnvelopeProbeState(EnvelopeProbe probe)

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

Parameters:

probe - EnvelopeProbe containing initializing state information

Method Detail

setBetatronPhase

public void setBetatronPhase(R3 vecPhase)

Set the betatron phase with space charge for each phase plane.

Parameters:

vecPhase - vector (psix,psiy,psiz) of betratron phases in radians

setResponseMatrix

public void setResponseMatrix(PhaseMatrix matResp)

Set the first-order response matrix accumulated by the Envelope since its initial state. Note that this response includes the effects of space charge.

Parameters:

matResp - first-order response matrix in homogeneous coordinates

setCorrelation

public void setCorrelation(CorrelationMatrix matChi)

Set the correlation matrix for this probe (7x7 matrix in homogeneous coordinates).

Parameters:

matChi - new phase space covariant matrix of this probe

See Also:

CorrelationMatrix

setTwiss

public void setTwiss(Twiss[] twiss)

Set the twiss parameters for the probe

Parameters:

twiss - new 3 dimensional array of Twiss objects (horizontal, vertical and longitudinal

See Also:

Twiss

getBetatronPhase

public R3 getBetatronPhase()

Returns the betatron phase with space charge for all three phase planes.

Returns:

vector (psix,psiy,psiz) of phases in radians

getTwiss

public Twiss[] getTwiss()

returns the array of twiss objects for this state for all three planes

getResponseMatrix

public PhaseMatrix getResponseMatrix()

Get the first-order response matrix accumulated by the Envelope since its initial state. Note that this response includes the effects of space charge.

Returns:

first-order response matrix in homogeneous coordinates

phaseCorrelation

public CorrelationMatrix phaseCorrelation()

Returns the covariance matrix (sigma matrix) in homogeneous phase space coordinates.

Specified by:

phaseCorrelation in class BeamProbeState

Returns:

=| | | | ...

See Also:

BeamProbeState.phaseCorrelation()

getChromDispersionX

public double getChromDispersionX()

Convenience function for returning the x plane chromatic dispersion as defined by D.C. Carey in "The Optics of Charged Particle Beams". NOTE: We convert to the conventional definition of dispersion dx/(dp/p) by dividing the (x|z') element of the first-order response matrix by relativistic gamma squared.

Returns:

x plane chromatic dispersion in meters/radian

See Also:

Carey, "The Optics of Charged Particle Beams"

getChromDispersionY

public double getChromDispersionY()

Convenience function for returning the y plane chromatic dispersion as defined by D.C. Carey in "The Optics of Charged Particle Beams". NOTE: We convert to the conventional definition of dispersion dy/(dp/p) by dividing the (y|z') element of the first-order response matrix by relativistic gamma squared.

Returns:

y plane chromatic dispersion in meters/radian

See Also:

Carey, "The Optics of Charged Particle Beams"

toString

public java.lang.String toString()

Write out state information to a string.

Overrides:

toString in class BeamProbeState

Returns:

text version of internal state data

addPropertiesTo

protected void addPropertiesTo(DataAdaptor container)

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

Overrides:

addPropertiesTo in class BeamProbeState

Parameters:

container - data sink represented by DataAdaptor interface

readPropertiesFrom

protected void readPropertiesFrom(DataAdaptor container)
                           throws ParsingException

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

Overrides:

readPropertiesFrom in class BeamProbeState

Parameters:

container - data source represented by a DataAdaptor interface

Throws:

ParsingException - state information in data source is malformatted