PhaseGradShift.h
1//-*-C++-*-
2/***************************************************************************
3 *
4 * Copyright (C) 2009 by Willem van Straten
5 * Licensed under the Academic Free License version 2.1
6 *
7 ***************************************************************************/
8
9// psrchive/More/Timing/Pulsar/PhaseGradShift.h
10
11#ifndef __Pulsar_PhaseGradShift_h
12#define __Pulsar_PhaseGradShift_h
13
14#include "Pulsar/ProfileStandardShift.h"
15#include "Pulsar/Config.h"
16
17namespace Pulsar {
18
20
23 {
26
27 public:
28
31
34
37
39 void set_standard (const Profile* p);
40
42 void set_maximum_harmonic (unsigned max);
43
45 void set_choose_maximum_harmonic (bool flag = true);
46
49
51 double get_reduced_chisq () const;
52
56
58 PhaseGradShift* clone () const { return new PhaseGradShift(*this); }
59
60 };
61
62}
63
64
65#endif // !defined __Pulsar_PhaseGradShift_h
Convenience interface used to add ShiftEstimator children to factory.
Definition ShiftEstimator.h:60
Configuration option.
Definition Config.h:69
PhaseGradShift * clone() const
Return a copy constructed instance of self.
Definition PhaseGradShift.h:58
void set_maximum_harmonic(unsigned max)
Set the maximum number of harmonics to include in fit.
Definition PhaseGradShift.C:45
TextInterface::Parser * get_interface()
Return a text interface that can be used to configure this instance.
Definition PhaseGradShift.h:54
PhaseGradShift()
Default constructor.
Definition PhaseGradShift.C:32
static Option< bool > compute_reduced_chisq
Compute the reduced chisq, or assume that it is unity.
Definition PhaseGradShift.h:30
~PhaseGradShift()
Destructor.
Definition PhaseGradShift.C:39
Estimate< double > get_shift() const
Return the best-fit estimate of the phase shift in turns.
Definition PhaseGradShift.C:63
void set_standard(const Profile *p)
Set the profile with respect to which the shift will be estimated.
Definition PhaseGradShift.C:57
void set_choose_maximum_harmonic(bool flag=true)
Allow software to choose the maximum harmonic.
Definition PhaseGradShift.C:51
double get_reduced_chisq() const
Return the statistical goodness of fit.
Definition PhaseGradShift.C:90
Estimates the phase shift relative to a standard pulse profile.
Definition ProfileStandardShift.h:20
Any quantity recorded as a function of pulse phase.
Definition Profile.h:40
The original scalar template matching algorithm.
Definition ScalarTemplateMatching.h:40
Defines the PSRCHIVE library.
Definition CalSource.h:17

Generated using doxygen 1.14.0