Pulsar::FourierSNR Class Reference

Calculates the signal-to-noise ratio in the Fourier domain. More...

#include <FourierSNR.h>

Inheritance diagram for Pulsar::FourierSNR:
Pulsar::SNRatioEstimator Pulsar::Algorithm Reference::Able Reference::HeapTracked

Public Member Functions

 FourierSNR ()
 Default constructor.
float get_snr (const Profile *profile)
 Return the signal to noise ratio.
TextInterface::Parserget_interface ()
 Return a text interface that can be used to configure this instance.
FourierSNRclone () const
 Return a copy constructed instance of self.
void set_baseline_extent (float width)
 Set the fractional number of high frequencies used to calculate noise.
float get_baseline_extent () const
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

float baseline_extent
 The fractional number of high frequencies used to calculate noise.

Additional Inherited Members

Static Public Member Functions inherited from Pulsar::SNRatioEstimator
static SNRatioEstimatorfactory (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 in the Fourier domain.

Member Function Documentation

◆ clone()

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

Return a copy constructed instance of self.

Implements Pulsar::SNRatioEstimator.

References FourierSNR().

◆ get_interface()

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

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

Implements Pulsar::SNRatioEstimator.

◆ get_snr()

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

Return the signal to noise ratio.

Implements Pulsar::SNRatioEstimator.

References baseline_extent, Pulsar::detect(), Pulsar::fourier_transform(), and Pulsar::Profile::verbose.


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

Generated using doxygen 1.14.0