Pulsar::PhaseWeightFunction Class Reference

Algorithms that produce PhaseWeight objects. More...

#include <PhaseWeightFunction.h>

Inheritance diagram for Pulsar::PhaseWeightFunction:

Public Member Functions
virtual void	get_weight (PhaseWeight *weight)=0
	Retrieve the PhaseWeight.
virtual TextInterface::Parser *	get_interface ()=0
	Return a text interface that can be used to configure this instance.
virtual PhaseWeightFunction *	clone () const =0
	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

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

Algorithms that produce PhaseWeight objects.

This pure virtual base class of PhaseWeight algorithms defines the interface by which various routines, such as baseline estimators can be accessed

Member Function Documentation

clone()

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

pure virtual

Return a copy constructed instance of self.

Implemented in PeakConsecutive, Pulsar::BaselineEstimator, Pulsar::BaselineStatic, Pulsar::BaselineWindow, Pulsar::ConvertIsolated, Pulsar::ExponentialBaseline, Pulsar::GaussianBaseline, Pulsar::IQRBaseline, Pulsar::LastHarmonic, Pulsar::MaskSmooth, Pulsar::OnPulseEstimator, Pulsar::OnPulseThreshold, Pulsar::PeakConsecutive, Pulsar::PeakCumulative, Pulsar::PhaseWeightShift, Pulsar::ProfileWeightFunction, and Pulsar::ProfileWeightStatic.

get_interface()

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

pure virtual

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

Implemented in PeakConsecutive, Pulsar::BaselineStatic, Pulsar::BaselineWindow, Pulsar::ExponentialBaseline, Pulsar::GaussianBaseline, Pulsar::IQRBaseline, Pulsar::LastHarmonic, Pulsar::OnPulseThreshold, Pulsar::PeakConsecutive, Pulsar::PeakCumulative, Pulsar::PhaseWeightModifier, and Pulsar::ProfileWeightStatic.

Referenced by Pulsar::ProfileStats::Interface::Interface().

get_weight()

virtual void Pulsar::PhaseWeightFunction::get_weight ( PhaseWeight * weight )

pure virtual

Retrieve the PhaseWeight.

Implemented in Pulsar::PhaseWeightModifier, and Pulsar::ProfileWeightFunction.

---

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

• PhaseWeightFunction.h