Pulsar::ProfileStandardShift Class Reference

Estimates the phase shift relative to a standard pulse profile. More...

#include <ProfileStandardShift.h>

Inheritance diagram for Pulsar::ProfileStandardShift:

Public Member Functions
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 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

Protected Attributes
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 the phase shift relative to a standard pulse profile.

Member Function Documentation

set_standard()

virtual void Pulsar::ProfileStandardShift::set_standard ( const Profile * p )

inlinevirtual

Set the profile with respect to which the shift will be estimated.

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

Referenced by Pulsar::PhaseGradShift::set_standard().

---

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

• ProfileStandardShift.h