Pulsar::PhaseWidth Class Reference

Calculates the pulse width in the phase domain. More...

#include <PhaseWidth.h>

Inheritance diagram for Pulsar::PhaseWidth:

Public Member Functions
	PhaseWidth ()
	Default constructor.
	~PhaseWidth ()
	Destructor.
double	get_width_turns (const Profile *profile)
	Return the width of the pulse profile in turns.
Phase::Value	get_error () const
float	get_fraction_of_maximum () const
void	set_fraction_of_maximum (float)
TextInterface::Parser *	get_interface ()
	Return a text interface that can be used to configure this instance.
PhaseWidth *	clone () const
	Return a copy constructed instance of self.
Public Member Functions inherited from Pulsar::WidthEstimator
	~WidthEstimator ()
	Destructor.
virtual Phase::Value	get_width (const Profile *profile)
	Return the width of the pulse profile in turns.
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
Public Member Functions inherited from Pulsar::HasBaselineEstimator
	HasBaselineEstimator ()
	Default constructor.
	HasBaselineEstimator (const HasBaselineEstimator &)
	Copy constructor.
	~HasBaselineEstimator ()
	Destructor.
virtual void	set_baseline_estimator (ProfileWeightFunction *)
	Set the algorithm used to find the off-pulse phase bins.
ProfileWeightFunction *	get_baseline_estimator () const
	Get the algorithm used to find the off-pulse phase bins.
bool	has_baseline_estimator () const
	Return true if baseline estimator is set.

Additional Inherited Members
Static Public Member Functions inherited from Pulsar::WidthEstimator
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 inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Detailed Description

Calculates the pulse width in the phase domain.

This default implementation of the width estimator is taken from pdv.

Member Function Documentation

clone()

Pulsar::PhaseWidth * Pulsar::PhaseWidth::clone ( ) const

virtual

Return a copy constructed instance of self.

Implements Pulsar::WidthEstimator.

References PhaseWidth().

get_interface()

TextInterface::Parser * Pulsar::PhaseWidth::get_interface ( )

virtual

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

Implements Pulsar::WidthEstimator.

get_width_turns()

double Pulsar::PhaseWidth::get_width_turns ( const Profile * profile )

virtual

Return the width of the pulse profile in turns.

Implements Pulsar::WidthEstimator.

References Pulsar::Profile::find_max_bin(), Pulsar::Profile::find_min_bin(), Pulsar::ProfileAmps::get_amps(), Pulsar::HasBaselineEstimator::get_baseline_estimator(), Pulsar::ProfileAmps::get_nbin(), Pulsar::Profile::max(), and Pulsar::Profile::min().

---

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

• PhaseWidth.h
• PhaseWidth.C