Package xal.model.probe.traj

Class EnsembleProbeState

java.lang.Object
xal.model.probe.traj.ProbeState<S>
xal.model.probe.traj.BunchProbeState<EnsembleProbeState>
xal.model.probe.traj.EnsembleProbeState
All Implemented Interfaces:
IProbeState, IArchive
public class EnsembleProbeState extends BunchProbeState<EnsembleProbeState>
Encapsulates the state of an EnsembleProbe at a particular point in time.
Version:
$id:
Author:
Craig McChesney

  • Constructor Details

    • EnsembleProbeState

      public EnsembleProbeState()
      Default constructor. Create a new, empty EnsembleProbeState object.

    • EnsembleProbeState

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

    • EnsembleProbeState

      public EnsembleProbeState(EnsembleProbe probe)
      Initializing Constructor. Create a new EnsembleProbeState object and initialize it to the state of the probe argument.
      Parameters:
      probe - EnsembleProbe containing initializing state information

  • Method Details

    • setFieldCalculation

      public void setFieldCalculation(int fc)
      Set the field calculation method
      Parameters:
      fc - field calculation method enumeration

    • setEnsemble

      public void setEnsemble(Ensemble ens)
      Set the state to the value of the argument NOTE: the copy operation can be expansive for large Ensembles
      Parameters:
      ens - Ensemble object to be copied

    • getFieldCalculation

      public int getFieldCalculation()
      Return the field calculation method

    • getEnsemble

      public Ensemble getEnsemble()
      Return the Ensemble state object

    • electricField

      public R3 electricField(R3 ptFld)
      Get the electric field at a point in R3 from the ensemble.
      Parameters:
      ptFld - field point to evaluation ensemble field
      Returns:
      electric field at field point

    • phaseMean

      public PhaseVector phaseMean()
      Return the coordinates of the ensemble centroid.
      Returns:
      (homogeneous) phase space coordinates of ensemble centroid

    • phaseCovariance

      public CovarianceMatrix phaseCovariance()
      Return the correlation matrix of the distribution
      Returns:
      symmetric 7x7 covariance matrix in homogeneous coordinates
      See Also:

    • copy

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

    • addPropertiesTo

      protected void addPropertiesTo(DataAdaptor container)
      Save the state values particular to EnsembleProbeState objects to the data sink.
      Overrides:
      addPropertiesTo in class BunchProbeState<EnsembleProbeState>
      Parameters:
      container - data sink represented by DataAdaptor interface

    • readPropertiesFrom

      protected void readPropertiesFrom(DataAdaptor container) throws DataFormatException
      Recover the state values particular to EnsembleProbeState objects from the data source.
      Overrides:
      readPropertiesFrom in class BunchProbeState<EnsembleProbeState>
      Parameters:
      container - data source represented by a DataAdaptor interface
      Throws:
      DataFormatException - state information in data source is malformatted

    • toString

      public String toString()
      Write out state information to a string.
      Overrides:
      toString in class BunchProbeState<EnsembleProbeState>
      Returns:
      text version of internal state data