Package xal.model.probe

Class TransferMapProbe

java.lang.Object

xal.model.probe.Probe<TransferMapState>

xal.model.probe.TransferMapProbe

All Implemented Interfaces:

IProbe, IArchive

public class TransferMapProbe
extends Probe<TransferMapState>

Probe that tracks all the transfer maps between modeling elements. Note there is no beam dynamics per se, the probe simply collects all the transfer maps as provided by the beamline elements for the design synchronous particle.

If you wish to compute the transfer matrices for an envelope model that includes space charge effects, then you should employ and EnvelopeProbe and call the method EnvelopeProbeState.getResponseMatrix().

Since:

May 28, 2004

Version:

Oct 25, 2013

Author:

Christopher K. Allen

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
TransferMapProbe()	Default constructor.
TransferMapProbe(TransferMapProbe probe)	Initializing constructor.

Method Summary

Modifier and Type	Method	Description
TransferMapProbe	copy()	Creates a deep copy of the probe
TransferMapState	createEmptyProbeState()	Creates a new, empty TransferMapState.
TransferMapState	createProbeState()	Return a new ProbeState object, of the appropriate type, initialized to the current state of this probe.
Trajectory<TransferMapState>	createTrajectory()	Creates a Trajectory<TransferMapState> object of the proper type for saving the probe's history.
PhaseMap	getPartialTransferMap()	Get the partial transfer map for the current probe location.
PhaseMap	getTransferMap()	Get the composite transfer map for the current probe location.
protected void	initializeFrom(Probe<TransferMapState> probe)	Deprecated. Never Used
protected TransferMapState	readStateFrom(DataAdaptor container)	Read the contents of the supplied DataAdaptor and return an instance of the appropriate Trajectory species.
void	setPartialTransferMap(PhaseMap mapPhi)	Set the partial transfer map at the current probe location.
void	setTransferMap(PhaseMap mapTrans)	Set the current composite transfer map up to the current probe location.

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, reset, 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

TransferMapProbe

public TransferMapProbe()

Default constructor. Create a new TransferMapProbe with zero initial state.

TransferMapProbe

public TransferMapProbe(TransferMapProbe probe)

Initializing constructor. Create a new TransferMapProbe and initialize its state to that of the given probe.

Parameters:

probe - probe containing initial state information

Method Details

copy

public TransferMapProbe copy()

Description copied from class: Probe

Creates a deep copy of the probe

Specified by:

copy in class Probe<TransferMapState>

setTransferMap

public void setTransferMap(PhaseMap mapTrans)

Set the current composite transfer map up to the current probe location.

Parameters:

mapTrans - transfer map in homogeneous phase coordinates

See Also:

• Probe.createTrajectory()

setPartialTransferMap

public void setPartialTransferMap(PhaseMap mapPhi)

Set the partial transfer map at the current probe location.

Parameters:

mapPhi - transfer map in homogeneous phase coordinates

See Also:

• Probe.createTrajectory()

getTransferMap

public PhaseMap getTransferMap()

Get the composite transfer map for the current probe location.

Returns:

transfer map in homogeneous phase space coordinates

getPartialTransferMap

public PhaseMap getPartialTransferMap()

Get the partial transfer map for the current probe location.

Returns:

partial transfer map in homogeneous phase space coordinates

createTrajectory

public Trajectory<TransferMapState> createTrajectory()

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

Specified by:

createTrajectory in class Probe<TransferMapState>

Returns:

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

createProbeState

public TransferMapState createProbeState()

Return a new ProbeState object, of the appropriate type, initialized to the current state of this probe.

Specified by:

createProbeState in class Probe<TransferMapState>

Returns:

probe state object of type TransferMapState

See Also:

• Probe.createProbeState()

createEmptyProbeState

public TransferMapState createEmptyProbeState()

Creates a new, empty TransferMapState.

Specified by:

createEmptyProbeState in class Probe<TransferMapState>

Returns:

a new, empty TransferMapState

Since:

Jul 1, 2014

initializeFrom

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

Deprecated.

Never Used

Initialize this probe from the one specified.

Overrides:

initializeFrom in class Probe<TransferMapState>

Parameters:

probe - the probe from which to initialize this one

readStateFrom

protected TransferMapState readStateFrom(DataAdaptor container)
                                  throws DataFormatException

Description copied from class: Probe

Read the contents of the supplied DataAdaptor and return an instance of the appropriate Trajectory species.

Specified by:

readStateFrom in class Probe<TransferMapState>

Parameters:

container - DataAdaptor to read a Trajectory from

Returns:

a ProbeState for the contents of the DataAdaptor

Throws:

DataFormatException - error encountered reading the DataAdaptor