Pulsar::PhaseGradShift Class Reference

Estimates phase shift in Fourier domain. More...

#include <PhaseGradShift.h>

Inheritance diagram for Pulsar::PhaseGradShift:

Public Member Functions
	PhaseGradShift ()
	Default constructor.
	~PhaseGradShift ()
	Destructor.
void	set_standard (const Profile *p)
	Set the profile with respect to which the shift will be estimated.
void	set_maximum_harmonic (unsigned max)
	Set the maximum number of harmonics to include in fit.
void	set_choose_maximum_harmonic (bool flag=true)
	Allow software to choose the maximum harmonic.
Estimate< double >	get_shift () const
	Return the best-fit estimate of the phase shift in turns.
double	get_reduced_chisq () const
	Return the statistical goodness of fit.
TextInterface::Parser *	get_interface ()
	Return a text interface that can be used to configure this instance.
PhaseGradShift *	clone () const
	Return a copy constructed instance of self.
Public Member Functions inherited from Pulsar::ProfileStandardShift
const Profile *	get_standard () const
	Get the profile with respect to which the shift will be estimated.
Public Member Functions inherited from Pulsar::ProfileShiftEstimator
void	set_observation (const Profile *p)
	Set the profile from which the shift will be estimated.
const Profile *	get_observation () const
	Get the profile from which the shift will be estimated.
Public Member Functions inherited from Pulsar::ShiftEstimator
virtual double	get_snr () const
	Return the profile S/N ratio.
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. More...
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 Attributes
static Option< bool >	compute_reduced_chisq
	Compute the reduced chisq, or assume that it is unity.
Static Public Attributes inherited from Pulsar::ShiftEstimator
static bool	verbose = false

Additional Inherited Members
Static Public Member Functions inherited from Pulsar::ShiftEstimator
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 ()
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const
Protected Attributes inherited from Pulsar::ProfileStandardShift
Reference::To< const Profile >	standard
Protected Attributes inherited from Pulsar::ProfileShiftEstimator
Reference::To< const Profile >	observation

Detailed Description

Estimates phase shift in Fourier domain.

---

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

• PhaseGradShift.h
• PhaseGradShift.C