Pulsar::WidthEstimator Class Reference

Algorithms that estimate the width of the pulse profile. More...

#include <WidthEstimator.h>

Inheritance diagram for Pulsar::WidthEstimator:

Public Member Functions
	~WidthEstimator ()
	Destructor.
virtual Phase::Value	get_width (const Profile *profile)
	Return the width of the pulse profile in turns.
virtual TextInterface::Parser *	get_interface ()=0
	Return a text interface that can be used to configure this instance.
virtual WidthEstimator *	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

Static Public Member Functions
static WidthEstimator *	factory (const std::string &name_and_parse)
	Construct a new WidthEstimator 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
virtual double	get_width_turns (const Profile *profile)=0
	Derived classes must implement this method.
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Detailed Description

Algorithms that estimate the width of the pulse profile.

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 WidthEstimator * Pulsar::WidthEstimator::clone ( ) const

pure virtual

Return a copy constructed instance of self.

Implemented in Pulsar::PhaseWidth.

get_interface()

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

pure virtual

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

Implemented in Pulsar::PhaseWidth.

get_width_turns()

virtual double Pulsar::WidthEstimator::get_width_turns ( const Profile * profile )

protectedpure virtual

Derived classes must implement this method.

Implemented in Pulsar::PhaseWidth.

Referenced by get_width().

---

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

• WidthEstimator.h
• WidthEstimator.C