Package xal.extension.jels.model.probe

Class ElsProbe

java.lang.Object

xal.model.probe.Probe<S>

xal.model.probe.BunchProbe<EnvelopeProbeState>

xal.model.probe.EnvelopeProbe

xal.extension.jels.model.probe.ElsProbe

All Implemented Interfaces:

IProbe, IArchive

public class ElsProbe
extends EnvelopeProbe

This is a probe ported from ELS implementation. State of the beam is kept in 9-vector called envelope. Given by (beta_x,alpha_x,gamma_x, .._y, .._z). Normalized emmitance is also kept in 3-vector.

Author:

Emanuele Laface, Ivo List <ivo.list@cosylab.com>

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

LIGHT_SPEED, PERMITTIVITY, UNIT_CHARGE

Constructor Summary

Constructors

Constructor	Description
ElsProbe()

Method Summary

Modifier and Type	Method	Description
EnvelopeProbeState	createProbeState()	Creates a snapshot of the current state and returns it as a ProbeState object of the proper type.
CovarianceMatrix	getCovariance()	Returns the correlation matrix for the beam in homogeneous phase space coordinates.
GenericMatrix	getEnvelope()
Twiss[]	getTwiss()
void	initFromTwiss(Twiss[] twiss)	Set the Twiss parameters for each phase plane.
void	reset()	Resets the probe to the saved initial state, if there is one and clears the Trajectory.
void	setCorrelation(CovarianceMatrix matTau)
void	setEnvelope(GenericMatrix envelope)

Methods inherited from class xal.model.probe.EnvelopeProbe

copy, createEmptyProbeState, createTrajectory, getCurrentResponseMatrix, getResponseMatrix, getResponseMatrixNoSpaceCharge, initializeFrom, newInstance, phaseCovariance, phaseMean, readStateFrom, setCovariance, setCurrentResponseMatrix, setResponseMatrix, setResponseMatrixNoSpaceCharge, stateResponse

Methods inherited from class xal.model.probe.BunchProbe

beamDCPerveance, beamPerveance, bunchCharge, getBeamCurrent, getBunchFrequency, setBeamCurrent, setBunchFrequency

Methods inherited from class xal.model.probe.Probe

applyState, cloneCurrentProbeState, deepCopy, getAlgorithm, getArchive, getBeta, getComment, getCurrentElement, getCurrentElementTypeId, getCurrentHardwareId, getCurrentState, getGamma, getInitialState, getKineticEnergy, getLongitinalPhase, getMomentum, getPosition, getSpeciesCharge, getSpeciesName, getSpeciesRestEnergy, getTime, getTimestamp, getTrajectory, initialize, load, lookupLastStateFor, newProbeInitializedFrom, performPostProcessing, readFrom, save, setAlgorithm, setComment, setCurrentElement, setCurrentElementTypeId, setCurrentHardwareId, setKineticEnergy, setLongitudinalPhase, 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 Details

ElsProbe

public ElsProbe()

Method Details

createProbeState

public EnvelopeProbeState createProbeState()

Description copied from class: EnvelopeProbe

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

Overrides:

createProbeState in class EnvelopeProbe

Returns:

a new EnvelopeProbeState encapsulating the probe's current state

See Also:

• Probe.createProbeState()

initFromTwiss

public void initFromTwiss(Twiss[] twiss)

Description copied from class: EnvelopeProbe

Set the Twiss parameters for each phase plane. CKA NOTES: - The current method signature is misleading. If there is an beam axis offset before this method is called, then that offset is preserved, but the previous correlation matrix is wiped out. Thus, even though the method signature suggests there will be no offset, there can be.

Overrides:

initFromTwiss in class EnvelopeProbe

Parameters:

twiss - array of Twiss objects for H, V , long. directions

getEnvelope

public GenericMatrix getEnvelope()

setEnvelope

public void setEnvelope(GenericMatrix envelope)

getTwiss

public Twiss[] getTwiss()

getCovariance

public CovarianceMatrix getCovariance()

Description copied from class: EnvelopeProbe

Returns the correlation matrix for the beam in homogeneous phase space coordinates. This is the primary state object for an EnvelopeProbe object.

Overrides:

getCovariance in class EnvelopeProbe

Returns:

the 7x7 matrix <z*z^T> in homogeneous coordinates

setCorrelation

public void setCorrelation(CovarianceMatrix matTau)

reset

public void reset()

Description copied from class: EnvelopeProbe

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

Overrides:

reset in class EnvelopeProbe