Pulsar::SNRatioEstimator Class Reference

Algorithms that estimate the signal-to-noise ratio of pulse profiles. More...

#include <SNRatioEstimator.h>

Inheritance diagram for Pulsar::SNRatioEstimator:

Public Member Functions
virtual float	get_snr (const Profile *profile)=0
	Return the signal to noise ratio.
virtual TextInterface::Parser *	get_interface ()=0
	Return a text interface that can be used to configure this instance.
virtual SNRatioEstimator *	clone () const =0
	Return a copy constructed instance of self.
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

Static Public Member Functions
static SNRatioEstimator *	factory (const std::string &name_and_parse)
	Construct a new SNRatioEstimator from a string.
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 ()

Additional Inherited Members
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Detailed Description

Algorithms that estimate the signal-to-noise ratio of pulse profiles.

Member Function Documentation

clone()

virtual SNRatioEstimator * Pulsar::SNRatioEstimator::clone ( ) const

pure virtual

Return a copy constructed instance of self.

Implemented in Pulsar::AdaptiveSNR, Pulsar::FortranSNR, Pulsar::FourierSNR, Pulsar::ModularSNR, Pulsar::PhaseSNR, Pulsar::SquareWave, and Pulsar::StandardSNR.

get_interface()

virtual TextInterface::Parser * Pulsar::SNRatioEstimator::get_interface ( )

pure virtual

Return a text interface that can be used to configure this instance.

Implemented in Pulsar::AdaptiveSNR, Pulsar::FortranSNR, Pulsar::FourierSNR, Pulsar::ModularSNR, Pulsar::PhaseSNR, Pulsar::SquareWave, and Pulsar::StandardSNR.

get_snr()

virtual float Pulsar::SNRatioEstimator::get_snr ( const Profile * profile )

pure virtual

Return the signal to noise ratio.

Implemented in Pulsar::AdaptiveSNR, Pulsar::FortranSNR, Pulsar::FourierSNR, Pulsar::ModularSNR, Pulsar::PhaseSNR, Pulsar::SquareWave, and Pulsar::StandardSNR.

Referenced by Pulsar::Profile::snr().

---

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

• SNRatioEstimator.h
• SNRatioEstimator.C