Pulsar::LastSignificant Class Reference

Find the last significant harmonic in a PSD. More...

#include <LastSignificant.h>

Inheritance diagram for Pulsar::LastSignificant:
Pulsar::Algorithm Reference::Able Reference::HeapTracked

Public Member Functions

 LastSignificant ()
 Default constructor.
void set_threshold (float sigma)
 Set the cut-off threshold as a multiple of the rms.
float get_threshold () const
 Get the cut-off threshold.
void set_consecutive (unsigned consecutive)
 Set the number of consecutive bins that must remain above threshold.
unsigned get_consecutive () const
 Get the number of consecutive bins.
void find (const Profile *, double rms)
 Find the last significant bin.
void find (const std::vector< float > &, double rms)
 Find the last significant bin.
void find (unsigned nbin, const float *, double rms)
 Find the last significant bin.
unsigned get () const
 Get the last signficant bin.
void reset ()
 Reset the last significant phase bin.
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 cutoff_sigma
 The cut-off threshold.
unsigned consecutive
 The number of consecutive bins that must remain above threshold.
unsigned last_significant
 The last significant bin.

Additional Inherited Members

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

Find the last significant harmonic in a PSD.

This algorithm is much like PeakConsecutive, but can be called multiple times and assumes that all power starts at bin zero.

Member Function Documentation

◆ find()

void Pulsar::LastSignificant::find ( const Profile * psd,
double rms )

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

Generated using doxygen 1.14.0