Package 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.
Version:
$id:
Author:
Craig McChesney

  • Field Details

  • Constructor Details

    • 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 Details

    • setPhaseCoordinates

      public void setPhaseCoordinates(PhaseVector vecPhase)
      Set the phase space coordinates of the probe. This is the location z in homogeneous phase space coordinates R6 × {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 z0 at the start of the simulation. That is,

          Φ ≡ ∂z/∂z0

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

      Parameters:
      matResp - the response matrix Φ ≡ ∂z/∂z0the 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 R6 × {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 z0 at the start of the simulation. That is,

          Φ ≡ ∂z/∂z0

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

      Returns:
      the response matrix Φ ≡ ∂z/∂z0

    • 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 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 copy of this ParticleProbeState

    • 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 DataFormatException
      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:
      DataFormatException - state information in data source is malformatted