Uses of Class
xal.tools.beam.PhaseMatrix

Packages that use PhaseMatrix

Package	Description
xal.extension.jels.model.elem	Combination of modeling elements from TraceWin documentation put into OpenXAL reference frame.
xal.model.alg
xal.model.elem	Modeling Elements Package Library
xal.model.probe
xal.model.probe.traj
xal.tools.beam	Contains classes for representing particle beams and various aspects and properties of particle beams.
xal.tools.beam.calc
xal.tools.beam.em
xal.tools.beam.ens
xal.tools.math.r4

Uses of PhaseMatrix in xal.extension.jels.model.elem

Subclasses of PhaseMatrix in xal.extension.jels.model.elem

Modifier and Type	Class	Description
class	FieldMapIntegrator	General electromagnetic field map integrator.

Methods in xal.extension.jels.model.elem that return PhaseMatrix

Modifier and Type	Method	Description
PhaseMatrix	TransferMapLoader.TransferMaps.transferMap(IProbe p, double l)

Constructors in xal.extension.jels.model.elem with parameters of type PhaseMatrix

Modifier	Constructor	Description
	FieldMapIntegrator(PhaseMatrix matrix)
	FieldMapIntegrator(PhaseMatrix matrix, String integrator)
	TransferMaps(double[] positions, PhaseMatrix[] transferMaps)

Uses of PhaseMatrix in xal.model.alg

Methods in xal.model.alg that return PhaseMatrix

Modifier and Type	Method	Description
protected PhaseMatrix	EnvelopeTrackerBase.compScheffMatrix(double dblLen, EnvelopeProbe probe, IElement elem)	Method to compute the space charge transfer matrix for the given length, probe and modeling element.
protected PhaseMatrix	EnvelopeTrackerBase.modTransferMatrixForEmitGrowth(double dphi, PhaseMatrix matPhi)	Method to modify the transfer matrix when we are simulating emittance growth.

Methods in xal.model.alg with parameters of type PhaseMatrix

Modifier and Type	Method	Description
protected PhaseMatrix	EnvelopeTrackerBase.modTransferMatrixForEmitGrowth(double dphi, PhaseMatrix matPhi)	Method to modify the transfer matrix when we are simulating emittance growth.

Uses of PhaseMatrix in xal.model.elem

Methods in xal.model.elem that return PhaseMatrix

Modifier and Type	Method	Description
protected PhaseMatrix	ThickElement.applyErrors(PhaseMatrix matPhi, IProbe probe, double length)	Add Rotation and Displacement Error to Transfer Matrix
protected PhaseMatrix	ThinElement.applyErrors(PhaseMatrix matPhi, double length)	Add Rotation and Displacement Error to Transfer Matrix
static PhaseMatrix	IdealMagSkewQuad3.toBeamFrame(PhaseMatrix matQuad)	toBeamFrame

Methods in xal.model.elem with parameters of type PhaseMatrix

Modifier and Type	Method	Description
protected PhaseMatrix	ThickElement.applyErrors(PhaseMatrix matPhi, IProbe probe, double length)	Add Rotation and Displacement Error to Transfer Matrix
protected PhaseMatrix	ThinElement.applyErrors(PhaseMatrix matPhi, double length)	Add Rotation and Displacement Error to Transfer Matrix
void	ThickMatrix.setTransferMapGenerator(PhaseMatrix matGen)	Set the transfer map generator A for the element.
void	ThinMatrix.setTransferMatrix(PhaseMatrix matPhi)	Set the transfer matrix of the element for all probes.
static PhaseMatrix	IdealMagSkewQuad3.toBeamFrame(PhaseMatrix matQuad)	toBeamFrame

Constructors in xal.model.elem with parameters of type PhaseMatrix

Modifier	Constructor	Description
	ThickMatrix(String strId, double dblLen, PhaseMatrix matPhiSub)	Creates a new instance of ThickMatrix.
	ThickMatrix(String strId, double dblLen, PhaseMatrix matPhiSub, double dblDelW)	Creates a new instance of ThickMatrix
	ThinMatrix(String strId, PhaseMatrix matPhi)	Creates a new instance of TransferMatrix.
	ThinMatrix(String strId, PhaseMatrix matPhi, double dblDelW)	Creates a new instance of ThinMatrix

Uses of PhaseMatrix in xal.model.probe

Methods in xal.model.probe that return PhaseMatrix

Modifier and Type	Method	Description
PhaseMatrix	EnvelopeProbe.getCurrentResponseMatrix()	Return the last element in the semigroup of response matrices, that is, the last matrix to be post-multiplied onto the response matrix proper.
PhaseMatrix	EnvelopeProbe.getResponseMatrix()	Get the first-order response matrix accumulated by the Envelope since its initial state.
PhaseMatrix	ParticleProbe.getResponseMatrix()	Returns the response matrix Φ for the particle at the given state location z.
PhaseMatrix	TwissProbe.getResponseMatrix()	Get the first-order response matrix accumulated by the probe since its initial state.
PhaseMatrix	EnvelopeProbe.getResponseMatrixNoSpaceCharge()	Get the first-order response matrix accumulated by the Envelope since its initial state.
PhaseMatrix	EnvelopeProbe.stateResponse(String elemFrom, String elemTo)	Deprecated. This calculation should be done using the utility class xal.tools.beam.calc.CalculationsOnMachines

Methods in xal.model.probe with parameters of type PhaseMatrix

Modifier and Type	Method	Description
void	EnvelopeProbe.setCurrentResponseMatrix(PhaseMatrix matRespCurr)	Set the current factor of the overall response matrix.
void	EnvelopeProbe.setResponseMatrix(PhaseMatrix matResp)	Set the first-order response matrix accumulated by the Envelope since its initial state.
void	ParticleProbe.setResponseMatrix(PhaseMatrix matResp)	Set the response matrix Φ for the particle at the given state location z.
void	TwissProbe.setResponseMatrix(PhaseMatrix matResp)	Set the first-order response matrix accumulated by the Envelope since its initial state.
void	EnvelopeProbe.setResponseMatrixNoSpaceCharge(PhaseMatrix matResp)	Set the first-order response matrix accumulated by the Envelope since its initial state.

Uses of PhaseMatrix in xal.model.probe.traj

Methods in xal.model.probe.traj that return PhaseMatrix

Modifier and Type	Method	Description
PhaseMatrix	EnvelopeProbeState.getPerturbationMatrix()	Get the first-order response matrix of current element slice
PhaseMatrix	EnvelopeProbeState.getResponseMatrix()	Get the first-order response matrix accumulated by the Envelope since its initial state.
PhaseMatrix	ParticleProbeState.getResponseMatrix()	Returns the response matrix Φ for the particle at the given state location z.
PhaseMatrix	TwissProbeState.getResponseMatrix()	Get the first-order response matrix accumulated by the probe since its initial state.
PhaseMatrix	EnvelopeProbeState.getResponseMatrixNoSpaceCharge()	Get the first-order response matrix accumulated by the Envelope since its initial state.

Methods in xal.model.probe.traj with parameters of type PhaseMatrix

Modifier and Type	Method	Description
void	EnvelopeProbeState.setPerturbationMatrix(PhaseMatrix matPerturb)	Set the first-order response matrix of the current element slice
void	EnvelopeProbeState.setResponseMatrix(PhaseMatrix matResp)	Set the first-order response matrix accumulated by the Envelope since its initial state.
void	ParticleProbeState.setResponseMatrix(PhaseMatrix matResp)	Set the response matrix Φ for the particle at the given state location z.
void	TwissProbeState.setResponseMatrix(PhaseMatrix matResp)	Set the first-order response matrix accumulated by the Envelope since its initial state.
void	EnvelopeProbeState.setResponseMatrixNoSpaceCharge(PhaseMatrix matResp)	Set the first-order response matrix accumulated by the Envelope since its initial state.

Uses of PhaseMatrix in xal.tools.beam

Subclasses of PhaseMatrix in xal.tools.beam

Modifier and Type	Class	Description
class	CovarianceMatrix	A CovarianceMatrix in homogeneous coordinates represents all moments of a phase space distribution up to and including second order.

Methods in xal.tools.beam that return PhaseMatrix

Modifier and Type	Method	Description
PhaseMatrix	PhaseMatrix.clone()	Creates and returns a deep copy of this matrix.
PhaseMatrix	PhaseMap.getFirstOrder()	Get the linear portion of the map, this is the quantity Φ0 in the class documentation.
PhaseMatrix	RmsEnvelope.getSigma()	Deprecated.
static PhaseMatrix	PhaseMatrix.identity()	Create an identity phase matrix
static PhaseMatrix	PhaseMatrix.loadFrom(DataAdaptor daSource)	Create a new PhaseMatrix object and initialize with the data source behind the given DataAdaptor interface.
PhaseMatrix	PhaseMatrix.minus(PhaseMatrix matSub)	Non-destructive matrix subtraction.
protected PhaseMatrix	CovarianceMatrix.newInstance(int row, int cnt)	Handles object creation required by the base class.
protected PhaseMatrix	PhaseMatrix.newInstance(int row, int cnt)	Handles object creation required by the base class.
PhaseMatrix	PhaseVector.outerProd(PhaseVector vec)	Vector outer product operation.
static PhaseMatrix	PhaseMatrix.parse(String strTokens)	Create a PhaseMatrix instance and initialize it according to a token string of element values.
PhaseMatrix	RmsEnvelope.phaseCorrelation()	Deprecated. Returns the covariance matrix (sigma matrix) in homogeneous phase space coordinates.
PhaseMatrix	PhaseMatrix.plus(PhaseMatrix matAddend)	Non-destructive matrix addition.
static PhaseMatrix	PhaseMatrix.rotationProduct(R3x3 matSO3)	Compute the rotation matrix in phase space that is essentially the Cartesian product of the given rotation matrix in SO(3).
static PhaseMatrix	PhaseMatrix.spatialTranslation(R3 vecDispl)	Create a phase matrix representing a linear translation operator on homogeneous phase space that only affects the spatial coordinates.
static PhaseMatrix	PhaseMatrix.translation(PhaseVector vecTrans)	Create a phase matrix representing a linear translation operator on homogeneous phase space.
static PhaseMatrix	PhaseMatrix.zero()	Create a new instance of a zero phase matrix.

Methods in xal.tools.beam with parameters of type PhaseMatrix

Modifier and Type	Method	Description
PhaseMatrix	PhaseMatrix.minus(PhaseMatrix matSub)	Non-destructive matrix subtraction.
void	PhaseMatrix.minusEquals(PhaseMatrix matSub)	In-place matrix subtraction.
PhaseMatrix	PhaseMatrix.plus(PhaseMatrix matAddend)	Non-destructive matrix addition.
void	PhaseMatrix.plusEquals(PhaseMatrix matAddend)	In-place matrix addition.
void	RmsEnvelope.setCorrelation(PhaseMatrix m)	Deprecated.
void	PhaseMap.setLinearPart(PhaseMatrix matPhi)	Set the linear part of the map, this is the matrix Φ0 in the notation of the class documentation.

Constructors in xal.tools.beam with parameters of type PhaseMatrix

Modifier	Constructor	Description
	CovarianceMatrix(PhaseMatrix matInit)	Constructor for CovarianceMatrix.
	PhaseMap(PhaseMatrix matTrans)	Create a new instance of PhaseMap which behaves as a linear transform given by the specified matrix.
	PhaseMap(PhaseVector vecCntr, PhaseVector vecDspl, PhaseMatrix matLin)	Initializing constructor for PhaseMap class.
	PhaseMatrix(PhaseMatrix matInit)	Copy Constructor - create a deep copy of the target phase matrix.

Uses of PhaseMatrix in xal.tools.beam.calc

Methods in xal.tools.beam.calc that return PhaseMatrix

Modifier and Type	Method	Description
protected PhaseMatrix	CalculationsOnMachines.calculateFullLatticeMatrixAt(TransferMapState state)	Calculates and returns the full lattice matrix for the machine at the given state location.
PhaseMatrix	CalculationsOnRings.computeRingFullTurnMatrixAt(TransferMapState state)	Computes the one-turn matrix of the ring at the given state location.
PhaseMatrix	CalculationsOnRings.computeRingTransferMatrix(TransferMapState state1, TransferMapState state2)	Returns the transfer matrix Φ2,1 taking phase coordinates from state position S1 to state position S2 within the ring.
PhaseMatrix	CalculationsOnBeams.computeTransferMatrix(String elemFrom, String elemTo)	Returns the state response matrix calculated from the front face of elemFrom to the back face of elemTo.
PhaseMatrix	CalculationsOnMachines.computeTransferMatrix(String strIdElemFrom, String strIdElemTo)	Returns the state response matrix calculated from the front face of elemFrom to the back face of elemTo.
static PhaseMatrix	CalculationsOnMachines.computeTransferMatrix(TransferMapState state1, TransferMapState state2)	Convenience method for computing the transfer matrix between two state locations, say S1 and S2.
PhaseMatrix	CalculationsOnBeams.getFullResponseMatrix()	Returns the transfer map of the full machine lattice represented by the associated simulation trajectory.
PhaseMatrix	CalculationsOnParticles.getFullResponseMatrix()	Returns the full response matrix Φ providing the sensitivity of the final particle position z to the initial conditions z0.

Methods in xal.tools.beam.calc with parameters of type PhaseMatrix

Modifier and Type	Method	Description
protected R6	CalculationEngine.calculateAberration(PhaseMatrix matPhi, double dblGamma)	Convenience function for returning the chromatic aberration coefficients.
protected R4	CalculationEngine.calculateDispersion(PhaseMatrix matPhi, double dblGamma)	Taken from TransferMapState.
protected PhaseVector	CalculationEngine.calculateFixedPoint(PhaseMatrix matPhi)	Taken from TransferMapState.
protected Twiss[]	CalculationEngine.calculateMatchedTwiss(PhaseMatrix matPhiCell)	Taken from TransferMapState.
protected R3	CalculationEngine.calculatePhaseAdvance(PhaseMatrix matPhi, Twiss[] twsInit, Twiss[] twsFinal)	Taken from TransferMapState.
protected R3	CalculationEngine.calculatePhaseAdvPerCell(PhaseMatrix matPhiCell)	Taken from TransferMapTrajectory.
protected R3	CalculationEngine.calculateTunePerCell(PhaseMatrix matPhiCell)	Taken from TransferMapTrajectory.
protected Twiss3D	CalculationEngine.computeTwiss(TwissProbe probe, PhaseMatrix matPhi, double dW)	Deprecated. This is the algorithm component for a TwissProbe and should not be used as the dynamics elsewhere.

Uses of PhaseMatrix in xal.tools.beam.em

Methods in xal.tools.beam.em that return PhaseMatrix

Modifier and Type	Method	Description
PhaseMatrix	BeamEllipsoid.computeDCScheffMatrix(double dblLen, double dblPerveance)
PhaseMatrix	BeamEllipsoid.computeScheffGenerator(double dblPerveance)	Calculates the transfer matrix generator for space charge effects from this BeamEllipsoid object given the generalized beam three-dimensional perveance dblPerveance.
PhaseMatrix	BeamEllipsoid.computeScheffMatrix(double dblLen, double dblPerveance)	Compute and return the transfer matrix for space charge effects due to this beam ellipsoid for the given incremental path length dblLen and generalized beam dblPerveance.
PhaseMatrix	BeamEllipsoid.getBeamToEllipseTransform()	Return the complete transformation from the beam inertial coordinates to the ellipsoid inertial coordinates.
PhaseMatrix	BeamEllipsoid.getLabToBeamTransform()	Return the complete transformation from the laboratory inertial coordinates to the ellipsoid inertial coordinates.
PhaseMatrix	BeamEllipsoid.getLorentzTransform()	Get the Lorentz transform matrix which takes the laboratory coordinates to the beam coordinates.
PhaseMatrix	BeamEllipsoid.getRotation()	Get orthogonal rotation matrix R in SO(7) that rotates the ellipsoid spatial semi-axes onto the spatial coordinate axes.
PhaseMatrix	BeamEllipsoid.getTranslation()	Return the translation matrix which transforms coordinates in the beam frame to those with the ellipsoid centroid as the coordinate origin.

Uses of PhaseMatrix in xal.tools.beam.ens

Methods in xal.tools.beam.ens with parameters of type PhaseMatrix

Modifier and Type	Method	Description
double	Ensemble.potentialQuadExpansion(R3 pt, double q, PhaseMatrix matSigma)	Computes the electric potential from a quadrupole multipole expansion.

Uses of PhaseMatrix in xal.tools.math.r4

Methods in xal.tools.math.r4 with parameters of type PhaseMatrix

Modifier and Type	Method	Description
static R4x4	R4x4.extractTransverse(PhaseMatrix matPhi)	Extracts a copy of the transverse portion of the given PhaseMatrix and returns it.