Pulsar::ProfileCovariance Class Reference

#include <ProfileCovariance.h>

Inheritance diagram for Pulsar::ProfileCovariance:

Public Member Functions
virtual std::string	get_name () const =0
	Return a copy constructed from instance of self.
virtual void	add_Profile (const Profile *)=0
	Adds the given Profile to the covariance matrix estimate.
virtual void	finalize ()=0
	Compute the covariance matrix after all the profiles were added.
virtual void	eigen ()=0
	Perform eigen decomposition of covariance matrix.
virtual unsigned	get_count ()=0
	Get the count of profiles used to estimate the covariance matrix.
virtual void	set_count (unsigned)=0
	Set the count of profiles used to estimate the covariance matrix.
virtual unsigned	get_rank ()=0
	Get the rank of covariance matrix.
virtual void	set_rank (unsigned)=0
	Set the rank of covariance matrix.
virtual void	reset ()=0
	Reset the covariance matrix calculations.
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 Member Functions
	ProfileCovariance ()
	Default constructor initializes the following attributes to nil.
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Protected Attributes
bool	finalized
	Has the covariance matrix.
unsigned	rank
	Rank of the covariance matrix.
unsigned	count
	The count of profiles used to estimate the covariance matrix.
double	wt_sum
	Sum of weights.
double	wt_sum2
	Sum of squard weights.

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 ()

Detailed Description

This pure virtual base class of ProfileCovariance defines the interface by which various routines for calculating the covariance matrix of the given profile can be accessed

Constructor & Destructor Documentation

ProfileCovariance()

Pulsar::ProfileCovariance::ProfileCovariance ( )

protected

Default constructor initializes the following attributes to nil.

Default constructor.

References count, finalized, rank, wt_sum, and wt_sum2.

Member Function Documentation

get_name()

virtual std::string Pulsar::ProfileCovariance::get_name ( ) const

pure virtual

Return a copy constructed from instance of self.

Get the name of class used

---

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

• ProfileCovariance.h
• ProfileCovariance.C