Calculates the S/N using an on-pulse and off-pulse ProfileWeightFunction. More...

#include <ModularSNR.h>

Inheritance diagram for Pulsar::ModularSNR:

Public Member Functions
	ModularSNR ()
	Default constructor.

	~ModularSNR ()
	Destructor.

void	set_baseline_estimator (ProfileWeightFunction *function)
	Set the function used to compute the baseline. More...

ProfileWeightFunction *	get_baseline_estimator () const

void	set_onpulse_estimator (ProfileWeightFunction *function)
	Set the function used to find the on-pulse. More...

ProfileWeightFunction *	get_onpulse_estimator () const

float	get_snr (const Profile *profile)
	Return the signal to noise ratio.

TextInterface::Parser *	get_interface ()
	Return a text interface that can be used to configure this instance.

ModularSNR *	clone () const
	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

Protected Attributes
Reference::To< ProfileWeightFunction >	baseline_estimator
	The function used to compute the baseline.

Reference::To< ProfileWeightFunction >	onpulse_estimator
	The function used to find the onpulse region.

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 S/N using an on-pulse and off-pulse ProfileWeightFunction.

Member Function Documentation

void Pulsar::ModularSNR::set_baseline_estimator ( ProfileWeightFunction * function )

Set the function used to compute the baseline.

Set the algorithm used to identify the off-pulse baseline.

void Pulsar::ModularSNR::set_onpulse_estimator ( ProfileWeightFunction * function )

Set the function used to find the on-pulse.

Set the algorithm used to identify the on-pulse region.

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