PeakCumulative.h
1//-*-C++-*-
2/***************************************************************************
3 *
4 * Copyright (C) 2007 by Willem van Straten
5 * Licensed under the Academic Free License version 2.1
6 *
7 ***************************************************************************/
8
9// psrchive/More/General/Pulsar/PeakCumulative.h
10
11#ifndef __Pulsar_PeakCumulative_h
12#define __Pulsar_PeakCumulative_h
13
14#include "Pulsar/RiseFall.h"
15#include "Pulsar/HasBaselineEstimator.h"
16
17namespace Pulsar {
18
20
48
50 {
51
52 public:
53
56
58 void set_Profile (const Profile*);
59
61 void set_threshold (float threshold);
62
64 float get_threshold () const;
65
67 void set_choose (bool choose);
68
70 bool get_choose () const;
71
74
76 void set_range (int bin_start, int bin_end);
77
79 void get_indeces (int& rise, int& fall) const;
80
83
85 class Interface;
86
88 PeakCumulative* clone () const;
89
90 protected:
91
93 void build ();
94
96 bool built;
97
99 float threshold;
100
103
106
109
110 int bin_rise;
111 int bin_fall;
112 bool choose;
113 };
114
115}
116
117
118#endif // !defined __Pulsar_PeakCumulative_h
HasBaselineEstimator()
Default constructor.
Definition HasBaselineEstimator.C:15
void set_range(int bin_start, int bin_end)
Set the start and end bins of the search.
Definition PeakCumulative.C:83
PeakCumulative * clone() const
Return new copy of self.
Definition PeakCumulative.C:37
float get_threshold() const
Get the threshold.
Definition PeakCumulative.C:56
void set_choose(bool choose)
Set the choose.
Definition PeakCumulative.C:62
void set_baseline_estimator(ProfileWeightFunction *) override
Set the BaselineEstimator used to find the off-pulse phase bins.
Definition PeakCumulative.C:76
int bin_start
The first bin in the selected range.
Definition PeakCumulative.h:102
int bin_end
The last bin in the selected range.
Definition PeakCumulative.h:105
PeakCumulative()
Default constructor.
Definition PeakCumulative.C:24
bool range_specified
Set true when range is specified.
Definition PeakCumulative.h:108
void build()
Compute the rise and fall of the pulse.
Definition PeakCumulative.C:91
float threshold
The threshold.
Definition PeakCumulative.h:99
bool built
Flag set when the rise and fall are computed.
Definition PeakCumulative.h:96
bool get_choose() const
Get the choose.
Definition PeakCumulative.C:70
void get_indeces(int &rise, int &fall) const
Get the pulse phase bin indeces of the rise and fall.
Definition PeakCumulative.C:212
TextInterface::Parser * get_interface()
Return a text interface that can be used to configure this instance.
Definition PeakCumulative.C:239
void set_Profile(const Profile *)
Set the profile from which the rise and fall will be computed.
Definition PeakCumulative.C:42
void set_threshold(float threshold)
Set the threshold.
Definition PeakCumulative.C:49
PhaseWeight algorithms that receive an input Profile.
Definition ProfileWeightFunction.h:22
Any quantity recorded as a function of pulse phase.
Definition Profile.h:40
Estimates the on-pulse region between a rise and a fall.
Definition RiseFall.h:19
Defines the PSRCHIVE library.
Definition CalSource.h:17

Generated using doxygen 1.14.0