FourierDomainFit Class Reference

Estimates phase shift in Fourier domain with MCMC error estimate *‍/. More...

#include <FourierDomainFit.h>

Inheritance diagram for FourierDomainFit:

Public Member Functions
void	set_standard (const Profile *p)
	Set the template profile.
Estimate< double >	get_shift () const
	Return the shift estimate.
double	get_reduced_chisq () const
	Return the statistical goodness-of-fit.
double	get_snr () const
	Return the profile S/N ratio (relative to the standard)
TextInterface::Parser *	get_interface ()
	Return a text interface that can be used to configure this instance.
FourierDomainFit *	clone () const
	Return a copy constructed instance of self.
void	set_mcmc (bool flag=true)
	Use Markov Chain Monte Carlo method to determine TOA uncertainty.
bool	get_mcmc () const
void	set_iterations (int nit)
	Set number of iterations for MCMC.
int	get_iterations () const
void	set_error_method (std::string m)
	Set uncertainty calculation method.
std::string	get_error_method () const
Public Member Functions inherited from Pulsar::ProfileStandardShift
virtual void	set_standard (const Profile *p)
	Set the profile with respect to which the shift will be estimated.
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 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

Protected Attributes
std::string	error_method
	The uncertainty calculation method.
double	reduced_chisq
	Reduced chisq of last call to get_shift.
double	snr
	S/N ratio of last profile fit.
ProfileShiftFit	fit
	The class that does the actual fit.
Protected Attributes inherited from Pulsar::ProfileStandardShift
Reference::To< const Profile >	standard
Protected Attributes inherited from Pulsar::ProfileShiftEstimator
Reference::To< const Profile >	observation

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 ()
Static Public Attributes inherited from Pulsar::ShiftEstimator
static bool	verbose = false
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Detailed Description

Estimates phase shift in Fourier domain with MCMC error estimate *‍/.

Member Function Documentation

clone()

FourierDomainFit * Pulsar::FourierDomainFit::clone ( ) const

inlinevirtual

Return a copy constructed instance of self.

Implements Pulsar::ShiftEstimator.

get_interface()

TextInterface::Parser * FourierDomainFit::get_interface ( )

virtual

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

Implements Pulsar::ShiftEstimator.

get_reduced_chisq()

double Pulsar::FourierDomainFit::get_reduced_chisq ( ) const

virtual

Return the statistical goodness-of-fit.

Return the statistical goodness of fit.

Reimplemented from Pulsar::ShiftEstimator.

get_shift()

Estimate< double > Pulsar::FourierDomainFit::get_shift ( ) const

virtual

Return the shift estimate.

Implements Pulsar::ShiftEstimator.

get_snr()

double Pulsar::FourierDomainFit::get_snr ( ) const

virtual

Return the profile S/N ratio (relative to the standard)

Return the S/N ratio.

Reimplemented from Pulsar::ShiftEstimator.

---

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

• FourierDomainFit.h
• FourierDomainFit.C