Pulsar::PhaseVsPlot Class Reference

Plots images of something as a function of pulse phase vs something. More...

#include <PhaseVsPlot.h>

Inheritance diagram for Pulsar::PhaseVsPlot:

Public Member Functions
	PhaseVsPlot ()
	Default constructor.
TextInterface::Parser *	get_interface ()
	Get the text interface to the configuration attributes.
virtual const Profile *	get_Profile (const Archive *data, unsigned row)=0
	Derived classes must provide the Profile for the specified row.
void	preprocess (Archive *)
	Remove the baseline from each sub-integration and channel independently.
void	draw (const Archive *)
	Draw in the current viewport.
PlotScale *	get_z_scale ()
	Provide access to the z-scale.
pgplot::ColourMap *	get_colour_map ()
	Provide access to the colour map.
pgplot::ColourBar *	get_colour_bar ()
	Provide access to the colour bar.
void	set_style (const std::string &)
	Set the style.
std::string	get_style () const
	Get the style.
void	set_line_colour (int new_colour)
	Set the line colour.
int	get_line_colour (void)
	Get the line colour.
void	set_crop (float s_crop_value)
	Set the crop value.
float	get_crop () const
	Get the crop value.
void	set_rows (const std::pair< unsigned, unsigned > &rows)
	Set the first and last row to plot.
std::pair< unsigned, unsigned >	get_rows () const
	Get the first and last row to plot.
Public Member Functions inherited from Pulsar::PhasePlot
	PhasePlot ()
	Default constructor.
std::string	get_xlabel (const Archive *)
	Get the default label for the x axis.
std::string	get_ylabel (const Archive *)
	Get the default label for the y axis.
void	set_yrange (float min, float max)
	Set the y-range.
PhaseScale *	get_scale ()
	Get the scale.
Public Member Functions inherited from Pulsar::SimplePlot
virtual void	plot (const Archive *)
	Plot in the current viewport.
void	add_annotation (PlotAnnotation *a)
	Add an annotation.
Public Member Functions inherited from Pulsar::FramedPlot
	FramedPlot ()
	Default constructor.
virtual TextInterface::Parser *	get_frame_interface ()
	Get the text interface to the frame attributes.
PlotAttributes *	get_attributes ()
	Get the plot attributes.
virtual PlotFrame *	get_frame ()
	Get the frame.
virtual const PlotFrame *	get_frame () const
	Get the frame.
virtual void	set_frame (PlotFrame *)
	Set the frame.
virtual void	prepare (const Archive *)
	Derived classes must prepare to draw.
Public Member Functions inherited from Pulsar::Plot
	Plot ()
	Default constructor.
virtual void	finalize ()
	Some plots may postpone plotting.
virtual void	configure (const std::string &)
	Process a configuration command.
void	set_constructor (Constructor *c)
	Set the constructor.
Constructor *	get_constructor ()
	Get the constructor.
virtual void	set_preprocessor (Processor *)
	Set the pre-processor.
virtual Processor *	get_preprocessor ()
	Get the pre-processor.
virtual bool	has_preprocessor () const
	Return true if pre-processor has been set.
Public Member Functions inherited from Reference::Able
	Able (const Able &)
Able &	operator= (const Able &)
unsigned	get_reference_count () const
Public Member Functions inherited from Reference::HeapTracked
	HeapTracked (const HeapTracked &)
HeapTracked &	operator= (const HeapTracked &)
bool	__is_on_heap () const

Protected Attributes
PlotScale	z_scale
pgplot::ColourMap	colour_map
pgplot::ColourBar	colour_bar
std::string	style
	The style in which the data will be plotted.
int	line_colour
	The colour to draw the lines.
float	crop_value
	The percentage of max to crop at.
Protected Attributes inherited from Pulsar::SimplePlot
std::vector< Reference::To< PlotAnnotation > >	annotations
	Annotations to add to the plot.
Protected Attributes inherited from Pulsar::FramedPlot
Reference::To< PlotFrame >	frame
	The plot frame.

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 ()
Static Public Attributes inherited from Pulsar::Plot
static bool	verbose = false
	Verbosity flag.
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Detailed Description

Plots images of something as a function of pulse phase vs something.

Member Function Documentation

draw()

void Pulsar::PhaseVsPlot::draw ( const Archive * data )

virtual

Draw in the current viewport.

Derived classes must draw in the current viewport.

Implements Pulsar::SimplePlot.

References crop_value, Pulsar::FramedPlot::get_frame(), Pulsar::Archive::get_nbin(), Pulsar::get_Profile(), Pulsar::PhasePlot::get_scale(), get_z_scale(), line_colour, and style.

get_interface()

TextInterface::Parser * Pulsar::PhaseVsPlot::get_interface ( )

virtual

Get the text interface to the configuration attributes.

Reimplemented from Pulsar::PhasePlot.

Reimplemented in PhaseVsTime, and Pulsar::PhaseVsTime.

get_Profile()

virtual const Profile * Pulsar::PhaseVsPlot::get_Profile ( const Archive * data, unsigned row )

pure virtual

Derived classes must provide the Profile for the specified row.

Implemented in PhaseVsFrequency, PhaseVsTime, Pulsar::PhaseVsFrequency, Pulsar::PhaseVsHist, Pulsar::PhaseVsMore, and Pulsar::PhaseVsTime.

preprocess()

void Pulsar::PhaseVsPlot::preprocess ( Archive * archive )

virtual

Remove the baseline from each sub-integration and channel independently.

Reimplemented from Pulsar::Plot.

---

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

• PhaseVsPlot.h
• PhaseVsPlot.C