Inheritance diagram for reco_tool::PeakFitterGaussian:

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...

bool	fFloatBaseline
	Allow baseline to "float" away from zero. More...

BaselinedGausFitCache	fFitCache
	Preallocated ROOT functions for the fits. 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 59 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 91 of file PeakFitterGaussian_tool.cc.

 {
     configure(pset);
 }

reco_tool::PeakFitterGaussian::~PeakFitterGaussian ( )

Definition at line 96 of file PeakFitterGaussian_tool.cc.

97 {

98 }

Member Function Documentation

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

overridevirtual

Implements reco_tool::IPeakFitter.

Definition at line 100 of file PeakFitterGaussian_tool.cc.

References fhicl::ParameterSet::get().

 {
     // Start by recovering the parameters
     fMinWidth      = pset.get<double>("MinWidth",      0.5);
     fMaxWidthMult  = pset.get<double>("MaxWidthMult",  3.);
     fPeakRange     = pset.get<double>("PeakRangeFact", 2.);
     fAmpRange      = pset.get<double>("PeakAmpRange",  2.);
     fFloatBaseline = pset.get< bool >("FloatBaseline", false);
     
     fHistogram    = TH1F("PeakFitterHitSignal","",500,0.,500.);
     
     fHistogram.Sumw2();
     
     std::string function = "Gaus(0)";
     
     return;
 }

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 119 of file PeakFitterGaussian_tool.cc.

References DEFINE_ART_CLASS_TOOL, max, min, and util::flags::to_string().

 {
     // The following is a translation of the original FitGaussians function in the original
     // GausHitFinder module originally authored by Jonathan Asaadi
     //
     // *** NOTE: this algorithm assumes the reference time for input hit candidates is to
     //           the first tick of the input waveform (ie 0)
     //
     if (hitCandidateVec.empty()) return;
     
     // in case of a fit failure, set the chi-square to infinity
     chi2PerNDF = std::numeric_limits<double>::infinity();
     
     int startTime = hitCandidateVec.front().startTick;
     int endTime   = hitCandidateVec.back().stopTick;
     int roiSize   = endTime - startTime;
     
     // Check to see if we need a bigger histogram for fitting
     if (roiSize > fHistogram.GetNbinsX())
     {
         std::string histName = "PeakFitterHitSignal_" + std::to_string(roiSize);
         fHistogram = TH1F(histName.c_str(),"",roiSize,0.,roiSize);
         fHistogram.Sumw2();
     }
     
     for(int idx = 0; idx < roiSize; idx++) fHistogram.SetBinContent(idx+1,roiSignalVec.at(startTime+idx));
     
     // Build the string to describe the fit formula
 #if 0
     std::string equation = "gaus(0)";
     
     for(size_t idx = 1; idx < hitCandidateVec.size(); idx++) equation += "+gaus(" + std::to_string(3*idx) + ")";
     
     // Set the baseline if so desired
     float baseline(0.);
     
     if (fFloatBaseline)
     {
         baseline = roiSignalVec.at(startTime);
     
         equation += "+" + std::to_string(baseline);
     }
 
     // Now define the complete function to fit
     TF1 Gaus("Gaus",equation.c_str(),0,roiSize,TF1::EAddToList::kNo);
 #else
     unsigned int const nGaus = hitCandidateVec.size();
     assert(fFitCache.Get(nGaus));
     TF1& Gaus = *(fFitCache.Get(nGaus));
 
     // Set the baseline if so desired
     float const baseline = fFloatBaseline? roiSignalVec.at(startTime): 0.0;
     
     Gaus.FixParameter(nGaus * 3, baseline); // last parameter is the baseline
 
 #endif // 0
 
     // ### Setting the parameters for the Gaussian Fit ###
     int parIdx{0};
     for(auto const& candidateHit : hitCandidateVec)
     {
         double const peakMean   = candidateHit.hitCenter - float(startTime);
         double const peakWidth  = candidateHit.hitSigma;
         double const amplitude  = candidateHit.hitHeight - baseline;
         double const meanLowLim = std::max(peakMean - fPeakRange * peakWidth,              0.);
         double const meanHiLim  = std::min(peakMean + fPeakRange * peakWidth, double(roiSize));
         
         Gaus.SetParameter(  parIdx, amplitude);
         Gaus.SetParameter(1+parIdx, peakMean);
         Gaus.SetParameter(2+parIdx, peakWidth);
         Gaus.SetParLimits(  parIdx, 0.1 * amplitude,  fAmpRange * amplitude);
         Gaus.SetParLimits(1+parIdx, meanLowLim,       meanHiLim);
         Gaus.SetParLimits(2+parIdx, std::max(fMinWidth, 0.1 * peakWidth), fMaxWidthMult * peakWidth);
         
         parIdx += 3;
     }
     
     int fitResult{-1};
     
     try
     { fitResult = fHistogram.Fit(&Gaus,"QNWB","", 0., roiSize);}
     catch(...)
     {mf::LogWarning("GausHitFinder") << "Fitter failed finding a hit";}
     
     // If the fit result is not zero there was an error
     if (!fitResult)
     {
         // ##################################################
         // ### Getting the fitted parameters from the fit ###
         // ##################################################
         chi2PerNDF = (Gaus.GetChisquare() / Gaus.GetNDF());
         NDF        = Gaus.GetNDF();
     
         int parIdx { 0 };
         for(size_t idx = 0; idx < hitCandidateVec.size(); idx++)
         {
             PeakFitParams_t peakParams;
         
             peakParams.peakAmplitude      = Gaus.GetParameter(parIdx);
             peakParams.peakAmplitudeError = Gaus.GetParError( parIdx);
             peakParams.peakCenter         = Gaus.GetParameter(parIdx + 1) + float(startTime);
             peakParams.peakCenterError    = Gaus.GetParError( parIdx + 1);
             peakParams.peakSigma          = Gaus.GetParameter(parIdx + 2);
             peakParams.peakSigmaError     = Gaus.GetParError( parIdx + 2);
         
             peakParamsVec.emplace_back(peakParams);
         
             parIdx += 3;
         }
     }
 #if 0
     Gaus.Delete();    
 #endif // 0
     return;
 }

Member Data Documentation

double reco_tool::PeakFitterGaussian::fAmpRange

private

set range limit for peak amplitude

Definition at line 79 of file PeakFitterGaussian_tool.cc.

BaselinedGausFitCache reco_tool::PeakFitterGaussian::fFitCache

mutableprivate

Preallocated ROOT functions for the fits.

Definition at line 82 of file PeakFitterGaussian_tool.cc.

bool reco_tool::PeakFitterGaussian::fFloatBaseline

private

Allow baseline to "float" away from zero.

Definition at line 80 of file PeakFitterGaussian_tool.cc.

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

private

Definition at line 86 of file PeakFitterGaussian_tool.cc.

TH1F reco_tool::PeakFitterGaussian::fHistogram

mutableprivate

Definition at line 84 of file PeakFitterGaussian_tool.cc.

double reco_tool::PeakFitterGaussian::fMaxWidthMult

private

multiplier for max width for gaussian fit

Definition at line 77 of file PeakFitterGaussian_tool.cc.

double reco_tool::PeakFitterGaussian::fMinWidth

private

minimum initial width for gaussian fit

Definition at line 76 of file PeakFitterGaussian_tool.cc.

double reco_tool::PeakFitterGaussian::fPeakRange

private

set range limits for peak center

Definition at line 78 of file PeakFitterGaussian_tool.cc.

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:

/cvmfs/larsoft.opensciencegrid.org/products/larreco/v07_10_02/source/larreco/HitFinder/HitFinderTools/PeakFitterGaussian_tool.cc

Public Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation