Pulsar::CorrelationInfo Class Reference

Communicates information about correlation between model parameters. More...

#include <CorrelationInfo.h>

Inheritance diagram for Pulsar::CorrelationInfo:
Pulsar::Calibrator::Info Reference::Able Reference::HeapTracked

Public Member Functions

 CorrelationInfo (unsigned index, const PolnCalibrator *calibrator)
 Constructor.
std::string get_title () const override
 Return the title.
unsigned get_nchan () const override
 Return the number of frequency channels.
unsigned get_nclass () const override
 Return the number of parameter classes.
std::string get_label (unsigned iclass) const override
 Return the PGPLOT-encoded label of the specified class.
unsigned get_nparam (unsigned iclass) const override
 Return the number of parameters in the specified class.
std::string get_param_name (unsigned iparam) const override
 Return the PGPLOT-encoded name of the specified parameter.
Estimate< float > get_param (unsigned ichan, unsigned iclass, unsigned iparam) const override
 Return the estimate of the specified parameter.
Public Member Functions inherited from Pulsar::Calibrator::Info
virtual ~Info ()
 Destructor.
virtual int get_colour_index (unsigned iclass, unsigned iparam) const
 Return the colour index.
virtual int get_graph_marker (unsigned iclass, unsigned iparam) const
 Return the graph marker.
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

Protected Attributes

Reference::To< const PolnCalibratorpoln_calibrator
 The PolnCalibrator with correlation information to be plotted.
unsigned index = 0
 Index of the parameter for which correlation information will be plotted.
std::vector< std::string > names
 Parameter names.

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 ()
Protected Member Functions inherited from Reference::Able
Handle__reference (bool active) const
void __dereference (bool auto_delete=true) const

Detailed Description

Communicates information about correlation between model parameters.

Member Function Documentation

◆ get_label()

string CorrelationInfo::get_label ( unsigned iclass) const
overridevirtual

Return the PGPLOT-encoded label of the specified class.

Return the name of the specified class.

Implements Pulsar::Calibrator::Info.

References index, and names.

◆ get_nchan()

unsigned CorrelationInfo::get_nchan ( ) const
overridevirtual

Return the number of frequency channels.

Implements Pulsar::Calibrator::Info.

References poln_calibrator.

◆ get_nclass()

unsigned CorrelationInfo::get_nclass ( ) const
overridevirtual

Return the number of parameter classes.

Implements Pulsar::Calibrator::Info.

References names.

◆ get_nparam()

unsigned CorrelationInfo::get_nparam ( unsigned iclass) const
overridevirtual

Return the number of parameters in the specified class.

Implements Pulsar::Calibrator::Info.

References index, and names.

◆ get_param()

Estimate< float > CorrelationInfo::get_param ( unsigned ichan,
unsigned iclass,
unsigned iparam ) const
overridevirtual

Return the estimate of the specified parameter.

Implements Pulsar::Calibrator::Info.

References index, names, and poln_calibrator.

◆ get_param_name()

std::string CorrelationInfo::get_param_name ( unsigned iparam) const
overridevirtual

Return the PGPLOT-encoded name of the specified parameter.

Reimplemented from Pulsar::Calibrator::Info.

References names.

◆ get_title()

string CorrelationInfo::get_title ( ) const
overridevirtual

Return the title.

Implements Pulsar::Calibrator::Info.

References index, and names.


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

Generated using doxygen 1.14.0