Package xal.model.probe.traj

Class TransferMapState

java.lang.Object
xal.model.probe.traj.ProbeState<TransferMapState>
xal.model.probe.traj.TransferMapState
All Implemented Interfaces:
IProbeState, IArchive
public class TransferMapState extends ProbeState<TransferMapState>

Probe state for the transfer map tracker.

NOTES: CKA

· I noticed a very brittle situation with this implementation. ICoordinateState requires the methods @link ICoordinateState#getPhaseCoordinates()} etc. Interface ICoordinateState extends IProbeState. Well, TransferMapState inherits from ProbeState which implements IProbeState. It's getting dicey.
· The TransferMapState is really meant to compute transfer maps only, and be very light weight. If you want to compute closed orbit maps we should make a different probe.

Author:
Christopher K. Allen, t6p

  • Field Details

  • Constructor Details

    • TransferMapState

      public TransferMapState()
      Constructor, create new TransferMapState and initialize to zero state values.

    • TransferMapState

      public TransferMapState(TransferMapState transferMapState)
      Copy constructor for TransferMapState. Initializes the new TransferMapState objects with the state attributes of the given TransferMapState.
      Parameters:
      transferMapState - initializing state
      Since:
      Jun 26, 2014

    • TransferMapState

      public TransferMapState(TransferMapProbe probe)
      Initializing constructor - create a new TransferMapState object and initialize it to the current state of the given probe.
      Parameters:
      probe - probe object with initial state information

  • Method Details

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

    • setPartialTransferMap

      public void setPartialTransferMap(PhaseMap mapPart)
      Sets the current partial transfer map, or "through map". This map transfers particle phase coordinates through a distance occupied by this state.
      Parameters:
      mapPart - transfer map through this state
      Since:
      Nov 22, 2013

    • setStateTransferMap

      public void setStateTransferMap(PhaseMap mapTrans)
      Set the transfer map across this state, from entrance to exit.
      Parameters:
      mapTrans - transfer map in homogeneous phase coordinates
      See Also:

    • getTransferMap

      public PhaseMap getTransferMap()
      Get the composite transfer map at this state location. The composite map φ maps the phase coordinates of particles at the beginning of the TransferMapTrajectory parent (i.e., at the first state of the trajectory object) to this state.
      Returns:
      transfer map in homogeneous phase space coordinates

    • getPartialTransferMap

      public PhaseMap getPartialTransferMap()

      Returns the partial transfer map that transports particle phase coordinates through the space occupied by this state.

      Get the partial transfer map that maps particle phase coordinates from the previous state exit to this state's exit. The product of all these partial transfer maps from the first state to this state would yield the returned value of getTransferMap().

      Returns:
      partial transfer map through this state
      Since:
      Nov 22, 2013

    • copy

      public TransferMapState copy()
      Implements the clone operation required by the base class ProbeState.
      Specified by:
      copy in class ProbeState<TransferMapState>
      Returns:
      a deep copy of this object.
      Since:
      Jun 27, 2014
      See Also:

    • addPropertiesTo

      protected void addPropertiesTo(DataAdaptor daptSink)
      Save the probe state values to a data store represented by the DataAdaptor interface.
      Overrides:
      addPropertiesTo in class ProbeState<TransferMapState>
      Parameters:
      daptSink - data sink to receive state information
      See Also:

    • readPropertiesFrom

      protected void readPropertiesFrom(DataAdaptor daptSrc) throws DataFormatException
      Restore the state values for this probe state object from the data store represented by the DataAdaptor interface.
      Overrides:
      readPropertiesFrom in class ProbeState<TransferMapState>
      Parameters:
      daptSrc - data source for probe state information
      Throws:
      DataFormatException - error in data format
      See Also:

    • toString

      public String toString()
      Get a string representation of this state.
      Overrides:
      toString in class ProbeState<TransferMapState>
      Returns:
      a string representation of this state
      See Also: