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 
17 namespace Pulsar {
18 
19  class ScalarTemplateMatching;
20 
22  class PhaseGradShift : public ProfileStandardShift
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 
48  Estimate<double> get_shift () const;
49 
51  double get_reduced_chisq () const;
52 
55  { return new EmptyInterface<PhaseGradShift> ("PGS"); }
56 
58  PhaseGradShift* clone () const { return new PhaseGradShift(*this); }
59 
60  };
61 
62 }
63 
64 
65 #endif // !defined __Pulsar_PhaseGradShift_h
TextInterface::Parser * get_interface()
Return a text interface that can be used to configure this instance.
Definition: PhaseGradShift.h:59
~PhaseGradShift()
Destructor.
Definition: PhaseGradShift.C:39
PhaseGradShift * clone() const
Return a copy constructed instance of self.
Definition: PhaseGradShift.h:63
Any quantity recorded as a function of pulse phase.
Definition: Profile.h:45
Estimates phase shift in Fourier domain.
Definition: PhaseGradShift.h:27
The original scalar template matching algorithm.
Definition: ScalarTemplateMatching.h:44
void set_maximum_harmonic(unsigned max)
Set the maximum number of harmonics to include in fit.
Definition: PhaseGradShift.C:45
Convenience interface used to add ShiftEstimator children to factory.
Definition: ShiftEstimator.h:64
PhaseGradShift()
Default constructor.
Definition: PhaseGradShift.C:32
double get_reduced_chisq() const
Return the statistical goodness of fit.
Definition: PhaseGradShift.C:90
void set_choose_maximum_harmonic(bool flag=true)
Allow software to choose the maximum harmonic.
Definition: PhaseGradShift.C:51
Defines the PSRCHIVE library.
Definition: CalSource.h:17
static Option< bool > compute_reduced_chisq
Compute the reduced chisq, or assume that it is unity.
Definition: PhaseGradShift.h:35
void set_compute_reduced_chisq(bool flag)
When true, compute the reduced chisq; when false, assume it is unity.
Definition: ScalarTemplateMatching.h:115
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

Generated using doxygen 1.8.17