xal.model.probe.traj

Class ParticleProbeState

java.lang.Object

xal.model.probe.traj.ProbeState<ParticleProbeState>

xal.model.probe.traj.ParticleProbeState

All Implemented Interfaces:

IProbeState, IArchive

public class ParticleProbeState
extends ProbeState<ParticleProbeState>

Encapsulates the state of a ParticleProbe at a particular point in time.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	PARTICLE_LABEL element tag for particle data
protected static java.lang.String	X_LABEL
protected static java.lang.String	XP_LABEL
protected static java.lang.String	Y_LABEL
protected static java.lang.String	YP_LABEL
protected static java.lang.String	Z_LABEL
protected static java.lang.String	ZP_LABEL

Fields inherited from class xal.model.probe.traj.ProbeState

STATE_LABEL, TYPE_LABEL

Fields inherited from interface xal.model.probe.traj.IProbeState

LightSpeed

Constructor Summary

Constructors

Constructor and Description
ParticleProbeState() Default constructor.
ParticleProbeState(ParticleProbe probe) Initializing constructor.
ParticleProbeState(ParticleProbeState particleProbeState) Copy constructor for ParticleProbeState.

Method Summary

Modifier and Type	Method and Description
protected void	addPropertiesTo(DataAdaptor container) Save the state values particular to BunchProbeState objects to the data sink.
ParticleProbeState	copy() Copies and returns a new, identical instance of this ParticleProbeState.
PhaseVector	getFixedOrbit() Deprecated. This is a duplicate of getPhaseCoordinates() but with a misleading name. I plan to get rid of it.
PhaseVector	getPhaseCoordinates() Returns homogeneous phase space coordinates of the particle.
PhaseMatrix	getResponseMatrix() Returns the response matrix Φ for the particle at the given state location z.
protected void	readPropertiesFrom(DataAdaptor container) Recover the state values particular to BunchProbeState objects from the data source.
void	setPhaseCoordinates(PhaseVector vecPhase) Set the phase space coordinates of the probe.
void	setResponseMatrix(PhaseMatrix matResp) Set the response matrix Φ for the particle at the given state location z.
java.lang.String	toString() Write out the state information in text form.

Methods inherited from class xal.model.probe.traj.ProbeState

computeBetaFromGamma, computeGammaFromBeta, computeGammaFromW, getBeta, getBetaGamma, getElementId, getGamma, getHardwareNodeId, getKineticEnergy, getMomentum, getPosition, getSpeciesCharge, getSpeciesRestEnergy, getTime, load, save, setElementId, setHardwareNodeId, setKineticEnergy, setPosition, setSpeciesCharge, setSpeciesRestEnergy, setTime

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PARTICLE_LABEL

protected static final java.lang.String PARTICLE_LABEL

element tag for particle data

See Also:

Constant Field Values

X_LABEL

protected static final java.lang.String X_LABEL

See Also:

Constant Field Values

Y_LABEL

protected static final java.lang.String Y_LABEL

See Also:

Constant Field Values

Z_LABEL

protected static final java.lang.String Z_LABEL

See Also:

Constant Field Values

XP_LABEL

protected static final java.lang.String XP_LABEL

See Also:

Constant Field Values

YP_LABEL

protected static final java.lang.String YP_LABEL

See Also:

Constant Field Values

ZP_LABEL

protected static final java.lang.String ZP_LABEL

See Also:

Constant Field Values

Constructor Detail

ParticleProbeState

public ParticleProbeState()

Default constructor. Creates a new, empty ParticleProbeState object.

ParticleProbeState

public ParticleProbeState(ParticleProbeState particleProbeState)

Copy constructor for ParticleProbeState. Initializes the new ParticleProbeState objects with the state attributes of the given ParticleProbeState.

Parameters:

particleProbeState - initializing state

Since:

Jun 26, 2014

ParticleProbeState

public ParticleProbeState(ParticleProbe probe)

Initializing constructor. Creates a new ParticleProbeState object which contains a deep copy of the state of the given probe object.

Parameters:

probe - ParticleProbe containing cloned initial state data

Method Detail

setPhaseCoordinates

public void setPhaseCoordinates(PhaseVector vecPhase)

Set the phase space coordinates of the probe. This is the location z in homogeneous phase space coordinates R⁶ × {1}.

Parameters:

vecPhase - new homogeneous phase space coordinate vector z = (x, x', y, y', z, z', 1)^T

setResponseMatrix

public void setResponseMatrix(PhaseMatrix matResp)

Set the response matrix Φ for the particle at the given state location z. The response matrix represents the sensitivity of the current phase coordinate position z to the initial phase coordinate location z₀ at the start of the simulation. That is,

Φ ≡ ∂z/∂z₀

so that small changes Δz₀ in the initial phase position yield a corresponding change Δz = ΦΔz₀ in the current particle location.

Parameters:

matResp - the response matrix Φ ≡ ∂z/∂z₀the matResp to set

getPhaseCoordinates

public PhaseVector getPhaseCoordinates()

Returns homogeneous phase space coordinates of the particle. The units are meters and radians.

This is the location z in homogeneous phase space coordinates R⁶ × {1}.

Returns:

vector z = (x,x',y,y',z,z',1)^T of phase space coordinates

getResponseMatrix

public PhaseMatrix getResponseMatrix()

Returns the response matrix Φ for the particle at the given state location z. The response matrix represents the sensitivity of the current phase coordinate position z to the initial phase coordinate location z₀ at the start of the simulation. That is,

Φ ≡ ∂z/∂z₀

so that small changes Δz₀ in the initial phase position yield a corresponding change Δz = ΦΔz₀ in the current particle location.

Returns:

the response matrix Φ ≡ ∂z/∂z₀

getFixedOrbit

@Deprecated
public PhaseVector getFixedOrbit()

Deprecated. This is a duplicate of getPhaseCoordinates() but with a misleading name. I plan to get rid of it.

Get the fixed orbit about which betatron oscillations occur.

Returns:

the reference orbit vector (x,x',y,y',z,z',1)

toString

public java.lang.String toString()

Write out the state information in text form.

Overrides:

toString in class ProbeState<ParticleProbeState>

Returns:

internal state information as a String.

copy

public ParticleProbeState copy()

Copies and returns a new, identical instance of this ParticleProbeState.

Specified by:

copy in class ProbeState<ParticleProbeState>

Returns:

a deep copy of this object.

addPropertiesTo

protected void addPropertiesTo(DataAdaptor container)

Save the state values particular to BunchProbeState objects to the data sink.

Overrides:

addPropertiesTo in class ProbeState<ParticleProbeState>

Parameters:

container - data sink represented by DataAdaptor interface

readPropertiesFrom

protected void readPropertiesFrom(DataAdaptor container)
                           throws ParsingException

Recover the state values particular to BunchProbeState objects from the data source.

Overrides:

readPropertiesFrom in class ProbeState<ParticleProbeState>

Parameters:

container - data source represented by a DataAdaptor interface

Throws:

ParsingException - state information in data source is malformatted