hit::CompiledTruncatedGausFitCache< MaxGaus, CutOff > Class Template Reference

A set of TF1 linear sum of truncated Gaussians. More...

#include "GausFitCache.h"

Inheritance diagram for hit::CompiledTruncatedGausFitCache< MaxGaus, CutOff >:

Public Types
template<unsigned int NGaus, unsigned int CutOff>
using	NGaussTruncClass = FuncSum< NGaus, gaus_trunc< CutOff >, 3U >
	Class around sum of NGaus Gaussian functions truncated at CutOff sigmas. More...

Public Member Functions
	CompiledTruncatedGausFitCache (std::string new_name="CompiledTruncatedGausFitCache")
	Constructor: initializes all the functions. More...
virtual unsigned int	MaxGaussians () const
	Returns the maximum number of Gaussians in a function that we support. More...
constexpr unsigned int	StoredMaxGaussians () const
	Returns the maximum number of Gaussians in a function that we support. More...
virtual TF1 *	GetClone (size_t nGaus)
	Throws an exception (ROOT does not support cloning compiled functions) More...
template<>
Double_t	ngaus (Double_t const *, Double_t const *)
std::string	GetName () const
	Return the name of this cache. More...
virtual TF1 *	Get (size_t nFunc)
	Returns a function sum of nFunc base functions. More...
virtual std::string	FunctionName (size_t nFunc) const
	Returns a name for the function with nFunc base functions. More...

Static Public Member Functions
static Double_t	gaus (Double_t const *x, Double_t const *params)
	Single Gaussian function. More...
template<unsigned int CutOff>
static Double_t	gaus_trunc (Double_t const *x, Double_t const *params)
template<unsigned int NGaus>
static Double_t	ngaus (Double_t const *x, Double_t const *params)
template<unsigned int NGaus, unsigned int CutOff>
static Double_t	ngaus_trunc (Double_t const *x, Double_t const *params)
	Sum of NGaus Gaussian functions truncated at CutOff sigmas. More...

Protected Member Functions
virtual TF1 *	CreateFunction (size_t nGaus) const
	Throws an error, since this class can't create functions run-time. More...
template<unsigned int NGaus>
void	InitializeCompiledGausFitVector ()
	Returns a vector initialized with multigaussians. More...
template<>
void	InitializeCompiledGausFitVector ()
template<unsigned int NGaus>
void	AppendFunction ()
	Adds one function. More...
void	CannotCreateFunction (size_t nGaus) const
	Throws an error asserting compiled functions can't be cretead run-time. More...

Protected Attributes
std::string	name
	name of the cache More...
std::vector< TF1 * >	funcs

Private Types
template<unsigned int NGaus>
using	CutOffNGaussianClass = NGaussTruncClass< NGaus, CutOff >

Detailed Description

template<unsigned int MaxGaus = 10, unsigned int CutOff = 5>
class hit::CompiledTruncatedGausFitCache< MaxGaus, CutOff >

A set of TF1 linear sum of truncated Gaussians.

---

Template Parameters

MaxGaus	the maximum number of Gaussians in the stored functions
CutOff	number of sigmas beyond which the function evaluates as 0

This class stores a predefined number MaxGaus of TF1 from pre-compiled functions. Each function is the linear sum of truncated Gaussians, at most MaxGaus of them,

Definition at line 291 of file GausFitCache.h.

Member Typedef Documentation

template<unsigned int MaxGaus = 10, unsigned int CutOff = 5>

template<unsigned int NGaus>

using hit::CompiledTruncatedGausFitCache< MaxGaus, CutOff >::CutOffNGaussianClass = NGaussTruncClass<NGaus, CutOff>

private

Definition at line 293 of file GausFitCache.h.

template<unsigned int NGaus, unsigned int CutOff>

using hit::details::CompiledGausFitCacheBaseStruct::NGaussTruncClass = FuncSum<NGaus, gaus_trunc<CutOff>, 3U>

inherited

Class around sum of NGaus Gaussian functions truncated at CutOff sigmas.

Definition at line 206 of file GausFitCache.h.

Constructor & Destructor Documentation

template<unsigned int MaxGaus = 10, unsigned int CutOff = 5>

hit::CompiledTruncatedGausFitCache< MaxGaus, CutOff >::CompiledTruncatedGausFitCache ( std::string  new_name = "CompiledTruncatedGausFitCache< MaxGaus, CutOff >" )

inline

Constructor: initializes all the functions.

Definition at line 297 of file GausFitCache.h.

References trkf::fill().

      : details::CompiledGausFitCacheBaseStruct(new_name)
    {
      InitializeFuncSumVector<MaxGaus, CutOffNGaussianClass>::fill(*this);
    }

Member Function Documentation

template<unsigned int NGaus>

void hit::details::CompiledGausFitCacheBaseStruct::AppendFunction ( )

protectedinherited

Adds one function.

Definition at line 358 of file GausFitCache.h.

References hit::GausFitCache::funcs, and hit::GausFitCache::FunctionName().

    {
      // create a function in the ficticious range [ 0, 1 ]:
      funcs.push_back(new TF1(FunctionName(NGaus).c_str(), &ngaus<NGaus>, 0., 1., 3 * NGaus));
    } // CompiledGausFitCacheBaseStruct::AppendFunction()

void hit::details::CompiledGausFitCacheBaseStruct::CannotCreateFunction ( size_t  nGaus ) const

protectedinherited

Throws an error asserting compiled functions can't be cretead run-time.

Definition at line 104 of file GausFitCache.cxx.

References art::errors::LogicError, and hit::GausFitCache::name.

  {
    throw art::Exception(art::errors::LogicError)
      << name << " function cache can't create functions at run-time; " << nFunc
      << "-addend function was requested, but we have only functions with up to " << MaxGaussians()
      << " addends available\n";
  } // CompiledGausFitCache<>::CannotCreateFunction()

template<unsigned int MaxGaus = 10, unsigned int CutOff = 5>

virtual TF1* hit::CompiledTruncatedGausFitCache< MaxGaus, CutOff >::CreateFunction ( size_t  nGaus ) const

inlineprotectedvirtual

Throws an error, since this class can't create functions run-time.

Reimplemented from hit::GausFitCache.

Definition at line 310 of file GausFitCache.h.

{ CannotCreateFunction(nGaus); }

std::string hit::GausFitCache::FunctionName ( size_t  nFunc ) const

virtualinherited

Returns a name for the function with nFunc base functions.

Definition at line 83 of file GausFitCache.cxx.

References hit::GausFitCache::name.

Referenced by hit::details::CompiledGausFitCacheBaseStruct::AppendFunction(), reco_tool::BaselinedGausFitCache::CreateFunction(), hit::GausFitCache::CreateFunction(), hit::details::CompiledGausFitCacheBaseStruct::InitializeFuncSumVector< NFunc, Func >::fill(), hit::details::CompiledGausFitCacheBaseStruct::InitializeFuncSumVector< 0U, Func >::fill(), and hit::GausFitCache::GetName().

  {
    std::ostringstream sstr;
    sstr << name << "_" << nFunc;
    return sstr.str();
  } // GausFitCache::FunctionName()

Double_t hit::details::CompiledGausFitCacheBaseStruct::gaus ( Double_t const *  x, Double_t const *  params  )

staticinherited

Single Gaussian function.

Parameters

x	vector; [0] variable value
params	vector: [0] coefficient of the exponent [1] mean [2] sigma

Returns

the Gaussian evaluated at *x

This function is equivalent to ROOT's "gaus".

Definition at line 93 of file GausFitCache.cxx.

References sqr().

  {
    return params[0] * std::exp(-0.5 * sqr((x[0] - params[1]) / params[2]));
  } // details::CompiledGausFitCacheBaseStruct::gaus()

template<unsigned int CutOff>

Double_t hit::details::CompiledGausFitCacheBaseStruct::gaus_trunc ( Double_t const *  x, Double_t const *  params  )

staticinherited

Definition at line 365 of file GausFitCache.h.

References hit::details::sqr(), and z.

    {
      const Double_t z = (x[0] - params[1]) / params[2];
      return ((z > -((Double_t)CutOff)) && (z < (Double_t)CutOff)) ?
               params[0] * std::exp(-0.5 * sqr(z)) :
               0.;
    } // CompiledGausFitCacheBaseStruct::gaus_trunc()

TF1 * hit::GausFitCache::Get ( size_t  nFunc )

virtualinherited

Returns a function sum of nFunc base functions.

Parameters

nGaus

the number of base functions in the function

Returns

a pointer to a TF1 with the required characteristics

The returned function must not be deleted at any time!

This implementation returns a function sum of nFunc Gaussians. The parameters are sorted by Gaussian: first normalization (not the area, but the coefficient), first mean, first sigma, second normalization etc.

Definition at line 44 of file GausFitCache.cxx.

References hit::GausFitCache::CreateFunction(), and hit::GausFitCache::funcs.

Referenced by reco_tool::PeakFitterGaussian::findPeakParameters(), hit::GausFitCache::GetClone(), and hit::GausFitCache::GetName().

  {

    // expand the list if needed
    if (nFunc >= funcs.size()) funcs.resize(nFunc + 1, nullptr);

    // get the pointer we need...
    TF1*& pFunc = funcs[nFunc];

    if (!pFunc) pFunc = CreateFunction(nFunc);

    return pFunc;
  } // GausFitCache::Get()

TF1 * hit::details::CompiledGausFitCacheBaseStruct::GetClone ( size_t  nGaus )

virtualinherited

Throws an exception (ROOT does not support cloning compiled functions)

Reimplemented from hit::GausFitCache.

Definition at line 98 of file GausFitCache.cxx.

References art::errors::LogicError.

  {
    throw art::Exception(art::errors::LogicError)
      << "CompiledGausFitCacheBaseStruct: compiled functions can't be cloned";
  } // CompiledGausFitCacheBaseStruct::GetClone()

std::string hit::GausFitCache::GetName ( ) const

inlineinherited

Return the name of this cache.

Definition at line 54 of file GausFitCache.h.

References hit::GausFitCache::FunctionName(), hit::GausFitCache::Get(), hit::GausFitCache::GetClone(), and hit::GausFitCache::name.

{ return name; }

template<unsigned int NGaus>

void hit::details::CompiledGausFitCacheBaseStruct::InitializeCompiledGausFitVector ( )

protectedinherited

Returns a vector initialized with multigaussians.

Definition at line 345 of file GausFitCache.h.

    {
      if (NGaus > 0) InitializeCompiledGausFitVector<NGaus - 1>();
      AppendFunction<NGaus>();
    } // CompiledGausFitCacheBaseStruct::InitializeCompiledGausFitVector()

template<>

void hit::details::CompiledGausFitCacheBaseStruct::InitializeCompiledGausFitVector ( )

inlineprotectedinherited

Definition at line 352 of file GausFitCache.h.

    {
      AppendFunction<0>();
    }

template<unsigned int MaxGaus = 10, unsigned int CutOff = 5>

virtual unsigned int hit::CompiledTruncatedGausFitCache< MaxGaus, CutOff >::MaxGaussians ( ) const

inlinevirtual

Returns the maximum number of Gaussians in a function that we support.

Reimplemented from hit::details::CompiledGausFitCacheBaseStruct.

Definition at line 303 of file GausFitCache.h.

{ return StoredMaxGaussians(); }

template<unsigned int NGaus>

static Double_t hit::details::CompiledGausFitCacheBaseStruct::ngaus ( Double_t const *  x, Double_t const *  params  )

inlinestaticinherited

Definition at line 192 of file GausFitCache.h.

References x.

      {
        return gaus(x, params) + ngaus<NGaus - 1>(x, params + 3);
      }

template<>

Double_t hit::details::CompiledGausFitCacheBaseStruct::ngaus ( Double_t const *  , Double_t const *    )

inlineinherited

Definition at line 374 of file GausFitCache.h.

    {
      return 0.;
    }

template<unsigned int NGaus, unsigned int CutOff>

static Double_t hit::details::CompiledGausFitCacheBaseStruct::ngaus_trunc ( Double_t const *  x, Double_t const *  params  )

inlinestaticinherited

Sum of NGaus Gaussian functions truncated at CutOff sigmas.

Definition at line 199 of file GausFitCache.h.

      {
        return FuncSum<NGaus, gaus_trunc<CutOff>, 3U>::eval(x, params);
      }

template<unsigned int MaxGaus = 10, unsigned int CutOff = 5>

constexpr unsigned int hit::CompiledTruncatedGausFitCache< MaxGaus, CutOff >::StoredMaxGaussians ( ) const

inline

Returns the maximum number of Gaussians in a function that we support.

Definition at line 306 of file GausFitCache.h.

{ return MaxGaus; }

Member Data Documentation

std::vector<TF1*> hit::GausFitCache::funcs

protectedinherited

Definition at line 80 of file GausFitCache.h.

Referenced by hit::details::CompiledGausFitCacheBaseStruct::AppendFunction(), hit::details::CompiledGausFitCacheBaseStruct::InitializeFuncSumVector< NFunc, Func >::fill(), hit::details::CompiledGausFitCacheBaseStruct::InitializeFuncSumVector< 0U, Func >::fill(), hit::GausFitCache::Get(), hit::details::CompiledGausFitCacheBaseStruct::MaxGaussians(), and hit::GausFitCache::~GausFitCache().

std::string hit::GausFitCache::name

protectedinherited

name of the cache

Gaussian sum functions; n-th element is sum of n base functions

Definition at line 77 of file GausFitCache.h.

Referenced by hit::details::CompiledGausFitCacheBaseStruct::CannotCreateFunction(), hit::GausFitCache::FunctionName(), and hit::GausFitCache::GetName().

---

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

• larreco/v09_25_00/source/larreco/RecoAlg/GausFitCache.h