Public Member Functions | List of all members
ParticleDiagPlotter Class Reference

Non-interactive particle diagnostic plotter. More...

#include <particlediagplotter.hpp>

Inheritance diagram for ParticleDiagPlotter:
Plotter ParticleDiagPlot

Public Member Functions

 ParticleDiagPlotter (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)
 Constructor for particle diagnostic plotter.
 ParticleDiagPlotter (const Geometry *geom, const ParticleDataBase *pdb, const Vec3D &c, const Vec3D &o, const Vec3D &p, particle_diag_plot_type_e type, trajectory_diagnostic_e diagx, trajectory_diagnostic_e diagy=DIAG_NONE)
 ~ParticleDiagPlotter ()
 Destructor for particle diagnostic plotter.
- Public Member Functions inherited from Plotter
void set_size (size_t width, size_t height)
 Set size of plot.
void set_font_size (size_t size)
 Set font size for plot.
void set_ranges (double xmin, double ymin, double xmax, double ymax)
 Set ranges of plot in x- and y-directions.
void plot_png (const std::string &filename)
 Make a plot to a PNG-file.
void plot_eps (const std::string &filename)
 Make a plot to a EPS-file.
void plot_pdf (const std::string &filename)
 Make a plot to a PDF-file.
void plot_svg (const std::string &filename)
 Make a plot to a SVG-file.
- Public Member Functions inherited from 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)
 Constructor for particle diagnostic plot.
 ParticleDiagPlot (Frame *frame, const Geometry *geom, const ParticleDataBase *pdb, const Vec3D &c, const Vec3D &o, const Vec3D &p, particle_diag_plot_type_e type, trajectory_diagnostic_e diagx, trajectory_diagnostic_e diagy=DIAG_NONE)
 Constructor for particle diagnostic plot.
 ~ParticleDiagPlot ()
 Destructor.
void set_emittance_ellipse (bool enable)
 Enable/disable emittance fit for emittance plots?
bool get_emittance_ellipse (void)
 Is emittance fit enabled for emittance plots?
void set_view (coordinate_axis_e axis, double level)
 Set diagnostic plane.
void get_view (coordinate_axis_e &axis, double &level)
 Get diagnostic plane definition if it an even coorinate plane.
void set_type (particle_diag_plot_type_e type)
 Set plot type.
particle_diag_plot_type_e get_type (void)
 Get plot type.
void set_plot (particle_diag_plot_type_e type, trajectory_diagnostic_e diagx, trajectory_diagnostic_e diagy)
 Set plot type and diagnostic axes of plot.
void get_plot (particle_diag_plot_type_e &type, trajectory_diagnostic_e &diagx, trajectory_diagnostic_e &diagy)
 Get plot type and diagnostic axes of plot.
void set_histogram_n (size_t n)
 Set number of histogram bins in x-direction to use for colormap plot.
size_t get_histogram_n (void)
 Get number of histogram bins in x-direction to use for colormap plot.
void set_histogram_m (size_t m)
 Set number of histogram bins in y-direction to use for colormap plot.
size_t get_histogram_m (void)
 Get number of histogram bins in y-direction to use for colormap plot.
void set_colormap_interpolation (interpolation_e interpolation)
 Set the type of interpolation used in colormap plot.
interpolation_e get_colormap_interpolation (void)
 Get the type of interpolation used in colormap plot.
const Colormapget_colormap (void) const
 Get a pointer to histogram in the plot.
void set_dot_size (double size)
 Set dot size for scatter plot.
double get_dot_size (void)
 Get dot size for scatter plot.
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.

Additional Inherited Members

- Protected Member Functions inherited from Plotter
 Plotter ()
 Constructor for plotter.
virtual ~Plotter ()
 Destructor for plotter.
- Protected Attributes inherited from Plotter
Frame _frame

Detailed Description

Non-interactive particle diagnostic plotter.

This class ties together Plotter, which provides basic graphics features including frame control, and ParticleDiagPlot, which makes the particle diagnostic plot.

Constructor & Destructor Documentation

ParticleDiagPlotter::ParticleDiagPlotter ( 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 
)

Constructor for particle diagnostic plotter.

Makes two or three dimensional particle diagnostics plots from particle database at plane axis = val. Diagnostic made is specified by selecting the plot type and diagnostic for plot's x-axis diagx and y-axis diagy. For one dimensional histograms the y-axis is intensity and diagy can be left to DIAG_NONE.

ParticleDiagPlotter::ParticleDiagPlotter ( const Geometry geom,
const ParticleDataBase pdb,
const Vec3D c,
const Vec3D o,
const Vec3D p,
particle_diag_plot_type_e  type,
trajectory_diagnostic_e  diagx,
trajectory_diagnostic_e  diagy = DIAG_NONE 
)
ParticleDiagPlotter::~ParticleDiagPlotter ( )

Destructor for particle diagnostic plotter.


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