Plots the histograms maintained by ExcisionUnpacker. More...

#include <ExcisionStatsPlotter.h>

Inheritance diagram for dsp::ExcisionStatsPlotter:
dsp::BitStatsPlotter Reference::Able Reference::HeapTracked

Public Member Functions

 ExcisionStatsPlotter ()
 Null constructor.
 
virtual ~ExcisionStatsPlotter ()
 Virtual destructor.
 
void set_data (const HistUnpacker *stats)
 Set the data to be plotted.
 
std::string get_xlabel () const
 The label on the x-axis.
 
std::string get_ylabel () const
 The label on the y-axis.
 
int get_theory_colour ()
 Get the colour used to plot the theoretical distribution.
 
double get_chi_squared (int idig)
 Get a measure of the difference between the histogram and the theory.
 
- Public Member Functions inherited from dsp::BitStatsPlotter
 BitStatsPlotter ()
 Null constructor.
 
virtual ~BitStatsPlotter ()
 Virtual destructor.
 
void set_colours (const std::vector< int > &colours)
 Set the plot colour used for each digitizer.
 
void zap (unsigned ibin)
 Zap the specified histogram by setting its value to zero.
 
void plot (unsigned ichan, unsigned ipol)
 Plot the histogram for the specified frequency channel and polarization.
 
void label ()
 Label the plot.
 
void set_viewport (float xmin, float xmax, float ymin, float ymax)
 Set the device-normalized coordinates of viewport frame.
 
void plot ()
 Plot two polarizations in the current viewport.
 
- Public Member Functions inherited from Reference::Able
 Able (const Able &)
 
Ableoperator= (const Able &)
 
unsigned get_reference_count () const
 
- Public Member Functions inherited from Reference::HeapTracked
 HeapTracked (const HeapTracked &)
 
HeapTrackedoperator= (const HeapTracked &)
 
bool __is_on_heap () const
 

Public Attributes

bool show_cutoff_sigma
 Plot vertical bars to indicate the cut-off thresholds.
 
bool plot_only_range
 Plot vertical bars to indicate the cut-off thresholds.
 
- Public Attributes inherited from dsp::BitStatsPlotter
bool full_xscale
 Plot the entire x-axis of the histogram.
 
float hist_min
 Fraction of histogram maximum below which points are ignored.
 
bool horizontal
 Plot the two polarizations beside eachother.
 
bool colour
 Plot in colour.
 

Protected Member Functions

void calculate_theory ()
 
void set_theory_colour ()
 
void check_colours ()
 Ensure that colours for different digitizers are unique.
 
bool special (unsigned imin, unsigned imax, float &ymax)
 Any special plotting implemented in derived classes. More...
 
- Protected Member Functions inherited from dsp::BitStatsPlotter
void cpgpt (std::vector< float > &vals, int type)
 Plot a vector of points with index on x-axis.
 
- Protected Member Functions inherited from Reference::Able
Handle__reference (bool active) const
 
void __dereference (bool auto_delete=true) const
 

Protected Attributes

std::vector< float > theory
 Theoretical, optimal histogram.
 
float theory_max
 Maxmimum value of theory.
 
bool theory_calculated
 Set true when the theoretical, optimal histogram is calculated.
 
int theory_colour
 Colour used when plotting theoretical.
 
Reference::To< const ExcisionUnpackertwobit
 Data to be plotted.
 
- Protected Attributes inherited from dsp::BitStatsPlotter
std::vector< float > histogram
 Where individual histograms are kept for plotting.
 
std::vector< int > colours
 Colour used when plotting histogram from each digitizer.
 
std::vector< unsigned > to_zap
 Plot the two polarizations beside eachother.
 
float xscale
 Scale factor multplied by each index on x axis.
 

Additional Inherited Members

- Static Public Member Functions inherited from Reference::Able
static size_t get_instance_count ()
 
- Static Public Member Functions inherited from Reference::HeapTracked
static void * operator new (size_t size, void *ptr=0)
 
static void operator delete (void *location, void *ptr)
 
static void operator delete (void *location)
 
static size_t get_heap_queue_size ()
 

Detailed Description

Plots the histograms maintained by ExcisionUnpacker.

Member Function Documentation

◆ special()

bool dsp::ExcisionStatsPlotter::special ( unsigned  imin,
unsigned  imax,
float &  ymax 
)
protectedvirtual

Any special plotting implemented in derived classes.

Implementations should return true if cpgswin is called

Reimplemented from dsp::BitStatsPlotter.


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

Generated using doxygen 1.8.17