xal.extension.twissobserver

Class BunchLengthSimulator

java.lang.Object

xal.extension.twissobserver.BunchLengthSimulator

public class BunchLengthSimulator
extends java.lang.Object

This class is an auxiliary tool for providing the longitudinal component of a Measurement object. Typically, a measurement object is populated with wire scanner data, which contains only transverse information. In order to do computation with space charge it is necessary to have longitudinal information since dynamics in all three phase planes are coupled by the electro- magnetic fields. This tools provides a simulated longitudinal bunch size to fill in the missing information.

Since:

Sep 6, 2012

Constructor Summary

Constructors

Constructor and Description
BunchLengthSimulator(AcceleratorSeq smfSeq) Creates a new BunchLengthSimulator object using the given sequence, and synchronizes to the design parameters.
BunchLengthSimulator(AcceleratorSeq smfSeq, long lngPvLogId) Creates a new BunchLengthSimulator object using the given sequence, initializes the model to the historical machine state identified by the given PV Logger ID.
BunchLengthSimulator(AcceleratorSeq smfSeq, TransferMatrixGenerator.SYNC enmSyn) Creates a new BunchLengthSimulator object using the given accelerator (XML definition file) accelerator, the given sequence, and the given synchronization mode.

Method Summary

Modifier and Type	Method and Description
void	generateBunchLengths(java.util.ArrayList<Measurement> arrMsmts, double dblBnchFreq, double dblBmCurr) Generates all the bunch lengths at the given device locations for the given measurement data.
void	generateBunchLengths(java.util.ArrayList<Measurement> arrMsmts, double dblScale, double dblBnchFreq, double dblBmCurr) Generates all the bunch lengths at the given device locations for the given measurement data.
void	generateBunchLengths(java.util.ArrayList<Measurement> arrMsmts, double dblScale, double dblBnchFreq, double dblBmCurr, CovarianceMatrix matInitState) Generates all the bunch lengths at the given device locations for the given measurement data.
void	setSynchronizationMode(TransferMatrixGenerator.SYNC enmSync) Sets the source of hardware parameters for the simulations.
void	setSyncToMachineHistory(long lngPvLogId) Synchronizes to the machine parameters at the time of the given PV logger snapshot ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

BunchLengthSimulator

public BunchLengthSimulator(AcceleratorSeq smfSeq)
                     throws ModelException

Creates a new BunchLengthSimulator object using the given sequence, and synchronizes to the design parameters.

Parameters:

smfSeq - the desired sequence for bunch length computation

Throws:

ModelException - and error occurred when instantiating the machine model

BunchLengthSimulator

public BunchLengthSimulator(AcceleratorSeq smfSeq,
                            long lngPvLogId)
                     throws ModelException

Creates a new BunchLengthSimulator object using the given sequence, initializes the model to the historical machine state identified by the given PV Logger ID.

Parameters:

smfSeq - the desired sequence for bunch length computation

lngPvLogId - PV Logger ID of the historical machine snapshot where model parameters are taken

Throws:

ModelException - and error occurred when instantiating the machine model

BunchLengthSimulator

public BunchLengthSimulator(AcceleratorSeq smfSeq,
                            TransferMatrixGenerator.SYNC enmSyn)
                     throws ModelException

Creates a new BunchLengthSimulator object using the given accelerator (XML definition file) accelerator, the given sequence, and the given synchronization mode.

Parameters:

smfSeq - the desired sequence for bunch length computation

enmSyn - source of machine parameters

Throws:

ModelException - an error occurred when instantiating the machine model

Method Detail

setSynchronizationMode

public void setSynchronizationMode(TransferMatrixGenerator.SYNC enmSync)

Sets the source of hardware parameters for the simulations. The given synchronization mode determines where this parameters are taken from (e.g., the live machine, the design parameters, etc.). It is also possible to synchronize the hardware parameters to a historical machine state with a know PV Logger ID (see setSyncToMachineHistory(long)).

Parameters:

enmSync - synchronization mode determining parameter source

Since:

Jul 19, 2012

setSyncToMachineHistory

public void setSyncToMachineHistory(long lngPvLogId)

Synchronizes to the machine parameters at the time of the given PV logger snapshot ID. The bunch lengths provided will be from this machine state.

Parameters:

lngPvLogId - PV Logger ID for the historical machine state

Since:

Jul 19, 2012

generateBunchLengths

public void generateBunchLengths(java.util.ArrayList<Measurement> arrMsmts,
                                 double dblBnchFreq,
                                 double dblBmCurr)
                          throws ModelException

Generates all the bunch lengths at the given device locations for the given measurement data. The default initial beam state is used to start the beam simulation at the entrance of the accelerator sequence.

Parameters:

arrMsmts - the measurement data to be packed with longitudinal dummy data

dblBmChrg - beam bunch charge in Coulombs

Throws:

ModelException - general error during model synchronization or simulation

Since:

Sep 6, 2012

generateBunchLengths

public void generateBunchLengths(java.util.ArrayList<Measurement> arrMsmts,
                                 double dblScale,
                                 double dblBnchFreq,
                                 double dblBmCurr)
                          throws ModelException

Generates all the bunch lengths at the given device locations for the given measurement data. The default initial beam state is used to start the beam simulation at the entrance of the accelerator sequence. The beam sizes are multiplied by the scaling factor provided; this is used to convert units since the online model units are all MKS. For example, use 1000.0 to convert from meters (XAL) to millimeters.

Parameters:

arrMsmts - the measurement data to be packed with longitudinal dummy data

dblScale - multiplicative factor used to scale bunch lengths.

dblBmChrg - beam bunch charge in Coulombs

Throws:

ModelException - general error during model synchronization or simulation

Since:

Sep 6, 2012

generateBunchLengths

public void generateBunchLengths(java.util.ArrayList<Measurement> arrMsmts,
                                 double dblScale,
                                 double dblBnchFreq,
                                 double dblBmCurr,
                                 CovarianceMatrix matInitState)
                          throws ModelException

Generates all the bunch lengths at the given device locations for the given measurement data. The simulation is performed with the given bunch charge and the given initial beam state at the start of the accelerator sequence. The beam sizes are multiplied by the scaling factor provided; this is used to convert units since the online model units are all MKS. For example, use 1000.0 to convert from meters (XAL) to millimeters.

Parameters:

arrMsmts - the measurement data to be packed with longitudinal dummy data

dblScale - multiplicative factor used to scale bunch lengths.

dblBmChrg - beam bunch charge in Coulombs

matInitState - initial state of the beam, initial covariance matrix or the default value is used if null

Throws:

ModelException - general error during model synchronization or simulation

Since:

Jul 26, 2012