Navigation

Main Page
Download
Support
Installation
Tutorial
Examples
Reference Manual
   Version 1.0.6dev
      Class Index
      File List
   Version 1.0.6
   Version 1.0.5new_solver
   Version 1.0.5dev
   Version 1.0.5b
   Version 1.0.4dev
   Version 1.0.4
Publications


Hosted by Get Ion Beam Simulator at SourceForge.net. Fast, secure and Free Open Source software downloads
EmittanceConv Class Reference

Class for emittance conversion from (r,r') to (x,x'). More...

#include <trajectorydiagnostics.hpp>

Inheritance diagram for EmittanceConv:
Emittance

Public Member Functions

 EmittanceConv (uint32_t n, uint32_t m, const std::vector< double > &r, const std::vector< double > &rp, const std::vector< double > &ap, const std::vector< double > &I, uint32_t rotn=100, double xmin=std::numeric_limits< double >::quiet_NaN(), double xpmin=std::numeric_limits< double >::quiet_NaN(), double xmax=std::numeric_limits< double >::quiet_NaN(), double xpmax=std::numeric_limits< double >::quiet_NaN())
 Constructor for (x,x') emittance data and statistics from (r,r') data. More...
 
 ~EmittanceConv ()
 Destructor for emittance converter. More...
 
const Histogram2Dhistogram (void) const
 Get a const reference to histogram built. More...
 
void free_histogram (void)
 Free emittance histogram. More...
 
- Public Member Functions inherited from Emittance
 Emittance ()
 Default constructor for emittance statistics. More...
 
 Emittance (const std::vector< double > &x, const std::vector< double > &xp, const std::vector< double > &I)
 Constructor for emittance statistics from trajectory diagnostic data columns x, xp and current I. More...
 
 Emittance (const std::vector< double > &x, const std::vector< double > &xp)
 Constructor for emittance statistics from trajectory diagnostic data columns x, xp, assuming even weights. More...
 
 Emittance (size_t xsize, size_t xpsize, const double range[4], const std::vector< double > &I)
 Constructor for emittance statistics from trajectory diagnostic data in mesh form. More...
 
double current (void) const
 Return current of beam trajectories used to calculate the emittance. More...
 
double xave (void) const
 Return average position (center location) of emittance distribution. More...
 
double xpave (void) const
 Return average angle (center location) of emittance distribution. More...
 
double alpha (void) const
 Return $\alpha$ of emittance distribution. More...
 
double beta (void) const
 Return $\beta$ of emittance distribution. More...
 
double gamma (void) const
 Return $\gamma$ of emittance distribution. More...
 
double epsilon (void) const
 Return rms emittance. More...
 
double angle (void) const
 Return angle of fitted rms ellipse. More...
 
double rmajor (void) const
 Return major radius of fitted rms ellipse. More...
 
double rminor (void) const
 Return minor radius of fitted rms ellipse. More...
 
void debug_print (std::ostream &os) const
 Print debugging information to os. More...
 

Additional Inherited Members

- Protected Attributes inherited from Emittance
double _Isum
 
double _xave
 
double _xpave
 
double _x2
 
double _xp2
 
double _xxp
 
double _alpha
 
double _beta
 
double _gamma
 
double _epsilon
 
double _angle
 
double _rmajor
 
double _rminor
 

Detailed Description

Class for emittance conversion from (r,r') to (x,x').

Constructor & Destructor Documentation

◆ EmittanceConv()

EmittanceConv::EmittanceConv ( uint32_t  n,
uint32_t  m,
const std::vector< double > &  r,
const std::vector< double > &  rp,
const std::vector< double > &  ap,
const std::vector< double > &  I,
uint32_t  rotn = 100,
double  xmin = std::numeric_limits<double>::quiet_NaN(),
double  xpmin = std::numeric_limits<double>::quiet_NaN(),
double  xmax = std::numeric_limits<double>::quiet_NaN(),
double  xpmax = std::numeric_limits<double>::quiet_NaN() 
)

Constructor for (x,x') emittance data and statistics from (r,r') data.

EmittanceConv class reads particle diagnostic data arrays for r (radius), rp (radial angle), ap (skew angle) and I (current) and builds (x,x') data in a grid array of size n by m. Here the skew angle is $ r\omega/v_z $, where $ v_z $ is the velocity to the direction of beam propagation. The conversion is done by rotating each trajectory diagnostic point around the axis in rotn steps (defaults to 100). The output grid size can be forced by setting (xmin,xpmin,xmax,xpmax) variables, otherwise the grid is autotomatically sized to fit all data.

The emittance statistics is built using original data and not the gridded data for maximized precision.

◆ ~EmittanceConv()

EmittanceConv::~EmittanceConv ( )

Destructor for emittance converter.

Member Function Documentation

◆ free_histogram()

void EmittanceConv::free_histogram ( void  )
inline

Free emittance histogram.

◆ histogram()

const Histogram2D& EmittanceConv::histogram ( void  ) const
inline

Get a const reference to histogram built.


The documentation for this class was generated from the following files:


Reference manual for Ion Beam Simulator 1.0.6dev
Generated by Doxygen 1.9.1 on Thu Sep 11 2025 09:37:24.