ParticleDiagPlotter Class Reference

Non-interactive particle diagnostic plotter. More...

#include <particlediagplotter.hpp>

Inheritance diagram for ParticleDiagPlotter:

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. More...
	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)
	Constructor for particle diagnostic plotter. More...
	~ParticleDiagPlotter ()
	Destructor for particle diagnostic plotter. More...
Public Member Functions inherited from Plotter
void	set_size (size_t width, size_t height)
	Set size of plot. More...
void	set_font_size (size_t size)
	Set font size for plot. More...
void	set_ranges (double xmin, double ymin, double xmax, double ymax)
	Set ranges of plot in x- and y-directions. More...
void	plot_png (const std::string &filename)
	Make a plot to a PNG-file. More...
void	plot_eps (const std::string &filename)
	Make a plot to a EPS-file. More...
void	plot_pdf (const std::string &filename)
	Make a plot to a PDF-file. More...
void	plot_svg (const std::string &filename)
	Make a plot to a SVG-file. More...
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. More...
	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. More...
	~ParticleDiagPlot ()
	Destructor. More...
void	set_emittance_ellipse (bool enable)
	Enable/disable emittance fit for emittance plots? More...
bool	get_emittance_ellipse (void)
	Is emittance fit enabled for emittance plots? More...
void	set_view (coordinate_axis_e axis, double level)
	Set diagnostic plane. More...
void	get_view (coordinate_axis_e &axis, double &level)
	Get diagnostic plane definition if it an even coorinate plane. More...
void	set_type (particle_diag_plot_type_e type)
	Set plot type. More...
particle_diag_plot_type_e	get_type (void)
	Get plot type. More...
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. More...
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. More...
void	set_histogram_n (size_t n)
	Set number of histogram bins in x-direction to use for colormap plot. More...
size_t	get_histogram_n (void)
	Get number of histogram bins in x-direction to use for colormap plot. More...
void	set_histogram_m (size_t m)
	Set number of histogram bins in y-direction to use for colormap plot. More...
size_t	get_histogram_m (void)
	Get number of histogram bins in y-direction to use for colormap plot. More...
void	set_histogram_accumulation (histogram_accumulation_e accumulation)
	Set histogram accumulation type. More...
histogram_accumulation_e	get_histogram_accumulation (void)
	Get histogram accumulation type. More...
void	set_histogram_style (bool style)
	Set 1d histogram style. More...
bool	get_histogram_style (void)
	Get 1d histogram style. More...
void	set_colormap_interpolation (interpolation_e interpolation)
	Set the type of interpolation used in colormap plot. More...
interpolation_e	get_colormap_interpolation (void)
	Get the type of interpolation used in colormap plot. More...
const MeshColormap *	get_colormap (void) const
	Get a pointer to histogram in the plot. More...
void	set_dot_size (double size)
	Set dot size for scatter plot. More...
double	get_dot_size (void)
	Get dot size for scatter plot. More...
const Histogram *	get_histogram (void)
	Return a pointer to histogram. More...
double	get_isum (void)
	Return total current in diagnostic. More...
const Emittance &	calculate_emittance (void)
	Calculate Emittance fit. More...
void	export_data (const std::string &filename)
	Export plotted data as ASCII. More...
void	build_plot (void)
	Rebuild plot. More...

Additional Inherited Members
Protected Member Functions inherited from Plotter
	Plotter ()
	Constructor for plotter. More...
virtual	~Plotter ()
	Destructor for plotter. More...
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
	)

Constructor for particle diagnostic plotter.

Make two or three dimensional particle diagnostic plots from particle database at a plane defined by center point c and two vectors defining the coordinate axes o and p. The diagnostics is made using particle data from pdb in geometry geom. The particle diagnostic is defined by diagnostic type and diagnostic axes diagx and diagy.

ParticleDiagPlotter::~ParticleDiagPlotter

(

)

Destructor for particle diagnostic plotter.

---

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

• particlediagplotter.hpp
• particlediagplotter.cpp