SynAPSE  0.6.0
Synergistic Analysis of Phase Space Evolution
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
Data Structures | Typedefs | Enumerations | Functions | Variables
Beam Namespace Reference

Environment of beam related objects and methods. More...

Data Structures

class  Aperture
 Holds a set of beam line apertures. More...
 
class  Bunch
 Holds a bunch of particles at a specific position along the beam line. More...
 
class  BunchData
 Holds a the underlying phase space vectors that form a Bunch. More...
 
struct  SumStatStruct
 Structure that stores the characteristics of each summary statistic. More...
 
struct  DrawOpt
 Structure that stores the drawing options of each data type. More...
 
struct  VarSet
 Structure that stores the drawing options for each variable. More...
 
class  Drawer
 Stores the default drawing options and methods to produce ROOT plots. More...
 
class  Extractor
 Extracts the data from an array of imported ROOT file. More...
 
class  Stream
 Holds a set of particle bunches. More...
 
class  Variable
 Contains the value, measurement uncertainty and statistical uncertainty of a variable. More...
 

Typedefs

typedef std::map< std::string,
std::vector< double > > 
BunchMap
 Strutcure of a bunch map (maps variable tags to vectors) More...
 

Enumerations

enum  PhaseSpaceVariable {
  x, px, y, py,
  pz
}
 Enumerates the phase space variables. More...
 
enum  SumStat {
  alpha, beta, gamma, mecl,
  eps, neps, amp, subeps,
  vol, mom, trans
}
 Enumerates the types of summary statistics of a beam bunch. More...
 

Functions

std::ostream & operator<< (std::ostream &os, const Variable &var)
 

Variables

std::map< SumStat, SumStatStruct > SumStatDict
 Dictionary that maps each summary statistic to its characteristics. More...
 

Detailed Description

Environment of beam related objects and methods.

Typedef Documentation

typedef std::map<std::string, std::vector<double> > Beam::BunchMap

Strutcure of a bunch map (maps variable tags to vectors)

Enumeration Type Documentation

Enumerates the phase space variables.

The axes are set up so that the $\vec{z}$ axis points downstream, the $\vec{y}$ axis point upwards from the ground and the $\vec{x}$ axis follows the right hand convetion, i.e. $ \vec{x} = \vec{y}\times\vec{z}$. Coordinates :

  • x: position along the transverse $\vec{x}$ axis expressed in [mm]
  • x: position along the transverse $\vec{y}$ axis expressed in [mm]
  • px: momentum along the transverse $\vec{x}$ axis expressed in [MeV/c]
  • py: momentum along the transverse $\vec{y}$ axis expressed in [MeV/c]
  • pz: momentum along the longitudinal $\vec{z}$ axis expressed in [MeV/c]

Enumerates the types of summary statistics of a beam bunch.

An enumeration allows to distinguish between different summary statistics

  • alpha: Twiss parameter alpha
  • beta: Twiss parameter beta
  • gamma: Twiss parameter gamma
  • mecl: Mechanical angular momentum
  • eps: Geometric emittance
  • neps: Normalised emittance
  • trans: Tansmission
  • subeps: α-subemittance
  • amp: α-amplitude
  • vol: α-fractional emittance

mode: amplitude mode

  • mom: mean momentum
  • trans: transmission

Variable Documentation

std::map< SumStat, SumStatStruct > Beam::SumStatDict

Dictionary that maps each summary statistic to its characteristics.