IBSimu 1.0.4
Public Member Functions
ParticleDiagPlot Class Reference

Particle diagnostic plot. More...

#include <particlediagplot.hpp>

Inheritance diagram for ParticleDiagPlot:
ParticleDiagPlotter

List of all members.

Public Member Functions

 ParticleDiagPlot (Frame *frame, const Geometry *geom, const ParticleDataBase *pdb, coordinate_axis_e axis, double level, particle_diag_plot_type_e type, trajectory_diagnostic_e diagx, trajectory_diagnostic_e diagy=DIAG_NONE)
 ~ParticleDiagPlot ()
void set_emittance_ellipse (bool enable)
bool get_emittance_ellipse (void)
void set_view (coordinate_axis_e axis, double level)
void get_view (coordinate_axis_e &axis, double &level)
void set_type (particle_diag_plot_type_e type)
particle_diag_plot_type_e get_type (void)
void set_plot (particle_diag_plot_type_e type, trajectory_diagnostic_e diagx, trajectory_diagnostic_e diagy)
void get_plot (particle_diag_plot_type_e &type, trajectory_diagnostic_e &diagx, trajectory_diagnostic_e &diagy)
void set_histogram_n (size_t n)
size_t get_histogram_n (void)
void set_histogram_m (size_t m)
size_t get_histogram_m (void)
void set_colormap_interpolation (interpolation_e interpolation)
interpolation_e get_colormap_interpolation (void)
const Colormapget_colormap (void) const
void set_dot_size (double size)
double get_dot_size (void)
const Histogramget_histogram (void)
 Return a pointer to histogram.
const Emittancecalculate_emittance (void)
 Calculate Emittance fit.
void export_data (const std::string &filename)
 Export plotted data as ASCII.
void build_plot (void)
 Rebuild plot.

Detailed Description

Particle diagnostic plot.

Two dimensional histograms have particle trajectory currents always taken in account. Similarly profile plot (PARTICLE_DIAG_PLOT_HISTO1D) always takes in account the trajectory current. In cylindrical symmetry cases the output is scaled to have constant area per histogram bin. One dimensional Emittance plots in (r,r') space are scaled to have constant area per histogram bin.


Constructor & Destructor Documentation

ParticleDiagPlot::ParticleDiagPlot ( Frame frame,
const Geometry geom,
const ParticleDataBase pdb,
coordinate_axis_e  axis,
double  level,
particle_diag_plot_type_e  type,
trajectory_diagnostic_e  diagx,
trajectory_diagnostic_e  diagy = DIAG_NONE 
)
ParticleDiagPlot::~ParticleDiagPlot ( )

Member Function Documentation

void ParticleDiagPlot::build_plot ( void  )

Rebuild plot.

const Emittance& ParticleDiagPlot::calculate_emittance ( void  )

Calculate Emittance fit.

void ParticleDiagPlot::export_data ( const std::string &  filename)

Export plotted data as ASCII.

const Colormap* ParticleDiagPlot::get_colormap ( void  ) const [inline]
interpolation_e ParticleDiagPlot::get_colormap_interpolation ( void  ) [inline]
double ParticleDiagPlot::get_dot_size ( void  ) [inline]
bool ParticleDiagPlot::get_emittance_ellipse ( void  ) [inline]
const Histogram* ParticleDiagPlot::get_histogram ( void  ) [inline]

Return a pointer to histogram.

Histogram might not exist in the plot object.

size_t ParticleDiagPlot::get_histogram_m ( void  ) [inline]
size_t ParticleDiagPlot::get_histogram_n ( void  ) [inline]
void ParticleDiagPlot::get_plot ( particle_diag_plot_type_e type,
trajectory_diagnostic_e diagx,
trajectory_diagnostic_e diagy 
) [inline]
particle_diag_plot_type_e ParticleDiagPlot::get_type ( void  ) [inline]
void ParticleDiagPlot::get_view ( coordinate_axis_e axis,
double &  level 
) [inline]
void ParticleDiagPlot::set_colormap_interpolation ( interpolation_e  interpolation) [inline]
void ParticleDiagPlot::set_dot_size ( double  size) [inline]
void ParticleDiagPlot::set_emittance_ellipse ( bool  enable) [inline]
void ParticleDiagPlot::set_histogram_m ( size_t  m) [inline]
void ParticleDiagPlot::set_histogram_n ( size_t  n) [inline]
void ParticleDiagPlot::set_plot ( particle_diag_plot_type_e  type,
trajectory_diagnostic_e  diagx,
trajectory_diagnostic_e  diagy 
) [inline]
void ParticleDiagPlot::set_type ( particle_diag_plot_type_e  type) [inline]
void ParticleDiagPlot::set_view ( coordinate_axis_e  axis,
double  level 
) [inline]

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