xal.model.probe

Class TwissProbe

java.lang.Object

xal.model.probe.Probe<S>

xal.model.probe.BunchProbe<TwissProbeState>

xal.model.probe.TwissProbe

All Implemented Interfaces:

IProbe, IArchive

public class TwissProbe
extends BunchProbe<TwissProbeState>

EnvelopeProbe represents the RMS beam envelopes of a beam. Specifically, the state of this probe is the 7x7 matrix of homogeneous phase space moments up to, and including second order. This is the correlation matrix for the beam and is represented as

χ = < zz^T>

where z =(x,x',y,y',z,z',1) is the vector of homogeneous phase space coordinates, and <.> is the moment operator with respect to the beam distribution.

Field Summary

Fields inherited from class xal.model.probe.Probe

COMMENT_LABEL, PROBE_LABEL, stateCurrent, TEXT_LABEL, TIME_LABEL, trajHist, TYPE_LABEL

Fields inherited from interface xal.model.IProbe

LightSpeed, Permittivity, UnitCharge

Constructor Summary

Constructors

Constructor and Description
TwissProbe() Default Constructor.
TwissProbe(DataAdaptor daSource) Initializing constructor - initialize from data adaptor Create an new TwissProbe object and initialize its state variables according to the data in the data source exposing the DataAdaptor interface.
TwissProbe(TwissProbe prbParent) Copy constructor - clones the argument

Method Summary

Modifier and Type	Method and Description
TwissProbe	copy() Make a deep copy of this probe and return it.
TwissProbeState	createEmptyProbeState() Creates a new, empty TwissProbeState.
TwissProbeState	createProbeState() Creates a snapshot of the current state and returns it as a ProbeState object of the proper type.
Trajectory<TwissProbeState>	createTrajectory() Creates a Trajectory<TwissProbeState> object of the proper type for saving the probe's history.
R3	getBetatronPhase() Returns the betatron phase with space charge for all three phase planes.
PhaseVector	getCentroid() Get the centroid location of the beam bunch in homogeneous coordinates.
PhaseMatrix	getResponseMatrix() Get the first-order response matrix accumulated by the probe since its initial state.
Twiss3D	getTwiss() Returns the array of Twiss parameters for this state for all three planes.
Twiss	getTwiss(Twiss3D.IND_3D iPlane) Returns the Twiss parameters for the given phase plane.
protected void	initializeFrom(Probe<TwissProbeState> probe) Deprecated. Never used
protected TwissProbeState	readStateFrom(DataAdaptor container) Creates a new TwissProbeState object and initializes it from the data source exposing the given DataAdaptor interface.
void	reset() Resets the probe to the saved initial state, if there is one and clears the Trajectory.
double[]	rmsEmittances() Convenience Method: Returns the rms emittances for this state as from the individual Twiss parameters.
void	setBetatronPhase(R3 vecPhase) Set the betatron phase for each phase plane.
void	setCentroid(PhaseVector vecCentroid) Set the centroid location of the beam bunch in homogeneous coordinates.
void	setResponseMatrix(PhaseMatrix matResp) Set the first-order response matrix accumulated by the Envelope since its initial state.
void	setTwiss(Twiss3D.IND_3D iPlane, Twiss twiss) Set the Twiss parameters for the given phase plane.
void	setTwiss(Twiss3D envTwiss) Set all the twiss parameters for the probe

Methods inherited from class xal.model.probe.BunchProbe

beamPerveance, bunchCharge, getBeamCurrent, getBunchFrequency, setBeamCurrent, setBunchFrequency

Methods inherited from class xal.model.probe.Probe

applyState, cloneCurrentProbeState, deepCopy, getAlgorithm, getArchive, getBeta, getComment, getCurrentElement, getCurrentHardwareId, getGamma, getKineticEnergy, getMomentum, getPosition, getSpeciesCharge, getSpeciesName, getSpeciesRestEnergy, getTime, getTimestamp, getTrajectory, initialize, load, newProbeInitializedFrom, performPostProcessing, readFrom, save, setAlgorithm, setComment, setCurrentElement, setCurrentHardwareId, setKineticEnergy, setPosition, setSpeciesCharge, setSpeciesName, setSpeciesRestEnergy, setTime, setTimestamp, setTracking, update

Methods inherited from class java.lang.Object

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

Constructor Detail

TwissProbe

public TwissProbe()

Default Constructor. Creates a new, empty instance of TwissProbe

TwissProbe

public TwissProbe(TwissProbe prbParent)

Copy constructor - clones the argument

Parameters:

prbParent - TwissProbe object to be cloned

TwissProbe

public TwissProbe(DataAdaptor daSource)
           throws DataFormatException

Initializing constructor - initialize from data adaptor Create an new TwissProbe object and initialize its state variables according to the data in the data source exposing the DataAdaptor interface.

Parameters:

daSource - data source containing state variable values

Throws:

DataFormatException - unable to parse, bad data format

Method Detail

initializeFrom

@Deprecated
protected void initializeFrom(Probe<TwissProbeState> probe)

Deprecated. Never used

Initialize this probe from the one specified.

Overrides:

initializeFrom in class Probe<TwissProbeState>

Parameters:

probe - to copy

copy

public TwissProbe copy()

Make a deep copy of this probe and return it.

Specified by:

copy in class Probe<TwissProbeState>

Returns:

a clone of this probe object

Since:

Nov 5, 2013

See Also:

Probe.copy()

setCentroid

public void setCentroid(PhaseVector vecCentroid)

Set the centroid location of the beam bunch in homogeneous coordinates.

Parameters:

vecCentroid - new centroid of the bunch (x,x',y,y',z,z',1)

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

setBetatronPhase

public void setBetatronPhase(R3 vecPhase)

Set the betatron phase for each phase plane.

Parameters:

vecPhase - vector (ψ_x,ψ_y,ψ_z) of betatron phases in radians

setTwiss

public void setTwiss(Twiss3D.IND_3D iPlane,
                     Twiss twiss)

Set the Twiss parameters for the given phase plane.

Parameters:

iPlane - phase plane index

twiss - twiss parameters

setTwiss

public void setTwiss(Twiss3D envTwiss)

Set all the twiss parameters for the probe

Parameters:

envTwiss - new 3 dimensional array of Twiss objects (hor, vert,long)

See Also:

Twiss

getCentroid

public PhaseVector getCentroid()

Get the centroid location of the beam bunch in homogeneous coordinates.

Returns:

centroid of the bunch (x,x',y,y',z,z',1)

getResponseMatrix

public PhaseMatrix getResponseMatrix()

Get the first-order response matrix accumulated by the probe since its initial state.

Returns:

first-order response matrix in homogeneous coordinates

getBetatronPhase

public R3 getBetatronPhase()

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

Returns:

vector (ψ_x,ψ_y,ψ_z) of betatron phases in radians

getTwiss

public Twiss getTwiss(Twiss3D.IND_3D iPlane)

Returns the Twiss parameters for the given phase plane.

Parameters:

iPlane - phase plane index

Returns:

twiss parameters for given phase plane

getTwiss

public Twiss3D getTwiss()

Returns the array of Twiss parameters for this state for all three planes.

Returns:

array(twiss-H, twiss-V, twiss-L)

rmsEmittances

public double[] rmsEmittances()

Convenience Method: Returns the rms emittances for this state as from the individual Twiss parameters.

Returns:

array (ex,ey,ez) of rms emittances

createProbeState

public TwissProbeState createProbeState()

Creates a snapshot of the current state and returns it as a ProbeState object of the proper type.

Specified by:

createProbeState in class BunchProbe<TwissProbeState>

Returns:

a new TwissProbeState encapsulating the probe's current state

See Also:

Probe.createProbeState()

createEmptyProbeState

public TwissProbeState createEmptyProbeState()

Creates a new, empty TwissProbeState.

Specified by:

createEmptyProbeState in class BunchProbe<TwissProbeState>

Returns:

a new, empty TwissProbeState

Since:

Jul 1, 2014

createTrajectory

public Trajectory<TwissProbeState> createTrajectory()

Creates a Trajectory<TwissProbeState> object of the proper type for saving the probe's history.

Specified by:

createTrajectory in class Probe<TwissProbeState>

Returns:

a new, empty Trajectory<TwissProbeState> for saving the probe's history

reset

public void reset()

Resets the probe to the saved initial state, if there is one and clears the Trajectory.

Overrides:

reset in class Probe<TwissProbeState>

Since:

Nov 5, 2013

See Also:

Probe.reset()

readStateFrom

protected TwissProbeState readStateFrom(DataAdaptor container)
                                 throws ParsingException

Creates a new TwissProbeState object and initializes it from the data source exposing the given DataAdaptor interface.

Specified by:

readStateFrom in class Probe<TwissProbeState>

Parameters:

container - DataAdaptor to read a Trajectory from

Returns:

the newly instantiated and initialized TwissProbeState object

Throws:

ParsingException - error encountered reading the DataAdaptor

Since:

Nov 5, 2013

See Also:

Probe.readStateFrom(xal.tools.data.DataAdaptor)