Pulsar::StokesFluctPlot Class Reference

Plots fluctuation power spectra. More...

#include <StokesFluctPlot.h>

Inheritance diagram for Pulsar::StokesFluctPlot:

Public Member Functions
	StokesFluctPlot ()
	Default constructor.
TextInterface::Parser *	get_interface ()
	Get the text interface to the configuration attributes.
void	prepare (const Archive *data)
	Perform any preprocessing steps.
void	draw (const Archive *)
	Draw the profiles in the currently open window.
std::string	get_ylabel (const Archive *)
	Get the default label for the y axis.
void	get_profiles (const Archive *)
	Return the fluctuation power spectra to be plotted.
void	set_plot_values (const std::string &plot)
	Set the values to be plotted (one or more of I,Q,U,V,L,p)
std::string	get_plot_values () const
void	set_signal_to_noise (const bool plot)
	Signal-to-noise ratio on the y-axis.
bool	get_signal_to_noise () const
void	set_harmonic_outliers (const bool plot)
	Plot the harmonic outliers.
bool	get_harmonic_outliers () const
void	set_plot_colours (const std::string &plot)
	Set the colour for each value plotted.
std::string	get_plot_colours () const
void	set_plot_lines (const std::string &plot)
	Set the line style for each value plotted.
std::string	get_plot_lines () const
void	set_plot_last_harmonic (bool p)
	Plot the last significant harmonic.
bool	get_plot_last_harmonic () const
void	set_plot_fluctuation_phase (bool p)
	Plot the fluctuation phase.
bool	get_plot_fluctuation_phase () const
Public Member Functions inherited from Pulsar::FluctPlot
	FluctPlot ()
	Default constructor.
std::string	get_xlabel (const Archive *)
	Get the default label for the x axis.
void	set_subint (Index _isubint)
	Set the sub-integration to plot (where applicable)
Index	get_subint () const
void	set_chan (Index _ichan)
	Set the frequency channel to plot (where applicable)
Index	get_chan () const
void	set_pol (Index _ipol)
	Set the polarization to plot.
Index	get_pol () const
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.
Public Member Functions inherited from Pulsar::Plot
	Plot ()
	Default constructor.
virtual void	preprocess (Archive *)
	Process the Archive as needed before calling plot.
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
bool	plot_log
bool	signal_to_noise
bool	harmonic_outliers
std::string	plot_values
std::string	plot_colours
std::string	plot_lines
bool	plot_last_harmonic
bool	plot_fluctuation_phase
unsigned	last_harmonic
Protected Attributes inherited from Pulsar::FluctPlot
ProfileVectorPlotter	plotter
Index	isubint
Index	ichan
Index	ipol
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 fluctuation power spectra.

Member Function Documentation

draw()

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

virtual

Draw the profiles in the currently open window.

The ProfileVectorPlotter class draws the profile

Reimplemented from Pulsar::FluctPlot.

References Pulsar::FluctPlot::draw(), and Pulsar::FramedPlot::get_frame().

get_interface()

TextInterface::Parser * Pulsar::StokesFluctPlot::get_interface ( void )

virtual

Get the text interface to the configuration attributes.

Reimplemented from Pulsar::FluctPlot.

get_profiles()

void Pulsar::StokesFluctPlot::get_profiles ( const Archive * data )

virtual

Return the fluctuation power spectra to be plotted.

Implements Pulsar::FluctPlot.

References Pulsar::BaselineEstimator::baseline(), Pulsar::detect(), Pulsar::ProfileStatistic::factory(), Pulsar::LastSignificant::find(), Pulsar::fourier_transform(), Pulsar::FramedPlot::frame, Pulsar::LastSignificant::get(), Pulsar::ProfileStatistic::get(), Pulsar::PhaseWeight::get_mean(), Pulsar::get_Profile(), Pulsar::get_Stokes(), Estimate< typename T, typename U >::get_value(), Pulsar::Profile::resize(), and Pulsar::Index::set_integrate().

get_ylabel()

std::string Pulsar::StokesFluctPlot::get_ylabel ( const Archive * data )

virtual

Get the default label for the y axis.

Return the label for the y-axis.

Reimplemented from Pulsar::FluctPlot.

prepare()

void Pulsar::StokesFluctPlot::prepare ( const Archive * data )

virtual

Perform any preprocessing steps.

Reimplemented from Pulsar::FluctPlot.

References Pulsar::FramedPlot::get_frame(), and Pulsar::FluctPlot::prepare().

---

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

• StokesFluctPlot.h
• StokesFluctPlot.C