hit::RFFHitFitter Class Reference

#include "RFFHitFitter.h"

Public Member Functions
	RFFHitFitter (float, unsigned int, float, float step=0.1, float max=5.0)
	RFFHitFitter (float step=0.1, float max=5.0)
void	SetFitterParams (float, unsigned int, float)
void	RunFitter (const std::vector< float > &signal)
const std::vector< float > &	MeanVector ()
const std::vector< float > &	SigmaVector ()
const std::vector< float > &	MeanErrorVector ()
const std::vector< float > &	SigmaErrorVector ()
const std::vector< float > &	AmplitudeVector ()
const std::vector< float > &	AmplitudeErrorVector ()
unsigned int	NHits ()
void	ClearResults ()
void	PrintResults ()

Private Types
typedef std::pair< float, float >	MeanSigmaPair

Private Member Functions
void	CalculateAllMeansAndSigmas (const std::vector< float > &signal)
void	CalculateMergedMeansAndSigmas (std::size_t signal_size)
void	CalculateAmplitudes (const std::vector< float > &signal)
void	CreateMergeVector ()
bool	HitsBelowThreshold ()

Private Attributes
float	fMeanMatchThreshold
unsigned int	fMinMergeMultiplicity
float	fFinalAmpThreshold
util::GaussianEliminationAlg	fGEAlg
std::vector< float >	fMeanVector
std::vector< float >	fSigmaVector
std::vector< float >	fMeanErrorVector
std::vector< float >	fSigmaErrorVector
std::vector< float >	fAmpVector
std::vector< float >	fAmpErrorVector
std::multiset< MeanSigmaPair, SignalSetComp >	fSignalSet
std::vector< std::vector< std::multiset< MeanSigmaPair >::iterator > >	fMergeVector

Detailed Description

Definition at line 32 of file RFFHitFitter.h.

Member Typedef Documentation

typedef std::pair<float, float> hit::RFFHitFitter::MeanSigmaPair

private

Definition at line 34 of file RFFHitFitter.h.

Constructor & Destructor Documentation

hit::RFFHitFitter::RFFHitFitter	(	float	max_mean,
		unsigned int	min_multi,
		float	threshold,
		float	step = 0.1,
		float	max = 5.0
	)

Definition at line 22 of file RFFHitFitter.cxx.

References SetFitterParams().

  : fGEAlg(step, max)
{
  SetFitterParams(max_mean, min_multi, threshold);
}

hit::RFFHitFitter::RFFHitFitter	(	float	step = 0.1,
		float	max = 5.0
	)

Title: RFFHitFitter Class Author: Wes Ketchum (wketc.nosp@m.hum@.nosp@m.lanl..nosp@m.gov)

Description: Class that does the base RFF algorithm. RFF works by simplifiying a Gaussian fit by dividing a pulse by its derivative. for a Gaussian, the result is a line, with the slope and intercept related to the sigma and mean of the Gaussian.

Input: Signal (vector of floats) Output: Guassian means and sigmas

Definition at line 20 of file RFFHitFitter.cxx.

: fGEAlg(step, max) {}

Member Function Documentation

const std::vector<float>& hit::RFFHitFitter::AmplitudeErrorVector ( )

inline

Definition at line 49 of file RFFHitFitter.h.

Referenced by hit::RFFHitFinderAlg::EmplaceHit().

{ return fAmpErrorVector; }

const std::vector<float>& hit::RFFHitFitter::AmplitudeVector ( )

inline

Definition at line 48 of file RFFHitFitter.h.

Referenced by hit::RFFHitFinderAlg::EmplaceHit().

{ return fAmpVector; }

void hit::RFFHitFitter::CalculateAllMeansAndSigmas ( const std::vector< float > &  signal )

private

Definition at line 53 of file RFFHitFitter.cxx.

References fSignalSet, and pmtana::mean().

Referenced by RunFitter().

{
  if (signal.size() <= 2) return;

  float prev_dev = 0, this_dev = 0;
  ;
  float slope = 0;
  float sigma = 0;
  float intercept = 0;
  float mean = 0;

  for (size_t i_tick = 1; i_tick < signal.size() - 1; i_tick++) {
    this_dev = 0.5 * (signal[i_tick + 1] - signal[i_tick - 1]) / signal[i_tick];
    slope = this_dev - prev_dev;

    prev_dev = this_dev;

    if (slope >= 0) continue;

    sigma = std::sqrt(-1 / slope);
    intercept = 0.5 * (signal[i_tick + 1] - signal[i_tick - 1]) / signal[i_tick] - slope * i_tick;
    mean = -1 * intercept / slope;

    fSignalSet.insert(std::make_pair(mean, sigma));
  }
}

void hit::RFFHitFitter::CalculateAmplitudes ( const std::vector< float > &  signal )

private

Definition at line 138 of file RFFHitFitter.cxx.

References bin, fAmpErrorVector, fAmpVector, fFinalAmpThreshold, fGEAlg, fMeanErrorVector, fMeanVector, fSigmaErrorVector, fSigmaVector, HitsBelowThreshold(), and util::GaussianEliminationAlg::SolveEquations().

Referenced by RunFitter().

{
  std::vector<float> heightVector(fMeanVector.size());
  size_t bin = 0;

  for (size_t i = 0; i < fMeanVector.size(); i++) {
    if (fMeanVector[i] < 0)
      bin = 0;
    else if (fMeanVector[i] + 1 > signal.size())
      bin = signal.size() - 2;
    else
      bin = std::floor(fMeanVector[i]);

    if (bin >= signal.size() - 1)
      throw cet::exception("RFFHitFitter")
        << "Error in CalculatAmplitudes! bin is out of range!\n"
        << "\tFor element " << i << " bin is " << bin << "(" << fMeanVector[i] << ")"
        << " but size is " << signal.size() << ".\n";

    heightVector[i] = signal[bin] - (fMeanVector[i] - (float)bin) * (signal[bin] - signal[bin + 1]);
  }

  fAmpVector = fGEAlg.SolveEquations(fMeanVector, fSigmaVector, heightVector);

  while (HitsBelowThreshold()) {
    for (size_t i = 0; i < fAmpVector.size(); i++) {
      if (fAmpVector[i] < fFinalAmpThreshold) {
        fMeanVector.erase(fMeanVector.begin() + i);
        fMeanErrorVector.erase(fMeanErrorVector.begin() + i);
        fSigmaVector.erase(fSigmaVector.begin() + i);
        fSigmaErrorVector.erase(fSigmaErrorVector.begin() + i);
        fAmpVector.erase(fAmpVector.begin() + i);
        heightVector.erase(heightVector.begin() + i);
      }
    }
    fAmpVector = fGEAlg.SolveEquations(fMeanVector, fSigmaVector, heightVector);
  }

  fAmpErrorVector.resize(fAmpVector.size(), 0.0);
}

void hit::RFFHitFitter::CalculateMergedMeansAndSigmas ( std::size_t  signal_size )

private

Definition at line 96 of file RFFHitFitter.cxx.

References fMeanErrorVector, fMeanVector, fMergeVector, fMinMergeMultiplicity, fSigmaErrorVector, fSigmaVector, and util::size().

Referenced by RunFitter().

{
  fMeanVector.reserve(fMergeVector.size());
  fSigmaVector.reserve(fMergeVector.size());
  fMeanErrorVector.reserve(fMergeVector.size());
  fSigmaErrorVector.reserve(fMergeVector.size());

  for (size_t i_col = 0; i_col < fMergeVector.size(); i_col++) {
    if (fMergeVector[i_col].size() < fMinMergeMultiplicity) continue;

    fMeanVector.push_back(0.0);
    fSigmaVector.push_back(0.0);

    for (auto const& sigpair : fMergeVector[i_col]) {
      fMeanVector.back() += sigpair->first;
      fSigmaVector.back() += sigpair->second;
    }

    fMeanVector.back() /= fMergeVector[i_col].size();
    fSigmaVector.back() /= fMergeVector[i_col].size();

    if (fMeanVector.back() < 0 || fMeanVector.back() > signal_size - 1) {
      fMeanVector.pop_back();
      fSigmaVector.pop_back();
      continue;
    }

    fMeanErrorVector.push_back(0.0);
    fSigmaErrorVector.push_back(0.0);

    for (auto const& sigpair : fMergeVector[i_col]) {
      fMeanErrorVector.back() +=
        (sigpair->first - fMeanVector.back()) * (sigpair->first - fMeanVector.back());
      fSigmaErrorVector.back() +=
        (sigpair->second - fSigmaVector.back()) * (sigpair->second - fSigmaVector.back());
    }

    fMeanErrorVector.back() = std::sqrt(fMeanErrorVector.back()) / fMergeVector[i_col].size();
    fSigmaErrorVector.back() = std::sqrt(fSigmaErrorVector.back()) / fMergeVector[i_col].size();
  }
}

void hit::RFFHitFitter::ClearResults

(

)

Definition at line 186 of file RFFHitFitter.cxx.

References fAmpErrorVector, fAmpVector, fMeanErrorVector, fMeanVector, fMergeVector, fSigmaErrorVector, fSigmaVector, and fSignalSet.

Referenced by RunFitter(), and SetFitterParams().

{
  fMeanVector.clear();
  fSigmaVector.clear();
  fMeanErrorVector.clear();
  fSigmaErrorVector.clear();
  fAmpVector.clear();
  fAmpErrorVector.clear();
  fSignalSet.clear();
  fMergeVector.clear();
}

void hit::RFFHitFitter::CreateMergeVector ( )

private

Definition at line 80 of file RFFHitFitter.cxx.

References util::abs(), fMeanMatchThreshold, fMergeVector, fSignalSet, and lar::dump::vector().

Referenced by RunFitter().

{
  fMergeVector.clear();
  fMergeVector.reserve(fSignalSet.size());

  float prev_mean = -9e6;
  for (std::multiset<MeanSigmaPair>::iterator it = fSignalSet.begin(); it != fSignalSet.end();
       it++) {
    if (std::abs(it->first - prev_mean) > fMeanMatchThreshold || fMergeVector.size() == 0)
      fMergeVector.push_back(std::vector<std::multiset<MeanSigmaPair>::iterator>(1, it));
    else
      fMergeVector.back().push_back(it);
    prev_mean = it->first;
  }
}

bool hit::RFFHitFitter::HitsBelowThreshold ( )

private

Definition at line 179 of file RFFHitFitter.cxx.

References fAmpVector, and fFinalAmpThreshold.

Referenced by CalculateAmplitudes().

{
  for (auto const& amp : fAmpVector)
    if (amp < fFinalAmpThreshold) return true;
  return false;
}

const std::vector<float>& hit::RFFHitFitter::MeanErrorVector ( )

inline

Definition at line 46 of file RFFHitFitter.h.

Referenced by hit::RFFHitFinderAlg::EmplaceHit().

{ return fMeanErrorVector; }

const std::vector<float>& hit::RFFHitFitter::MeanVector ( )

inline

Definition at line 44 of file RFFHitFitter.h.

Referenced by hit::RFFHitFinderAlg::EmplaceHit().

{ return fMeanVector; }

unsigned int hit::RFFHitFitter::NHits ( )

inline

Definition at line 50 of file RFFHitFitter.h.

Referenced by hit::RFFHitFinderAlg::EmplaceHit(), and PrintResults().

{ return fMeanVector.size(); }

void hit::RFFHitFitter::PrintResults

(

)

Definition at line 198 of file RFFHitFitter.cxx.

References fAmpErrorVector, fAmpVector, fMeanErrorVector, fMeanVector, fSigmaErrorVector, fSigmaVector, fSignalSet, and NHits().

{
  std::cout << "InitialSignalSet" << std::endl;

  for (auto const& sigpair : fSignalSet)
    std::cout << "\t" << sigpair.first << " / " << sigpair.second << std::endl;

  std::cout << "\nNHits = " << NHits() << std::endl;
  std::cout << "\tMean / Sigma / Amp" << std::endl;
  for (size_t i = 0; i < NHits(); i++)
    std::cout << "\t" << fMeanVector[i] << " +- " << fMeanErrorVector[i] << " / " << fSigmaVector[i]
              << " +- " << fSigmaErrorVector[i] << " / " << fAmpVector[i] << " +- "
              << fAmpErrorVector[i] << std::endl;
}

void hit::RFFHitFitter::RunFitter

(

const std::vector< float > &

signal

)

Definition at line 44 of file RFFHitFitter.cxx.

References CalculateAllMeansAndSigmas(), CalculateAmplitudes(), CalculateMergedMeansAndSigmas(), ClearResults(), and CreateMergeVector().

Referenced by hit::RFFHitFinderAlg::Run().

{
  ClearResults();
  CalculateAllMeansAndSigmas(signal);
  CreateMergeVector();
  CalculateMergedMeansAndSigmas(signal.size());
  CalculateAmplitudes(signal);
}

void hit::RFFHitFitter::SetFitterParams	(	float	max_mean,
		unsigned int	min_multi,
		float	threshold
	)

Definition at line 32 of file RFFHitFitter.cxx.

References ClearResults(), fFinalAmpThreshold, fMeanMatchThreshold, and fMinMergeMultiplicity.

Referenced by RFFHitFitter(), and hit::RFFHitFinderAlg::SetFitterParams().

{
  fMeanMatchThreshold = max_mean;
  fMinMergeMultiplicity = min_multi;

  if (fMinMergeMultiplicity == 0) fMinMergeMultiplicity = 1;

  fFinalAmpThreshold = threshold;

  ClearResults();
}

const std::vector<float>& hit::RFFHitFitter::SigmaErrorVector ( )

inline

Definition at line 47 of file RFFHitFitter.h.

Referenced by hit::RFFHitFinderAlg::EmplaceHit().

{ return fSigmaErrorVector; }

const std::vector<float>& hit::RFFHitFitter::SigmaVector ( )

inline

Definition at line 45 of file RFFHitFitter.h.

Referenced by hit::RFFHitFinderAlg::EmplaceHit().

{ return fSigmaVector; }

Member Data Documentation

std::vector<float> hit::RFFHitFitter::fAmpErrorVector

private

Definition at line 71 of file RFFHitFitter.h.

Referenced by CalculateAmplitudes(), ClearResults(), and PrintResults().

std::vector<float> hit::RFFHitFitter::fAmpVector

private

Definition at line 70 of file RFFHitFitter.h.

Referenced by CalculateAmplitudes(), ClearResults(), HitsBelowThreshold(), and PrintResults().

float hit::RFFHitFitter::fFinalAmpThreshold

private

Definition at line 59 of file RFFHitFitter.h.

Referenced by CalculateAmplitudes(), HitsBelowThreshold(), and SetFitterParams().

util::GaussianEliminationAlg hit::RFFHitFitter::fGEAlg

private

Definition at line 64 of file RFFHitFitter.h.

Referenced by CalculateAmplitudes().

std::vector<float> hit::RFFHitFitter::fMeanErrorVector

private

Definition at line 68 of file RFFHitFitter.h.

Referenced by CalculateAmplitudes(), CalculateMergedMeansAndSigmas(), ClearResults(), and PrintResults().

float hit::RFFHitFitter::fMeanMatchThreshold

private

Definition at line 57 of file RFFHitFitter.h.

Referenced by CreateMergeVector(), and SetFitterParams().

std::vector<float> hit::RFFHitFitter::fMeanVector

private

Definition at line 66 of file RFFHitFitter.h.

Referenced by CalculateAmplitudes(), CalculateMergedMeansAndSigmas(), ClearResults(), and PrintResults().

std::vector<std::vector<std::multiset<MeanSigmaPair>::iterator> > hit::RFFHitFitter::fMergeVector

private

Definition at line 74 of file RFFHitFitter.h.

Referenced by CalculateMergedMeansAndSigmas(), ClearResults(), and CreateMergeVector().

unsigned int hit::RFFHitFitter::fMinMergeMultiplicity

private

Definition at line 58 of file RFFHitFitter.h.

Referenced by CalculateMergedMeansAndSigmas(), and SetFitterParams().

std::vector<float> hit::RFFHitFitter::fSigmaErrorVector

private

Definition at line 69 of file RFFHitFitter.h.

Referenced by CalculateAmplitudes(), CalculateMergedMeansAndSigmas(), ClearResults(), and PrintResults().

std::vector<float> hit::RFFHitFitter::fSigmaVector

private

Definition at line 67 of file RFFHitFitter.h.

Referenced by CalculateAmplitudes(), CalculateMergedMeansAndSigmas(), ClearResults(), and PrintResults().

std::multiset<MeanSigmaPair, SignalSetComp> hit::RFFHitFitter::fSignalSet

private

Definition at line 73 of file RFFHitFitter.h.

Referenced by CalculateAllMeansAndSigmas(), ClearResults(), CreateMergeVector(), and PrintResults().

---

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

• larreco/v09_25_00/source/larreco/HitFinder/RFFHitFitter.h
• larreco/v09_25_00/source/larreco/HitFinder/RFFHitFitter.cxx