Pulsar::StokesPlot Class Reference

Plots a polarization pulse profile. More...

#include <StokesPlot.h>

Inheritance diagram for Pulsar::StokesPlot:

Public Member Functions
	StokesPlot ()
	Default constructor.
TextInterface::Parser *	get_interface ()
	Get the text interface to the configuration attributes.
void	get_profiles (const Archive *data)
	Load the profiles.
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_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_widths (const std::string &plot)
	Set the line width for each value plotted.
std::string	get_plot_widths () const
void	set_pav_bias (bool flag)
	Correct the bias to L and p as is done in pav.
bool	get_pav_bias () const
Public Member Functions inherited from Pulsar::FluxPlot
	FluxPlot ()
	Default constructor.
	~FluxPlot ()
	Destructor.
void	prepare (const Archive *)
	Perform any preprocessing steps.
std::string	get_ylabel (const Archive *)
	Get the default label for the y axis.
virtual float	get_phase_error (const Archive *data)
	Compute the error in phase.
virtual float	get_flux_error (const Profile *data)
	Compute the error in flux.
virtual float	get_flux_maximum (const Profile *data)
	Compute the maximum flux.
virtual void	plot_error_box (const Archive *data)
	Draw the error box.
virtual void	auto_scale_phase (const Profile *data, float buffer)
	Automatically scale in on the on-pulse region.
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
void	set_logarithmic (int val)
	Plot on a logarithmic scale, normalized by noise.
int	get_logarithmic () const
void	set_peak_zoom (float zoom)
	Automatically zoom in on the pulse peak.
float	get_peak_zoom () const
void	set_baseline_zoom (float zoom)
	Automatically zoom in on the baseline.
float	get_baseline_zoom () const
void	set_info_label (bool flag=true)
	Use an informative label above the plot.
bool	get_info_label () const
void	set_plot_error_box (int code)
	Plot an error box on the baseline.
int	get_plot_error_box () const
void	set_plot_histogram (bool f=true)
	Plot an error box on the baseline.
bool	get_plot_histogram () const
void	set_original_nchan (unsigned nchan)
	Set the original number of frequency channels.
unsigned	get_original_nchan () const
void	draw (const Archive *)
	Draw the profiles in the currently open window.
void	plot_profile (const Profile *)
	Draw a profile in the currently open window.
const ProfileVectorPlotter *	get_plotter () const
	Provide limited access to the plotter.
void	set_selection (const PhaseWeight *)
	Set the selected profiles.
void	set_crop (float new_crop)
	Set the crop fraction.
float	get_crop () const
	Get the crop level.
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.
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
std::string	plot_values
std::string	plot_colours
std::string	plot_lines
std::string	plot_widths
Protected Attributes inherited from Pulsar::FluxPlot
ProfileVectorPlotter	plotter
Index	isubint
Index	ichan
Index	ipol
int	logarithmic
int	plot_ebox
float	peak_zoom
bool	peak_centre_origin
float	baseline_zoom
unsigned	original_nchan
float	crop
Reference::To< InfoLabel >	info_label
Reference::To< const PhaseWeight >	selection
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 Pulsar::FluxPlot
void	plot_selection ()
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Detailed Description

Plots a polarization pulse profile.

Member Function Documentation

get_interface()

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

virtual

Get the text interface to the configuration attributes.

Reimplemented from Pulsar::FluxPlot.

get_profiles()

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

virtual

Load the profiles.

Implements Pulsar::FluxPlot.

References Pulsar::get_Stokes(), and Pulsar::new_Profile().

---

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

• StokesPlot.h
• StokesPlot.C