Jpp  19.1.0
the software that should make you happy
Public Types | Public Member Functions | List of all members
JAANET::JFluxHelper Struct Reference

Helper class for flux function. More...

#include <JFluxHelper.hh>

Inheritance diagram for JAANET::JFluxHelper:
JAANET::JEvtWeightFactorHelper JAANET::JDiffuseFluxHelper JAANET::JEvtWeightCorsika JAANET::JEvtWeightGSeaGen JAANET::JEvtWeightGenhen JAANET::JEvtWeightKM3BUU

Public Types

typedef JEvtWeightFactorHelper::pointer_type pointer_type
 

Public Member Functions

 JFluxHelper ()
 Default constructor. More...
 
 JFluxHelper (const pointer_type &flux)
 Constructor. More...
 
 JFluxHelper (const JFlux &flux)
 Constructor. More...
 
JFlux & getFlux () const
 Get reference to flux function. More...
 
double getFlux (const Evt &evt) const
 Get flux of given event. More...
 
void configure (const pointer_type &p)
 Configure event-weight factor. More...
 
void configure (const JEvtWeightFactor &factor)
 Configure event-weight factor. More...
 
JEvtWeightFactor & getFactor () const
 Get reference to event-weight factor. More...
 
double getFactor (const Evt &evt) const
 Get weight-factor of given event. More...
 
bool is_valid () const
 Check whether this event-weight factor is valid. More...
 
double operator() (const Evt &evt) const
 Get weight-factor of given event. More...
 
JProperties getProperties (const JEquationParameters &eqpars=JEvtWeightFactor::getEquationParameters())
 Get properties of this class. More...
 
JProperties getProperties (const JEquationParameters &eqpars=JEvtWeightFactor::getEquationParameters()) const
 Get properties of this class. More...
 

Detailed Description

Helper class for flux function.

Definition at line 23 of file JFluxHelper.hh.

Member Typedef Documentation

◆ pointer_type

typedef JEvtWeightFactorHelper::pointer_type JAANET::JFluxHelper::pointer_type

Definition at line 26 of file JFluxHelper.hh.

Constructor & Destructor Documentation

◆ JFluxHelper() [1/3]

JAANET::JFluxHelper::JFluxHelper ( )
inline

Default constructor.

Definition at line 32 of file JFluxHelper.hh.

33  {}

◆ JFluxHelper() [2/3]

JAANET::JFluxHelper::JFluxHelper ( const pointer_type &  flux)
inline

Constructor.

Parameters
fluxflux function

Definition at line 41 of file JFluxHelper.hh.

41  :
42  JEvtWeightFactorHelper(flux)
43  {}
JAANET::JEvtWeightFactorHelper::JEvtWeightFactorHelper
JEvtWeightFactorHelper()
Default constructor.
Definition: JEvtWeightFactorHelper.hh:37
JAANET::flux
Neutrino flux.
Definition: JHead.hh:906

◆ JFluxHelper() [3/3]

JAANET::JFluxHelper::JFluxHelper ( const JFlux &  flux)
inline

Constructor.

Parameters
fluxflux function

Definition at line 51 of file JFluxHelper.hh.

52  {
53  configure(flux);
54  }
JAANET::JEvtWeightFactorHelper::configure
void configure(const pointer_type &p)
Configure event-weight factor.
Definition: JEvtWeightFactorHelper.hh:68

Member Function Documentation

◆ getFlux() [1/2]

JFlux& JAANET::JFluxHelper::getFlux ( ) const
inline

Get reference to flux function.

Returns
reference to flux function

Definition at line 62 of file JFluxHelper.hh.

63  {
64  using namespace JPP;
65 
66  JEvtWeightFactor& factor = this->getFactor();
67 
68  JFlux* p = dynamic_cast<JFlux*>(&factor);
69 
70  if (p != NULL) {
71  return *p;
72  } else {
73  THROW(JNullPointerException, "JFluxHelper::getFlux(): Cannot convert event-weight factor to flux function.");
74  }
75  }
THROW
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:712
JLANG::JNullPointerException
Exception for null pointer operation.
Definition: JException.hh:234
JPP
This name space includes all other name spaces (except KM3NETDAQ, KM3NET and ANTARES).
Definition: JAAnetToolkit.hh:43
JAANET::JEvtWeightFactorHelper::getFactor
JEvtWeightFactor & getFactor() const
Get reference to event-weight factor.
Definition: JEvtWeightFactorHelper.hh:98
JAANET::JEvtWeightFactor
Abstract base class for specifiable event-weight factors.
Definition: JEvtWeightFactor.hh:32
JAANET::JFlux
Low-level interface for retrieving the flux corresponding to a given event.
Definition: JFlux.hh:23

◆ getFlux() [2/2]

double JAANET::JFluxHelper::getFlux ( const Evt &  evt) const
inline

Get flux of given event.

Parameters
evtevent
Returns
flux [GeV^-1 * m^-2 * sr^-1 * s^-1]

Definition at line 84 of file JFluxHelper.hh.

85  {
86  return getFactor(evt);
87  }

◆ configure() [1/2]

void JAANET::JEvtWeightFactorHelper::configure ( const pointer_type &  p)
inlineinherited

Configure event-weight factor.

Parameters
ppointer to event-weight factor

Definition at line 68 of file JEvtWeightFactorHelper.hh.

69  {
70  static_cast<pointer_type&>(*this) = p;
71  }
JAANET::JEvtWeightFactorHelper::pointer_type
std::shared_ptr< JEvtWeightFactor > pointer_type
Definition: JEvtWeightFactorHelper.hh:31

◆ configure() [2/2]

void JAANET::JEvtWeightFactorHelper::configure ( const JEvtWeightFactor &  factor)
inlineinherited

Configure event-weight factor.

Parameters
factorevent-weight factor

Definition at line 79 of file JEvtWeightFactorHelper.hh.

80  {
81  using namespace JPP;
82 
83  JEvtWeightFactor* p = dynamic_cast<JEvtWeightFactor*>(factor.clone());
84 
85  if (p != NULL) {
86  this->reset(p);
87  } else {
88  THROW(JNullPointerException, "JEvtWeightFactorHelper::configure(): Could not retrieve event-weight factor interface.");
89  }
90  }
JTOOLS::reset
void reset(T &value)
Reset value.
Definition: JToolsToolkit.hh:219
JLANG::JClonable::clone
virtual clone_type clone() const override
Get clone of this object.
Definition: JClonable.hh:69

◆ getFactor() [1/2]

JEvtWeightFactor& JAANET::JEvtWeightFactorHelper::getFactor ( ) const
inlineinherited

Get reference to event-weight factor.

Returns
reference to event-weight factor

Definition at line 98 of file JEvtWeightFactorHelper.hh.

99  {
100  using namespace JPP;
101 
102  if (static_cast<const JEvtWeightFactorHelper&>(*this)) {
103  return *(this->get());
104  } else {
105  THROW(JNullPointerException, "JEvtWeightFactorHelper::getFactor(): Event-weight factor is not set.");
106  }
107  }
JAANET::JEvtWeightFactorHelper
Helper class for event-weight factor.
Definition: JEvtWeightFactorHelper.hh:30

◆ getFactor() [2/2]

double JAANET::JEvtWeightFactorHelper::getFactor ( const Evt &  evt) const
inlineinherited

Get weight-factor of given event.

Parameters
evtevent
Returns
event-weight factor

Definition at line 129 of file JEvtWeightFactorHelper.hh.

130  {
131  const JEvtWeightFactor& weightFactor = getFactor();
132 
133  return weightFactor.getFactor(evt);
134  }
JAANET::JEvtWeightFactor::getFactor
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.

116  {
117  const JEvtWeightFactorHelper& helper = static_cast<const JEvtWeightFactorHelper&>(*this);
118 
119  return (helper && helper->is_valid());
120  }
JAANET::JEvtWeightFactorHelper::is_valid
bool is_valid() const
Check whether this event-weight factor is valid.
Definition: JEvtWeightFactorHelper.hh:115

◆ operator()()

double JAANET::JEvtWeightFactorHelper::operator() ( const Evt &  evt) const
inlineinherited

Get weight-factor of given event.

Parameters
evtevent
Returns
event-weight factor

Definition at line 143 of file JEvtWeightFactorHelper.hh.

144  {
145  return getFactor(evt);
146  }

◆ getProperties() [1/2]

JProperties JAANET::JEvtWeightFactorHelper::getProperties ( const JEquationParameters &  eqpars = JEvtWeightFactor::getEquationParameters())
inlineinherited

Get properties of this class.

Parameters
eqparsequation parameters

Definition at line 154 of file JEvtWeightFactorHelper.hh.

155  {
156  const JEvtWeightFactor& weightFactor = getFactor();
157 
158  return weightFactor.getProperties(eqpars);
159  }
JAANET::JEvtWeightFactor::getProperties
virtual JProperties getProperties(const JEquationParameters &eqpars=JEvtWeightFactor::getEquationParameters())
Get properties of this class.
Definition: JEvtWeightFactor.hh:125

◆ getProperties() [2/2]

JProperties JAANET::JEvtWeightFactorHelper::getProperties ( const JEquationParameters &  eqpars = JEvtWeightFactor::getEquationParameters()) const
inlineinherited

Get properties of this class.

Parameters
eqparsequation parameters

Definition at line 167 of file JEvtWeightFactorHelper.hh.

168  {
169  const JEvtWeightFactor& weightFactor = getFactor();
170 
171  return weightFactor.getProperties(eqpars);
172  }
The documentation for this struct was generated from the following file:
Generated by doxygen 1.9.1