LArSoft  v06_85_00
Liquid Argon Software toolkit - http://larsoft.org/
Public Member Functions | Private Types | Private Attributes | List of all members
reco_tool::PeakFitterGaussian Class Reference
Inheritance diagram for reco_tool::PeakFitterGaussian:
reco_tool::IPeakFitter

Public Member Functions

 PeakFitterGaussian (const fhicl::ParameterSet &pset)
 
 ~PeakFitterGaussian ()
 
void configure (const fhicl::ParameterSet &pset) override
 
void findPeakParameters (const std::vector< float > &, const ICandidateHitFinder::HitCandidateVec &, PeakParamsVec &, double &, int &) const override
 

Private Types

using PeakFitParams_t = struct PeakFitParams{float peakCenter
 
using PeakParamsVec = std::vector< PeakFitParams_t >
 

Private Attributes

double fMinWidth
 minimum initial width for gaussian fit More...
 
double fMaxWidthMult
 multiplier for max width for gaussian fit More...
 
double fPeakRange
 set range limits for peak center More...
 
double fAmpRange
 set range limit for peak amplitude More...
 
TH1F fHistogram
 
const geo::GeometryCore * fGeometry = lar::providerFrom<geo::Geometry>()
 
float peakCenterError
 
float peakSigma
 
float peakSigmaError
 
float peakAmplitude
 
float peakAmplitudeError
 

Detailed Description

Definition at line 23 of file PeakFitterGaussian_tool.cc.

Member Typedef Documentation

using reco_tool::IPeakFitter::PeakFitParams_t = struct PeakFitParams { float peakCenter
inherited

Definition at line 31 of file IPeakFitter.h.

using reco_tool::IPeakFitter::PeakParamsVec = std::vector<PeakFitParams_t>
inherited

Definition at line 39 of file IPeakFitter.h.

Constructor & Destructor Documentation

reco_tool::PeakFitterGaussian::PeakFitterGaussian ( const fhicl::ParameterSet &  pset)
explicit

Definition at line 52 of file PeakFitterGaussian_tool.cc.

References configure().

53 {
54  configure(pset);
55 }
reco_tool::PeakFitterGaussian::configure
void configure(const fhicl::ParameterSet &pset) override
Definition: PeakFitterGaussian_tool.cc:61
reco_tool::PeakFitterGaussian::~PeakFitterGaussian ( )

Definition at line 57 of file PeakFitterGaussian_tool.cc.

58 {
59 }

Member Function Documentation

void reco_tool::PeakFitterGaussian::configure ( const fhicl::ParameterSet &  pset)
overridevirtual

Implements reco_tool::IPeakFitter.

Definition at line 61 of file PeakFitterGaussian_tool.cc.

References fAmpRange, fHistogram, fMaxWidthMult, fMinWidth, fPeakRange, and fhicl::ParameterSet::get().

Referenced by PeakFitterGaussian().

62 {
63  // Start by recovering the parameters
64  fMinWidth = pset.get<double>("MinWidth", 0.5);
65  fMaxWidthMult = pset.get<double>("MaxWidthMult", 3.);
66  fPeakRange = pset.get<double>("PeakRangeFact", 2.);
67  fAmpRange = pset.get<double>("PeakAmpRange", 2.);
68 
69  fHistogram = TH1F("PeakFitterHitSignal","",500,0.,500.);
70 
71  fHistogram.Sumw2();
72 
73  std::string function = "Gaus(0)";
74 
75  return;
76 }
reco_tool::PeakFitterGaussian::fMaxWidthMult
double fMaxWidthMult
multiplier for max width for gaussian fit
Definition: PeakFitterGaussian_tool.cc:41
reco_tool::PeakFitterGaussian::fAmpRange
double fAmpRange
set range limit for peak amplitude
Definition: PeakFitterGaussian_tool.cc:43
reco_tool::PeakFitterGaussian::fPeakRange
double fPeakRange
set range limits for peak center
Definition: PeakFitterGaussian_tool.cc:42
fhicl::ParameterSet::get
T get(std::string const &key) const
Definition: ParameterSet.h:231
reco_tool::PeakFitterGaussian::fHistogram
TH1F fHistogram
Definition: PeakFitterGaussian_tool.cc:45
reco_tool::PeakFitterGaussian::fMinWidth
double fMinWidth
minimum initial width for gaussian fit
Definition: PeakFitterGaussian_tool.cc:40
void reco_tool::PeakFitterGaussian::findPeakParameters ( const std::vector< float > &  roiSignalVec,
const ICandidateHitFinder::HitCandidateVec &  hitCandidateVec,
PeakParamsVec &  peakParamsVec,
double &  chi2PerNDF,
int &  NDF 
) const
overridevirtual

Implements reco_tool::IPeakFitter.

Definition at line 79 of file PeakFitterGaussian_tool.cc.

References DEFINE_ART_CLASS_TOOL, fAmpRange, fHistogram, fMaxWidthMult, fMinWidth, fPeakRange, max, min, and util::flags::to_string().

84 {
85  // The following is a translation of the original FitGaussians function in the original
86  // GausHitFinder module originally authored by Jonathan Asaadi
87  //
88  // *** NOTE: this algorithm assumes the reference time for input hit candidates is to
89  // the first tick of the input waveform (ie 0)
90  //
91  if (hitCandidateVec.empty()) return;
92 
93  // in case of a fit failure, set the chi-square to infinity
94  chi2PerNDF = std::numeric_limits<double>::infinity();
95 
96  int startTime = hitCandidateVec.front().startTick;
97  int endTime = hitCandidateVec.back().stopTick;
98  int roiSize = endTime - startTime;
99 
100  // Check to see if we need a bigger histogram for fitting
101  if (roiSize > fHistogram.GetNbinsX())
102  {
103  std::string histName = "PeakFitterHitSignal_" + std::to_string(roiSize);
104  fHistogram = TH1F(histName.c_str(),"",roiSize,0.,roiSize);
105  fHistogram.Sumw2();
106  }
107 
108  for(int idx = 0; idx < roiSize; idx++) fHistogram.SetBinContent(idx+1,roiSignalVec.at(startTime+idx));
109 
110  // Build the string to describe the fit formula
111  std::string equation = "gaus(0)";
112 
113  for(size_t idx = 1; idx < hitCandidateVec.size(); idx++) equation += "+gaus(" + std::to_string(3*idx) + ")";
114 
115  // Now define the complete function to fit
116  TF1 Gaus("Gaus",equation.c_str(),0,roiSize);
117 
118  // ### Setting the parameters for the Gaussian Fit ###
119  int parIdx(0);
120  for(auto& candidateHit : hitCandidateVec)
121  {
122  double peakMean = candidateHit.hitCenter - float(startTime);
123  double peakWidth = candidateHit.hitSigma;
124  double amplitude = candidateHit.hitHeight;
125  double meanLowLim = std::max(peakMean - fPeakRange * peakWidth, 0.);
126  double meanHiLim = std::min(peakMean + fPeakRange * peakWidth, double(roiSize));
127 
128  Gaus.SetParameter( parIdx, amplitude);
129  Gaus.SetParameter(1+parIdx, peakMean);
130  Gaus.SetParameter(2+parIdx, peakWidth);
131  Gaus.SetParLimits( parIdx, 0.1 * amplitude, fAmpRange * amplitude);
132  Gaus.SetParLimits(1+parIdx, meanLowLim, meanHiLim);
133  Gaus.SetParLimits(2+parIdx, std::max(fMinWidth, 0.1 * peakWidth), fMaxWidthMult * peakWidth);
134 
135  parIdx += 3;
136  }
137 
138  int fitResult(-1);
139 
140  try
141  { fitResult = fHistogram.Fit(&Gaus,"QNRWB","", 0., roiSize);}
142  catch(...)
143  {mf::LogWarning("GausHitFinder") << "Fitter failed finding a hit";}
144 
145  // If the fit result is not zero there was an error
146  if (!fitResult)
147  {
148  // ##################################################
149  // ### Getting the fitted parameters from the fit ###
150  // ##################################################
151  chi2PerNDF = (Gaus.GetChisquare() / Gaus.GetNDF());
152  NDF = Gaus.GetNDF();
153 
154  parIdx = 0;
155  for(size_t idx = 0; idx < hitCandidateVec.size(); idx++)
156  {
157  PeakFitParams_t peakParams;
158 
159  peakParams.peakAmplitude = Gaus.GetParameter(parIdx);
160  peakParams.peakAmplitudeError = Gaus.GetParError( parIdx);
161  peakParams.peakCenter = Gaus.GetParameter(parIdx + 1) + float(startTime);
162  peakParams.peakCenterError = Gaus.GetParError( parIdx + 1);
163  peakParams.peakSigma = Gaus.GetParameter(parIdx + 2);
164  peakParams.peakSigmaError = Gaus.GetParError( parIdx + 2);
165 
166  peakParamsVec.emplace_back(peakParams);
167 
168  parIdx += 3;
169  }
170  }
171 
172  Gaus.Delete();
173 
174  return;
175 }
reco_tool::PeakFitterGaussian::fMaxWidthMult
double fMaxWidthMult
multiplier for max width for gaussian fit
Definition: PeakFitterGaussian_tool.cc:41
reco_tool::PeakFitterGaussian::fAmpRange
double fAmpRange
set range limit for peak amplitude
Definition: PeakFitterGaussian_tool.cc:43
reco_tool::PeakFitterGaussian::fPeakRange
double fPeakRange
set range limits for peak center
Definition: PeakFitterGaussian_tool.cc:42
reco_tool::IPeakFitter::PeakFitParams_t
struct PeakFitParams{float peakCenter PeakFitParams_t
Definition: IPeakFitter.h:31
max
Int_t max
Definition: plot.C:27
reco_tool::PeakFitterGaussian::fHistogram
TH1F fHistogram
Definition: PeakFitterGaussian_tool.cc:45
util::flags::to_string
std::string to_string(Flag_t< Storage > const flag)
Convert a flag into a stream (shows its index).
Definition: BitMask.h:187
min
Int_t min
Definition: plot.C:26
mf::LogWarning
MaybeLogger_< ELseverityLevel::ELsev_warning, false > LogWarning
Definition: MessageLogger.h:213
reco_tool::PeakFitterGaussian::fMinWidth
double fMinWidth
minimum initial width for gaussian fit
Definition: PeakFitterGaussian_tool.cc:40

Member Data Documentation

double reco_tool::PeakFitterGaussian::fAmpRange
private

set range limit for peak amplitude

Definition at line 43 of file PeakFitterGaussian_tool.cc.

Referenced by configure(), and findPeakParameters().

const geo::GeometryCore* reco_tool::PeakFitterGaussian::fGeometry = lar::providerFrom<geo::Geometry>()
private

Definition at line 47 of file PeakFitterGaussian_tool.cc.

TH1F reco_tool::PeakFitterGaussian::fHistogram
mutableprivate

Definition at line 45 of file PeakFitterGaussian_tool.cc.

Referenced by configure(), and findPeakParameters().

double reco_tool::PeakFitterGaussian::fMaxWidthMult
private

multiplier for max width for gaussian fit

Definition at line 41 of file PeakFitterGaussian_tool.cc.

Referenced by configure(), and findPeakParameters().

double reco_tool::PeakFitterGaussian::fMinWidth
private

minimum initial width for gaussian fit

Definition at line 40 of file PeakFitterGaussian_tool.cc.

Referenced by configure(), and findPeakParameters().

double reco_tool::PeakFitterGaussian::fPeakRange
private

set range limits for peak center

Definition at line 42 of file PeakFitterGaussian_tool.cc.

Referenced by configure(), and findPeakParameters().

float reco_tool::IPeakFitter::peakAmplitude
inherited

Definition at line 35 of file IPeakFitter.h.

float reco_tool::IPeakFitter::peakAmplitudeError
inherited

Definition at line 36 of file IPeakFitter.h.

float reco_tool::IPeakFitter::peakCenterError
inherited

Definition at line 32 of file IPeakFitter.h.

float reco_tool::IPeakFitter::peakSigma
inherited

Definition at line 33 of file IPeakFitter.h.

float reco_tool::IPeakFitter::peakSigmaError
inherited

Definition at line 34 of file IPeakFitter.h.

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