Pulsar::StandardSNR Class Reference

Calculates the signal-to-noise ratio by fitting against a standard. More...

#include <StandardSNR.h>

Inheritance diagram for Pulsar::StandardSNR:

Public Member Functions
void	set_standard (const Profile *profile)
	Set the standard against which the S/N will be calculated.
float	get_snr (const Profile *profile)
	Return the signal to noise ratio based on the shift.
TextInterface::Parser *	get_interface ()
	Return a text interface that can be used to configure this instance.
StandardSNR *	clone () const
	Return a copy constructed instance of self.
void	set_standard_filename (const std::string &filename)
	Set the name of the file from which the standard profile will be loaded.
std::string	get_standard_filename () const
	Return the name of the file from which the standard was loaded.
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
ProfileShiftFit	fit
	Used to perform the fit and compute the S/N.
std::string	filename

Additional Inherited Members
Static Public Member Functions inherited from Pulsar::SNRatioEstimator
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 ()
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Detailed Description

Calculates the signal-to-noise ratio by fitting against a standard.

Member Function Documentation

clone()

Pulsar::StandardSNR * Pulsar::StandardSNR::clone ( ) const

virtual

Return a copy constructed instance of self.

Implements Pulsar::SNRatioEstimator.

get_interface()

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

virtual

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

Implements Pulsar::SNRatioEstimator.

get_snr()

float Pulsar::StandardSNR::get_snr ( const Profile * profile )

virtual

Return the signal to noise ratio based on the shift.

Implements Pulsar::SNRatioEstimator.

References fit.

---

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

• StandardSNR.h
• StandardSNR.C