Uses of Class
xal.tools.beam.PhaseVector

Packages that use PhaseVector

Package	Description
xal.extension.jels
xal.extension.tracewinimporter
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.ens

Uses of PhaseVector in xal.extension.jels

Methods in xal.extension.jels with parameters of type PhaseVector

Modifier and Type	Method	Description
static void	ImporterHelpers.addInitialParameters(Accelerator accelerator, double bunchFrequency, double beamCurrent, double kineticEnergy, PhaseVector initialCentroid, Twiss[] initialTwiss)
static void	ImporterHelpers.setupInitialParameters(EnvelopeProbe probe, double bunchFrequency, double beamCurrent, double kineticEnergy, PhaseVector vecCent, Twiss[] initialTwiss)

Uses of PhaseVector in xal.extension.tracewinimporter

Methods in xal.extension.tracewinimporter that return PhaseVector

Modifier and Type	Method	Description
PhaseVector	IniFileParser.getInitialCentroid()
PhaseVector	TraceWin.getInitialCentroids()

Methods in xal.extension.tracewinimporter with parameters of type PhaseVector

Modifier and Type	Method	Description
void	TraceWin.setInitialCentroid(PhaseVector initialCentroid)

Uses of PhaseVector in xal.model.probe

Methods in xal.model.probe that return PhaseVector

Modifier and Type	Method	Description
PhaseVector	TwissProbe.getCentroid()	Get the centroid location of the beam bunch in homogeneous coordinates.
PhaseVector	ParticleProbe.getFixedOrbit()	Deprecated. This is a duplicate of ParticleProbe.getPhaseCoordinates() but with a misleading name.
PhaseVector	ParticleProbe.getPhaseCoordinates()	Returns homogeneous phase space coordinates of the particle.
PhaseVector	EnsembleProbe.phaseMean()	Return the coordinates of the ensemble centroid.
PhaseVector	EnvelopeProbe.phaseMean()	Return the phase space coordinates of the centroid in homogeneous coordinates

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

Modifier and Type	Method	Description
void	TwissProbe.setCentroid(PhaseVector vecCentroid)	Set the centroid location of the beam bunch in homogeneous coordinates.
void	ParticleProbe.setPhaseCoordinates(PhaseVector vecPhase)	Set the phase space coordinates of the probe.

Uses of PhaseVector in xal.model.probe.traj

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

Modifier and Type	Method	Description
PhaseVector	TwissProbeState.getCentroid()	Get the centroid location of the beam bunch in homogeneous coordinates.
PhaseVector	ParticleProbeState.getFixedOrbit()	Deprecated. This is a duplicate of ParticleProbeState.getPhaseCoordinates() but with a misleading name.
PhaseVector	TwissProbeState.getFixedOrbit()	Get the fixed orbit about which betatron oscillations occur.
PhaseVector	ParticleProbeState.getPhaseCoordinates()	Returns homogeneous phase space coordinates of the particle.
PhaseVector	TwissProbeState.getPhaseCoordinates()	Returns homogeneous phase space coordinates of the centroid.
PhaseVector	EnsembleProbeState.phaseMean()	Return the coordinates of the ensemble centroid.
PhaseVector	EnvelopeProbeState.phaseMean()	Convenience Method: Return the phase space coordinates of the centroid in homogeneous coordinates.

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

Modifier and Type	Method	Description
void	TwissProbeState.setCentroid(PhaseVector vecCentroid)	Set the centroid location of the beam bunch in homogeneous coordinates.
void	ParticleProbeState.setPhaseCoordinates(PhaseVector vecPhase)	Set the phase space coordinates of the probe.

Uses of PhaseVector in xal.tools.beam

Methods in xal.tools.beam that return PhaseVector

Modifier and Type	Method	Description
PhaseVector	PhaseMap.apply(PhaseVector vecIn)	Apply this map to the given phase vector.
PhaseVector	ImpactXalUnitConverter.centroidFromXal(CovarianceMatrix matCorrel)	Compute and return the beam centroid coordinates from the correlation matrix in homogeneous coordinates.
PhaseVector	TraceXalUnitConverter.centroidFromXal(CovarianceMatrix matCorrel)	Compute and return the beam centroid coordinates from the correlation matrix in homogeneous coordinates.
PhaseVector	PhaseVector.clone()	Creates and returns a deep copy of this vector.
static PhaseVector	PhaseVector.copy(PhaseVector vecParent)	Creates a deep copy of the given PhaseVector object.
static PhaseVector	PhaseVector.embed(R4 vecCoords)	Embeds the given vector z ∈ R4 into homogeneous phase space.
static PhaseVector	PhaseVector.embed(R6 vecCoords)	Embeds the given vector z ∈ R6 into homogeneous phase space.
PhaseVector	PhaseMap.getDomainCenter()	Returns the map center in its domain.
PhaseVector	CovarianceMatrix.getMean()	Return the phase space coordinates of the centroid in homogeneous coordinates.
PhaseVector	PhaseMap.getRangeDisplace()	Get the map offset in the range, the vector Δ0 in the class documentation.
PhaseVector	ImpactXalUnitConverter.impactToXalCoordinates(PhaseVector vecCoords)	Converts phase vector values in Trace3D units to values in units used by XAL (MKS).
static PhaseVector	PhaseVector.loadFrom(DataAdaptor daSource)	Create a new PhaseVector object and initialize with the data source behind the given DataAdaptor interface.
PhaseVector	PhaseVector.minus(PhaseVector vecSub)	Must override to protect the homogeneous coordinate.
PhaseVector	PhaseVector.negate()	Must override to protect the homogeneous coordinate.
protected PhaseVector	PhaseVector.newInstance(double[] arrVecInt)
protected PhaseVector	PhaseVector.newInstance(int size)	Handles object creation required by the base class.
static PhaseVector	PhaseVector.newZero()	Create a new instance of a zero phase vector.
static PhaseVector	PhaseVector.parse(String strTokens)	Create a new instance of PhaseVector with initial value determined by the formatted string argument.
PhaseVector	PhaseVector.plus(PhaseVector vecAdd)	Must override to protect the homogeneous coordinate.
PhaseVector	PhaseVector.times(double s)	Must override to protect the homogeneous coordinate.
PhaseVector	TraceXalUnitConverter.traceToXalCoordinates(PhaseVector vecCoords)	Converts phase vector values in Trace3D units to values in units used by XAL (MKS).
PhaseVector	ImpactXalUnitConverter.xalToImpactCoordinates(PhaseVector vecCoords)	Converts phase vector values in XAL (MKS) units to values in units used by Trace3D.
PhaseVector	TraceXalUnitConverter.xalToTraceCoordinates(PhaseVector vecCoords)	Converts phase vector values in XAL (MKS) units to values in units used by Trace3D.

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

Modifier and Type	Method	Description
PhaseVector	PhaseMap.apply(PhaseVector vecIn)	Apply this map to the given phase vector.
static CovarianceMatrix	CovarianceMatrix.buildCovariance(Twiss twissX, Twiss twissY, Twiss twissZ, PhaseVector vecCen)	Create a CovarianceMatrix corresponding to the given Twiss parameters and having the given mean values (centroid location).
static PhaseVector	PhaseVector.copy(PhaseVector vecParent)	Creates a deep copy of the given PhaseVector object.
CovarianceMatrix	ImpactXalUnitConverter.correlationMatrixFromT3d(Twiss t3dX, Twiss t3dY, Twiss t3dZ, PhaseVector centroid)	Builds a correlation matrix from Twiss parameters in the three phase planes.
CovarianceMatrix	TraceXalUnitConverter.correlationMatrixFromT3d(Twiss t3dX, Twiss t3dY, Twiss t3dZ, PhaseVector centroid)	Builds a correlation matrix from Twiss parameters in the three phase planes.
PhaseVector	ImpactXalUnitConverter.impactToXalCoordinates(PhaseVector vecCoords)	Converts phase vector values in Trace3D units to values in units used by XAL (MKS).
double	PhaseVector.innerProd(PhaseVector v)	Must override to account for the homogeneous coordinate.
PhaseVector	PhaseVector.minus(PhaseVector vecSub)	Must override to protect the homogeneous coordinate.
void	PhaseVector.minusEquals(PhaseVector vecSub)	Must override to protect the homogeneous coordinate.
static CovarianceMatrix	CovarianceMatrix.newCenter(PhaseVector vecCen)	Create a "center matrix" corresponding the given mean values (centroid location).
PhaseMatrix	PhaseVector.outerProd(PhaseVector vec)	Vector outer product operation.
PhaseVector	PhaseVector.plus(PhaseVector vecAdd)	Must override to protect the homogeneous coordinate.
void	PhaseVector.plusEquals(PhaseVector vecAdd)	Must override to protect the homogeneous coordinate.
void	PhaseMap.setDomainCenter(PhaseVector vecDomCntr)	Set the map's domain center, or z0 in the notation of the class documentation.
void	PhaseMap.setRangeDisplace(PhaseVector vecRngDspl)	Set the map's offset in the range, this is the quantity Δ0 in the class documentation.
PhaseVector	TraceXalUnitConverter.traceToXalCoordinates(PhaseVector vecCoords)	Converts phase vector values in Trace3D units to values in units used by XAL (MKS).
static PhaseMatrix	PhaseMatrix.translation(PhaseVector vecTrans)	Create a phase matrix representing a linear translation operator on homogeneous phase space.
PhaseVector	ImpactXalUnitConverter.xalToImpactCoordinates(PhaseVector vecCoords)	Converts phase vector values in XAL (MKS) units to values in units used by Trace3D.
PhaseVector	TraceXalUnitConverter.xalToTraceCoordinates(PhaseVector vecCoords)	Converts phase vector values in XAL (MKS) units to values in units used by Trace3D.

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

Modifier	Constructor	Description
	PhaseMap(PhaseVector vecDispl)	Create a new instance of PhaseMap which behaves as simple translation in phase space given by the specified displacement vector.
	PhaseMap(PhaseVector vecCntr, PhaseVector vecDspl, PhaseMatrix matLin)	Initializing constructor for PhaseMap class.
	PhaseVector(PhaseVector vecInit)	Copy Constructor Creates new PhaseVector object which is a deep copy of the given argument.

Uses of PhaseVector in xal.tools.beam.calc

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

Modifier and Type	Method	Description
protected PhaseVector	CalculationEngine.calculateFixedPoint(PhaseMatrix matPhi)	Taken from TransferMapState.
PhaseVector	CalculationsOnBeams.computeChromAberration(EnvelopeProbeState state)	Computes the chromatic aberration for one pass around the ring starting at the given state location, or from the entrance to state position for a linear machine.
PhaseVector	CalculationsOnMachines.computeChromAberration(TransferMapState state)	Computes the chromatic aberration for one pass around the ring starting at the given state location, or from the entrance to state position for a linear machine.
PhaseVector	CalculationsOnParticles.computeChromAberration(ParticleProbeState state)	Computes the chromatic aberration for one pass of the particle around the ring starting at the given state location, or for a beamline the entrance of the line to this state position.
PhaseVector	ISimulationResults.ISimLocResults.computeChromAberration(S state)	Compute and return the aberration at the given state location due to energy spread.
PhaseVector	SimResultsAdaptor.computeChromAberration(ProbeState<?> state)
PhaseVector	CalculationsOnBeams.computeChromDispersion(EnvelopeProbeState state)	Convenience function for returning the chromatic dispersion coefficients as defined by D.C.
PhaseVector	CalculationsOnMachines.computeChromDispersion(TransferMapState state)	Calculates the fixed point (closed orbit) in transverse phase space at the given state location in the presence of dispersion.
PhaseVector	ISimulationResults.ISimEnvResults.computeChromDispersion(S state)	Calculates the fixed point (closed orbit) in transverse phase space at the given state Sn location sn in the presence of dispersion.
PhaseVector	SimResultsAdaptor.computeChromDispersion(ProbeState<?> state)
PhaseVector	CalculationsOnBeams.computeCoordinatePosition(EnvelopeProbeState state)	Returns the centroid location of the beam envelope.
PhaseVector	CalculationsOnMachines.computeCoordinatePosition(TransferMapState state)	We return the projective portion of the full-turn transfer map φn : P6 → P6 where n is the index of the given state Sn.
PhaseVector	CalculationsOnParticles.computeCoordinatePosition(ParticleProbeState state)	Simply returns the location of the simulated particle at the location of the give state.
PhaseVector	ISimulationResults.ISimLocResults.computeCoordinatePosition(S state)	Returns homogeneous phase space coordinates of something involving the simulation data.
PhaseVector	SimResultsAdaptor.computeCoordinatePosition(ProbeState<?> state)
PhaseVector	CalculationsOnBeams.computeFixedOrbit(EnvelopeProbeState state)	IMPORTANT NOTE
PhaseVector	CalculationsOnMachines.computeFixedOrbit(TransferMapState state)	Get the fixed point at this state location about which betatron oscillations occur.
PhaseVector	CalculationsOnParticles.computeFixedOrbit(ParticleProbeState state)	IMPORTANT NOTE
PhaseVector	ISimulationResults.ISimLocResults.computeFixedOrbit(S state)	Computes the fixed orbit about which betatron oscillations occur.
PhaseVector	SimResultsAdaptor.computeFixedOrbit(ProbeState<?> state)
PhaseVector[]	CalculationsOnRings.computeTurnByTurnResponse(TransferMapState stateInj, TransferMapState stateObs, int cntTurns, PhaseVector vecInj)	Computes and returns the turn-by-turn phase positions {zn ∈ R6 × {1} | n=0,...,N-1 } at the given location sobs of state Sobs resulting from a particle injected at location sinj ∈ Sinj with initial phase coordinates zinj.
PhaseVector[]	CalculationsOnRings.computeTurnByTurnRespWrtFixedOrbit(TransferMapState stateInj, TransferMapState stateObs, int cntTurns, PhaseVector vecInj)	Computes and returns the turn-by-turn phase positions {zn ∈ R6 × {1} | n=0,...,N-1 } at the given location sobs of state Sobs resulting from a particle injected at location sinj ∈ Sinj with initial phase coordinates zinj.
PhaseVector	CalculationsOnBeams.periodFixedOrbitPt()	Returns the phase space location of the fixed orbit at the simulation start (which is computed at instantiation) assuming the simulation is that for at least one period of a periodic accelerating or transport section.
PhaseVector	CalculationsOnParticles.periodFixedOrbitPt()	Returns the phase space location of the fixed point at the simulation start (which is computed at instantiation) assuming the simulation is that for at least one period of a periodic accelerating or transport section.
PhaseVector	CalculationsOnRings.ringFixedOrbitPt()	Returns the phase space location of the fixed orbit at the ring entrance (which is computed at instantiation).

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

Modifier and Type	Method	Description
PhaseVector[]	CalculationsOnRings.computeTurnByTurnResponse(TransferMapState stateInj, TransferMapState stateObs, int cntTurns, PhaseVector vecInj)	Computes and returns the turn-by-turn phase positions {zn ∈ R6 × {1} | n=0,...,N-1 } at the given location sobs of state Sobs resulting from a particle injected at location sinj ∈ Sinj with initial phase coordinates zinj.
PhaseVector[]	CalculationsOnRings.computeTurnByTurnRespWrtFixedOrbit(TransferMapState stateInj, TransferMapState stateObs, int cntTurns, PhaseVector vecInj)	Computes and returns the turn-by-turn phase positions {zn ∈ R6 × {1} | n=0,...,N-1 } at the given location sobs of state Sobs resulting from a particle injected at location sinj ∈ Sinj with initial phase coordinates zinj.

Uses of PhaseVector in xal.tools.beam.ens

Methods in xal.tools.beam.ens that return PhaseVector

Modifier and Type	Method	Description
PhaseVector	Particle.getPhase()	Get the entire (homogeneous) phase space coordinates of particle
PhaseVector	Ensemble.phaseMean()	Compute the centroid of the ensemble

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

Modifier and Type	Method	Description
void	Particle.setPhase(PhaseVector z)	Set (homogeneous) phase space coordinates of particle

Constructors in xal.tools.beam.ens with parameters of type PhaseVector

Modifier	Constructor	Description
	Particle(double q, double m, PhaseVector z)	Creates a new instance of Particle