Pulsar::ShiftEstimator Class Reference

Algorithms that estimate pulse phase shifts. More...

#include <ShiftEstimator.h>

Inheritance diagram for Pulsar::ShiftEstimator:

Public Member Functions
virtual Estimate< double >	get_shift () const =0
	Return the shift estimate.
virtual double	get_reduced_chisq () const
	Return the statistical goodness of fit.
virtual double	get_snr () const
	Return the profile S/N ratio.
virtual TextInterface::Parser *	get_interface ()=0
	Return a text interface that can be used to configure this instance.
virtual ShiftEstimator *	clone () const =0
	Return a copy constructed instance of self.
virtual std::string	get_name () const
	Return a name that can be subsituted for the template/standard.
virtual void	preprocess (Archive *)
	Prepare the data for use.
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 ShiftEstimator *	factory (const std::string &name_and_parse)
	Construct a new ShiftEstimator 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 ()

Static Public Attributes
static bool	verbose = false

Additional Inherited Members
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Detailed Description

Algorithms that estimate pulse phase shifts.

Member Function Documentation

clone()

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

pure virtual

Return a copy constructed instance of self.

Implemented in FourierDomainFit, Pulsar::ComponentModel, Pulsar::FluxCentroid, Pulsar::FourierDomainFit, Pulsar::GaussianShift, Pulsar::MeanPhase, Pulsar::ParIntShift, Pulsar::PhaseGradShift, Pulsar::RotatingVectorModelShift, Pulsar::SincInterpShift, and Pulsar::ZeroPadShift.

get_interface()

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

pure virtual

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

Implemented in FourierDomainFit, Pulsar::ComponentModel, Pulsar::FluxCentroid, Pulsar::FourierDomainFit, Pulsar::GaussianShift, Pulsar::MeanPhase, Pulsar::ParIntShift, Pulsar::PhaseGradShift, Pulsar::RotatingVectorModelShift, Pulsar::SincInterpShift, and Pulsar::ZeroPadShift.

get_name()

virtual std::string Pulsar::ShiftEstimator::get_name ( ) const

inlinevirtual

Return a name that can be subsituted for the template/standard.

Reimplemented in Pulsar::ComponentModel.

get_reduced_chisq()

virtual double Pulsar::ShiftEstimator::get_reduced_chisq ( ) const

inlinevirtual

Return the statistical goodness of fit.

Reimplemented in FourierDomainFit, Pulsar::ComponentModel, Pulsar::FourierDomainFit, and Pulsar::PhaseGradShift.

get_shift()

virtual Estimate< double > Pulsar::ShiftEstimator::get_shift ( ) const

pure virtual

Return the shift estimate.

Implemented in FourierDomainFit, Pulsar::ComponentModel, Pulsar::FluxCentroid, Pulsar::FourierDomainFit, Pulsar::GaussianShift, Pulsar::MeanPhase, Pulsar::ParIntShift, Pulsar::PhaseGradShift, Pulsar::RotatingVectorModelShift, Pulsar::SincInterpShift, and Pulsar::ZeroPadShift.

get_snr()

virtual double Pulsar::ShiftEstimator::get_snr ( ) const

inlinevirtual

Return the profile S/N ratio.

Reimplemented in FourierDomainFit, and Pulsar::FourierDomainFit.

preprocess()

void Pulsar::ShiftEstimator::preprocess ( Archive * archive )

virtual

Prepare the data for use.

Most estimators work with total intensity

Reimplemented in Pulsar::RotatingVectorModelShift.

References Signal::Stokes.

---

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

• ShiftEstimator.h
• ShiftEstimator.C