Uses of Class
xal.tools.beam.PhaseMap

Packages that use PhaseMap

Package	Description
xal.extension.jels.model.elem	Combination of modeling elements from TraceWin documentation put into OpenXAL reference frame.
xal.model	The Online Model
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

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

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

Modifier and Type	Method	Description
protected PhaseMap	IdealMagDipoleFace.transferMap(IProbe probe)	Compute and return the transfer map for this dipole magnet pole face element.
PhaseMap	IdealMagSectorDipole.transferMap(IProbe probe, double dblLen)	Compute the partial transfer map of an ideal sector magnet for the particular probe.
protected PhaseMap	IdealRfGap.transferMap(IProbe probe)	Compute the transfer map for an ideal RF gap.
PhaseMap	RfqDummyModel.transferMap(IProbe probe, double dblLen)
PhaseMap	ThickMagFieldMap.transferMap(IProbe probe, double dblLen)	Method calculates transfer matrix for the field map on the current range (i.e from probe.getPosition, and for dblLength).
PhaseMap	ThickRfFieldMap.transferMap(IProbe probe, double dblLen)	Method calculates transfer matrix for the field map on the current range (i.e from probe.getPosition, and for dblLength).
PhaseMap	ThinMagFieldMap.transferMap(IProbe probe)	Method calculates transfer matrix for the field map for a given data point in the field map.
PhaseMap	ThinRfFieldMap.transferMap(IProbe probe)	Method calculates transfer matrix for the field map for a given data point in the field map.Drift spaces are calculated separately.

Uses of PhaseMap in xal.model

Methods in xal.model that return PhaseMap

Modifier and Type	Method	Description
PhaseMap	RingModel.compOneTurnMatrix(TransferMapProbe probe)	Deprecated. Compute the one-turn map of the ring for a particular TransferMapProbe describing the beam at injection.
PhaseMap	IElement.transferMap(IProbe probe, double dblLen)	Compute the transfer matrix for subsection of this element of length dblLen for the specified given probe.

Uses of PhaseMap in xal.model.elem

Methods in xal.model.elem that return PhaseMap

Modifier and Type	Method	Description
protected PhaseMap	ChargeExchangeFoil.transferMap(IProbe probe)	Returns the transfer map of this element which is the identity.
protected PhaseMap	Collimator.transferMap(IProbe probe)	Returns the transfer map of this element which is the identity.
abstract PhaseMap	Element.transferMap(IProbe probe, double dblLen)	Compute the transfer matrix for subsection of this element of length dblLen for the specified given probe.
PhaseMap	IdealDrift.transferMap(IProbe probe, double dblLen)	Computes the partial transfer map for an ideal drift space.
PhaseMap	IdealEDipole.transferMap(IProbe probe, double dL)	Computes the partial transfer map of an ideal dipole for the particular probe.
PhaseMap	IdealEQuad.transferMap(IProbe probe, double length)	Compute the partial transfer map of an ideal Equadrupole for the particular probe.
protected PhaseMap	IdealMagDipoleFace.transferMap(IProbe probe)	Deprecated.
protected PhaseMap	IdealMagDipoleFace2.transferMap(IProbe probe)	Compute and return the transfer map for this dipole magnet pole face element.
protected PhaseMap	IdealMagFringeQuadFace.transferMap(IProbe probe)	Compute and return the transfer map for this dipole magnet pole face element.
protected PhaseMap	IdealMagOctupole.transferMap(IProbe probe)	Returns the transfer map of this element which is the identity.
PhaseMap	IdealMagQuad.transferMap(IProbe probe, double length)	Compute the partial transfer map of an ideal quadrupole for the particular probe.
PhaseMap	IdealMagSectorDipole.transferMap(IProbe probe, double dL)	Deprecated. Compute the partial transfer map of an ideal sector magnet for the particular probe.
PhaseMap	IdealMagSectorDipole2.transferMap(IProbe probe, double dblLen)	Compute the partial transfer map of an ideal sector magnet for the particular probe.
PhaseMap	IdealMagSextupole.transferMap(IProbe probe, double length)	Determine the transfer map of this element which is simply treated as a drift.
PhaseMap	IdealMagSkewQuad.transferMap(IProbe probe, double length)	Deprecated. Compute the partial transfer map of an ideal skew quadrupole for the particular probe.
PhaseMap	IdealMagSkewQuad3.transferMap(IProbe probe, double length)	Compute the partial transfer map of an ideal quadrupole for the particular probe.
PhaseMap	IdealMagSolenoid.transferMap(IProbe probe, double length)	Compute the partial transfer map of an ideal solenoid for the particular probe.
protected PhaseMap	IdealMagSteeringDipole.transferMap(IProbe probe)	Computes the transfer map for an ideal magnetic dipole.
PhaseMap	IdealPermMagQuad.transferMap(IProbe probe, double dblLen)
PhaseMap	IdealPermMagQuad.transferMap(IProbe probe, double dL, double k, int orientation)	Compute the partial transfer map of an ideal permanent quadrupole for the particular probe.
protected PhaseMap	IdealRfGap.transferMap(IProbe probe)	Compute the transfer map for an ideal RF gap.
protected PhaseMap	IdealRfGapUpgraded.transferMap(IProbe probe)	Compute the transfer map for an ideal RF gap.
protected PhaseMap	Marker.transferMap(IProbe probe)	Returns the transfer map of this element which is the identity.
protected PhaseMap	SpectrumMapRfGap.transferMap(IProbe probe)	Compute the transfer map for an ideal RF gap.
PhaseMap	ThickDipole.transferMap(IProbe probe, double dL)	Compute the partial transfer map of an ideal quadrupole for the particular probe.
abstract PhaseMap	ThickElement.transferMap(IProbe probe, double dblLen)
PhaseMap	ThickMatrix.transferMap(IProbe probe, double dblLen)	Returns the transfer map produced by the generator matrix over the distance dblLen.
protected abstract PhaseMap	ThinElement.transferMap(IProbe probe)	Compute the transfer matrix of this element.
PhaseMap	ThinElement.transferMap(IProbe probe, double dblLen)	Compute the transfer matrix for subsection of this element of length dblLen for the specified given probe.
protected PhaseMap	ThinLens.transferMap(IProbe probe)	Compute and return the block-diagonal transfer matrix representing a thin lens in each phase plane.
protected PhaseMap	ThinMatrix.transferMap(IProbe probe)	Returns the transfer map of this element, which only has a linear component corresponding to the transfer matrix,
PhaseMap	IdealMagSectorDipole.transferMapThickDipole(IProbe probe, double dL)	Deprecated. A version from ThickDipole.

Uses of PhaseMap in xal.model.probe

Methods in xal.model.probe that return PhaseMap

Modifier and Type	Method	Description
PhaseMap	TransferMapProbe.getPartialTransferMap()	Get the partial transfer map for the current probe location.
PhaseMap	TransferMapProbe.getTransferMap()	Get the composite transfer map for the current probe location.

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

Modifier and Type	Method	Description
void	TransferMapProbe.setPartialTransferMap(PhaseMap mapPhi)	Set the partial transfer map at the current probe location.
void	TransferMapProbe.setTransferMap(PhaseMap mapTrans)	Set the current composite transfer map up to the current probe location.

Uses of PhaseMap in xal.model.probe.traj

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

Modifier and Type	Method	Description
PhaseMap	TransferMapState.getPartialTransferMap()	Returns the partial transfer map that transports particle phase coordinates through the space occupied by this state.
PhaseMap	TransferMapState.getTransferMap()	Get the composite transfer map at this state location.

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

Modifier and Type	Method	Description
void	TransferMapState.setPartialTransferMap(PhaseMap mapPart)	Sets the current partial transfer map, or "through map".
void	TransferMapState.setStateTransferMap(PhaseMap mapTrans)	Set the transfer map across this state, from entrance to exit.
void	TransferMapState.setTransferMap(PhaseMap mapTrans)	Set the current composite transfer map up to the current probe location.

Uses of PhaseMap in xal.tools.beam

Methods in xal.tools.beam that return PhaseMap

Modifier and Type	Method	Description
PhaseMap	PhaseMap.compose(PhaseMap mapRight)	Non-destructive map composition - binary composition of two PhaseMaps.
PhaseMap	PhaseMap.copy()	Make a deep copy of this phase map.
static PhaseMap	PhaseMap.identity()	Create an identity phase map
PhaseMap	PhaseMap.inverse()	Compute and return the inverse map φ-1 of this map φ.

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

Modifier and Type	Method	Description
PhaseMap	PhaseMap.compose(PhaseMap mapRight)	Non-destructive map composition - binary composition of two PhaseMaps.
void	PhaseMap.composeEquals(PhaseMap mapRight)	In-place map composition, binary composition of two PhaseMap objects where this map This map φ2 is replaced by φ2 ← φ2 ⋅ φ1 where φ1 the argument map.
void	PhaseMap.setFrom(PhaseMap map)	Set this map to copy the specified map.

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

Modifier	Constructor	Description
	PhaseMap(PhaseMap mapParent)	Copy constructor for PhaseMap.

Uses of PhaseMap in xal.tools.beam.calc

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

Modifier and Type	Method	Description
PhaseMap	CalculationsOnRings.computeRingTransferMap(TransferMapState state1, TransferMapState state2)	Returns the transfer map T2,1 taking phase coordinates from state position S1 to state position S2 within the ring.
static PhaseMap	CalculationsOnMachines.computeTransferMap(TransferMapState state1, TransferMapState state2)	Convenience method for computing the transfer map between two state locations, say S1 and S2.
PhaseMap	CalculationsOnMachines.getFullTransferMap()	Returns the transfer map of the full machine lattice represented by the associated simulation trajectory.
PhaseMap	CalculationsOnRings.getOneTurnMap()	Returns the one-turn map Φ0 for the ring at the location s = 0.