Helper class for diffuse flux factor.
More...
#include <JDiffuseFluxHelper.hh>
Helper class for diffuse flux factor.
Definition at line 24 of file JDiffuseFluxHelper.hh.
◆ pointer_type
◆ JDiffuseFluxHelper() [1/3]
JAANET::JDiffuseFluxHelper::JDiffuseFluxHelper |
( |
| ) |
|
|
inline |
◆ JDiffuseFluxHelper() [2/3]
JAANET::JDiffuseFluxHelper::JDiffuseFluxHelper |
( |
const pointer_type & |
flux | ) |
|
|
inline |
◆ JDiffuseFluxHelper() [3/3]
JAANET::JDiffuseFluxHelper::JDiffuseFluxHelper |
( |
const JDiffuseFlux & |
flux | ) |
|
|
inline |
Constructor.
- Parameters
-
Definition at line 52 of file JDiffuseFluxHelper.hh.
void configure(const pointer_type &p)
Configure event-weight factor.
◆ getDiffuseFlux()
JDiffuseFlux& JAANET::JDiffuseFluxHelper::getDiffuseFlux |
( |
| ) |
const |
|
inline |
Get reference to diffuse flux function.
- Returns
- reference to diffuse flux function.
Definition at line 63 of file JDiffuseFluxHelper.hh.
74 THROW(
JNullPointerException,
"JDiffuseFluxHelper::getDiffuseFlux(): Cannot convert event-weight factor to diffuse flux function.");
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Exception for null pointer operation.
This name space includes all other name spaces (except KM3NETDAQ, KM3NET and ANTARES).
Low-level interface for diffuse fluxes.
JEvtWeightFactor & getFactor() const
Get reference to event-weight factor.
Abstract base class for specifiable event-weight factors.
◆ getFactor() [1/3]
double JAANET::JDiffuseFluxHelper::getFactor |
( |
const int |
type, |
|
|
const double |
log10E, |
|
|
const double |
costh |
|
) |
| const |
|
inline |
Get flux for given particle PDG-identifier, energy and zenith-angle.
- Parameters
-
type | PDG particle type |
log10E | logarithmic neutrino energy [GeV] |
costh | cosine zenith angle |
- Returns
- diffuse flux [GeV^-1 * m^-2 * sr^-1 * s^-1]
Definition at line 87 of file JDiffuseFluxHelper.hh.
93 return flux(type, log10E, costh);
JDiffuseFlux & getDiffuseFlux() const
Get reference to diffuse flux function.
◆ getFlux() [1/3]
double JAANET::JDiffuseFluxHelper::getFlux |
( |
const int |
type, |
|
|
const double |
log10E, |
|
|
const double |
costh |
|
) |
| const |
|
inline |
Get flux for given particle PDG-identifier, energy and zenith-angle.
- Parameters
-
type | PDG particle type |
log10E | logarithmic neutrino energy [GeV] |
costh | cosine zenith angle |
- Returns
- diffuse flux [GeV^-1 * m^-2 * sr^-1 * s^-1]
Definition at line 105 of file JDiffuseFluxHelper.hh.
◆ operator()() [1/2]
double JAANET::JDiffuseFluxHelper::operator() |
( |
const int |
type, |
|
|
const double |
log10E, |
|
|
const double |
costh |
|
) |
| const |
|
inline |
Get flux for given particle PDG-identifier, energy and zenith-angle.
- Parameters
-
type | PDG particle type |
log10E | logarithmic neutrino energy [GeV] |
costh | cosine zenith angle |
- Returns
- diffuse flux [GeV^-1 * m^-2 * sr^-1 * s^-1]
Definition at line 121 of file JDiffuseFluxHelper.hh.
◆ getFlux() [2/3]
JFlux& JAANET::JFluxHelper::getFlux |
( |
| ) |
const |
|
inlineinherited |
Get reference to flux function.
- Returns
- reference to flux function
Definition at line 62 of file JFluxHelper.hh.
Low-level interface for retrieving the flux corresponding to a given event.
◆ getFlux() [3/3]
double JAANET::JFluxHelper::getFlux |
( |
const Evt & |
evt | ) |
const |
|
inlineinherited |
Get flux of given event.
- Parameters
-
- Returns
- flux [GeV^-1 * m^-2 * sr^-1 * s^-1]
Definition at line 84 of file JFluxHelper.hh.
◆ configure() [1/2]
void JAANET::JEvtWeightFactorHelper::configure |
( |
const pointer_type & |
p | ) |
|
|
inlineinherited |
Configure event-weight factor.
- Parameters
-
p | pointer to event-weight factor |
Definition at line 68 of file JEvtWeightFactorHelper.hh.
std::shared_ptr< JEvtWeightFactor > pointer_type
◆ configure() [2/2]
void JAANET::JEvtWeightFactorHelper::configure |
( |
const JEvtWeightFactor & |
factor | ) |
|
|
inlineinherited |
Configure event-weight factor.
- Parameters
-
factor | event-weight factor |
Definition at line 79 of file JEvtWeightFactorHelper.hh.
virtual clone_type clone() const override
Get clone of this object.
◆ getFactor() [2/3]
Get reference to event-weight factor.
- Returns
- reference to event-weight factor
Definition at line 98 of file JEvtWeightFactorHelper.hh.
103 return *(this->get());
Helper class for event-weight factor.
◆ getFactor() [3/3]
double JAANET::JEvtWeightFactorHelper::getFactor |
( |
const Evt & |
evt | ) |
const |
|
inlineinherited |
Get weight-factor of given event.
- Parameters
-
- Returns
- event-weight factor
Definition at line 129 of file JEvtWeightFactorHelper.hh.
virtual double getFactor(const Evt &evt) const =0
Get event-weight factor of given event.
◆ is_valid()
bool JAANET::JEvtWeightFactorHelper::is_valid |
( |
| ) |
const |
|
inlineinherited |
Check whether this event-weight factor is valid.
- Returns
- true if valid; else false
Definition at line 115 of file JEvtWeightFactorHelper.hh.
119 return (helper && helper->
is_valid());
bool is_valid() const
Check whether this event-weight factor is valid.
◆ operator()() [2/2]
double JAANET::JEvtWeightFactorHelper::operator() |
( |
const Evt & |
evt | ) |
const |
|
inlineinherited |
◆ getProperties() [1/2]
Get properties of this class.
- Parameters
-
eqpars | equation parameters |
Definition at line 154 of file JEvtWeightFactorHelper.hh.
virtual JProperties getProperties(const JEquationParameters &eqpars=JEvtWeightFactor::getEquationParameters())
Get properties of this class.
◆ getProperties() [2/2]
The documentation for this struct was generated from the following file: