calo::LinearEnergyAlg::RecombinationConfig Struct Reference

Configuration of parameters of the box model. More...

#include <LinearEnergyAlg.h>

Public Types
using	Name = fhicl::Name
using	Comment = fhicl::Comment

Public Member Functions
bool	modelIsBirks () const
bool	modelIsModBox () const
bool	modelIsConstant () const

Public Attributes
fhicl::Atom< std::string >	Model
fhicl::Atom< double >	A
fhicl::Atom< double >	B
fhicl::Atom< double >	A3t
fhicl::Atom< double >	k3t
fhicl::Atom< double >	factor

Detailed Description

Configuration of parameters of the box model.

Definition at line 98 of file LinearEnergyAlg.h.

Member Typedef Documentation

using calo::LinearEnergyAlg::RecombinationConfig::Comment = fhicl::Comment

Definition at line 101 of file LinearEnergyAlg.h.

using calo::LinearEnergyAlg::RecombinationConfig::Name = fhicl::Name

Definition at line 100 of file LinearEnergyAlg.h.

Member Function Documentation

bool calo::LinearEnergyAlg::RecombinationConfig::modelIsBirks ( ) const

inline

Definition at line 103 of file LinearEnergyAlg.h.

        { return Model() == ModelName::Birks; }

bool calo::LinearEnergyAlg::RecombinationConfig::modelIsConstant ( ) const

inline

Definition at line 107 of file LinearEnergyAlg.h.

        { return Model() == ModelName::Constant; }

bool calo::LinearEnergyAlg::RecombinationConfig::modelIsModBox ( ) const

inline

Definition at line 105 of file LinearEnergyAlg.h.

        { return Model() == ModelName::ModBox; }

Member Data Documentation

fhicl::Atom<double> calo::LinearEnergyAlg::RecombinationConfig::A

Initial value:

{
        Name("A"),
        Comment("Parameter \"A\" of box model."),
        fhicl::use_if(this, &RecombinationConfig::modelIsModBox),
        util::kModBoxA
        }

Definition at line 120 of file LinearEnergyAlg.h.

fhicl::Atom<double> calo::LinearEnergyAlg::RecombinationConfig::A3t

Initial value:

{
        Name("A3t"),
        Comment("Recombination parameter \"A\" of Birks model."),
        fhicl::use_if(this, &RecombinationConfig::modelIsBirks),
        util::kRecombA
        }

Definition at line 134 of file LinearEnergyAlg.h.

fhicl::Atom<double> calo::LinearEnergyAlg::RecombinationConfig::B

Initial value:

{
        Name("B"),
        Comment("Parameter \"B\" of box model [kV/cm*(g/cm^2)/MeV]."),
        fhicl::use_if(this, &RecombinationConfig::modelIsModBox),
        util::kModBoxB
        }

Definition at line 127 of file LinearEnergyAlg.h.

fhicl::Atom<double> calo::LinearEnergyAlg::RecombinationConfig::factor

Initial value:

{
        Name("factor"),
        Comment("Constant recombination factor for \"constant\" model."),
        fhicl::use_if(this, &RecombinationConfig::modelIsConstant)
        }

Definition at line 148 of file LinearEnergyAlg.h.

fhicl::Atom<double> calo::LinearEnergyAlg::RecombinationConfig::k3t

Initial value:

{
        Name("k3t"),
        Comment("Recombination parameter \"k\" of Birks model [kV/cm*(g/cm^2)/MeV]."),
        fhicl::use_if(this, &RecombinationConfig::modelIsBirks),
        util::kRecombk
        }

Definition at line 141 of file LinearEnergyAlg.h.

fhicl::Atom<std::string> calo::LinearEnergyAlg::RecombinationConfig::Model

Initial value:

{
        Name("Model"),
        Comment(std::string("Which recombination model to use: "
          + ModelName::ModBox + ", "
          + ModelName::Birks + ", "
          + ModelName::Constant + ".").c_str()
          )
        }

Definition at line 111 of file LinearEnergyAlg.h.

---

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

• larreco/larreco/Calorimetry/LinearEnergyAlg.h