Pulsar::AdaptiveSNR Class Reference

Calculates the signal-to-noise ratio using a ProfileWeightFunction. More...

#include <AdaptiveSNR.h>

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

Public Member Functions

 AdaptiveSNR ()
 Default constructor.
 
 ~AdaptiveSNR ()
 Destructor.
 
void set_baseline_estimator (ProfileWeightFunction *function)
 Set the function used to compute the baseline. More...
 
ProfileWeightFunctionget_baseline_estimator () const
 
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.
 
AdaptiveSNRclone () const
 Return a copy constructed instance of self.
 
- 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

Reference::To< ProfileWeightFunctionbaseline_estimator
 The function used to compute the baseline.
 

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 using a ProfileWeightFunction.

Member Function Documentation

◆ set_baseline_estimator()

void Pulsar::AdaptiveSNR::set_baseline_estimator ( ProfileWeightFunction function)

Set the function used to compute the baseline.

Set the threshold below which samples are included in the baseline.


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

Generated using doxygen 1.8.17