Pulsar::LinePhasePlot Class Reference

Draw a set of profiles for subints stacked ontop of eachother. More...

#include <LinePhasePlot.h>

Inheritance diagram for Pulsar::LinePhasePlot:
Pulsar::PhasePlot Pulsar::SimplePlot Pulsar::HasPhaseScale Pulsar::FramedPlot Pulsar::Plot Reference::Able Reference::HeapTracked

Public Member Functions

 LinePhasePlot ()
 Constructor Assume the subint, or range of subints are unset until we know how many there are Assume channel and polarization are zero, leave it up to the user to scrunch the data in frequency and polarization.
 
void prepare (const Archive *data)
 prepare the archive for rendering More...
 
void draw (const Archive *data)
 draw the archive More...
 
TextInterface::Parserget_interface ()
 Get a LinePhasePlot::Interface for this object. More...
 
int get_isub (void) const
 Get the first index of the subint range.
 
void set_isub (int s_isub)
 Set the subint range to (x,x)
 
pair< int, int > get_srange () const
 Get the range of subints to plot.
 
void set_srange (const pair< int, int > &s_srange)
 Set the range of subints to plot.
 
int get_ipol (void) const
 Get the polarization to plot.
 
void set_ipol (int s_ipol)
 Set the polarization to plot.
 
int get_ichan () const
 Get the frequency channel to plot.
 
void set_ichan (const int &s_ichan)
 Set the frequency channel to plot.
 
int get_line_colour () const
 Get the line colour.
 
void set_line_colour (const int &s_line_colour)
 Set the line colour.
 
- Public Member Functions inherited from Pulsar::PhasePlot
 PhasePlot ()
 Default constructor.
 
TextInterface::Parserget_interface ()
 Get the text interface to the configuration attributes.
 
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.
 
PhaseScaleget_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::Parserget_frame_interface ()
 Get the text interface to the frame attributes.
 
PlotAttributesget_attributes ()
 Get the plot attributes.
 
virtual PlotFrameget_frame ()
 Get the frame.
 
virtual const PlotFrameget_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.
 
Constructorget_constructor ()
 Get the constructor.
 
virtual void set_preprocessor (Processor *)
 Set the pre-processor.
 
virtual Processorget_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 &)
 
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
 

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
 
- 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< PlotFrameframe
 The plot frame.
 

Detailed Description

Draw a set of profiles for subints stacked ontop of eachother.

Member Function Documentation

◆ draw()

void LinePhasePlot::draw ( const Archive data)
virtual

draw the archive

Draws a stack of profiles, one for each subint.

Parameters
dataThe archive to draw, hopefully the archive that was prepare(d) :)

Implements Pulsar::SimplePlot.

References Pulsar::IntegrationManager::get_Integration(), Pulsar::Archive::get_nbin(), Pulsar::Integration::get_Profile(), and Pulsar::Profile::get_weighted_amps().

◆ get_interface()

TextInterface::Parser * LinePhasePlot::get_interface ( )
virtual

Get a LinePhasePlot::Interface for this object.

Returns a text ineterface that can be used with this object.

Returns
a LinePhasePlot::Interface class pointing at this

Implements Pulsar::Plot.

◆ prepare()

void LinePhasePlot::prepare ( const Archive data)
virtual

prepare the archive for rendering

Figures out some measurements before plotting We want to setup the y scale with world coordinates to fit all the subints on the plot.

We also want to setup the external world coordinates that the y axis will be labelled with. Being a PhasePlot, x axis takes care of itself.

Parameters
dataThe archive to prepare, hopefully the one that will be draw(n)

Reimplemented from Pulsar::FramedPlot.

References Pulsar::FramedPlot::get_frame(), Pulsar::IntegrationManager::get_Integration(), Pulsar::IntegrationManager::get_nsubint(), Pulsar::Integration::get_Profile(), Pulsar::PlotFrame::get_y_axis(), Pulsar::PlotFrame::get_y_scale(), Pulsar::PlotAxis::set_alternate(), Pulsar::PlotScale::set_buf_norm(), Pulsar::PlotAxis::set_label(), Pulsar::PlotScale::set_minmax(), Pulsar::PlotAxis::set_tick(), and Pulsar::PlotScale::set_world_external().


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

Generated using doxygen 1.8.17