Pulsar::PhaseGradShift Class Reference

Estimates phase shift in Fourier domain. More...

#include <PhaseGradShift.h>

Inheritance diagram for Pulsar::PhaseGradShift:
Pulsar::ProfileStandardShift Pulsar::ProfileShiftEstimator Pulsar::ShiftEstimator Pulsar::Algorithm Reference::Able Reference::HeapTracked

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::Parserget_interface ()
 Return a text interface that can be used to configure this instance.
PhaseGradShiftclone () const
 Return a copy constructed instance of self.
Public Member Functions inherited from Pulsar::ProfileStandardShift
const Profileget_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 Profileget_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.
Public Member Functions inherited from Reference::Able
 Able (const Able &)
Ableoperator= (const Able &)
unsigned get_reference_count () const
Public Member Functions inherited from Reference::HeapTracked
 HeapTracked (const HeapTracked &)
HeapTrackedoperator= (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 ShiftEstimatorfactory (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 Profilestandard
Protected Attributes inherited from Pulsar::ProfileShiftEstimator
Reference::To< const Profileobservation

Detailed Description

Estimates phase shift in Fourier domain.

Member Function Documentation

◆ clone()

PhaseGradShift * Pulsar::PhaseGradShift::clone ( ) const
inlinevirtual

Return a copy constructed instance of self.

Implements Pulsar::ShiftEstimator.

References PhaseGradShift().

◆ get_interface()

TextInterface::Parser * Pulsar::PhaseGradShift::get_interface ( )
inlinevirtual

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

Implements Pulsar::ShiftEstimator.

◆ get_reduced_chisq()

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

Return the statistical goodness of fit.

Reimplemented from Pulsar::ShiftEstimator.

◆ get_shift()

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

Return the best-fit estimate of the phase shift in turns.

Implements Pulsar::ShiftEstimator.

References Pulsar::Profile::verbose.

Referenced by Pulsar::SimPolnTiming::one_step().

◆ set_standard()

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

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

Reimplemented from Pulsar::ProfileStandardShift.

References Pulsar::ProfileStandardShift::set_standard().

Referenced by Pulsar::SimPolnTiming::one_step().


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

Generated using doxygen 1.14.0