Jpp 19.3.0-rc.1
the software that should make you happy
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | List of all members
JAANET::JDiffuseFlux Struct Reference

Low-level interface for diffuse fluxes. More...

#include <JDiffuseFlux.hh>

Inheritance diagram for JAANET::JDiffuseFlux:
JAANET::JFlux JAANET::JEvtWeightFactor JLANG::JClonable< JClonable_t, JDerived_t >

Public Types

typedef JClonable< JClonable_t >::clone_type clone_type
 

Public Member Functions

virtual ~JDiffuseFlux ()
 Virtual destructor.
 
double getFactor (const Evt &evt) const override
 Get diffuse flux for given event.
 
double getFactor (const int type, const double log10E, const double costh) const
 Get diffuse flux for given particle PDG-identifier, energy and zenith-angle.
 
double getFlux (const int type, const double log10E, const double costh) const
 Get diffuse flux for given particle PDG-identifier, energy and zenith-angle.
 
double operator() (const int type, const double log10E, const double costh) const
 Get diffuse flux for given particle PDG-identifier, energy and zenith-angle.
 
void Print () const override
 Print flux information.
 
double getFlux (const Evt &evt) const
 Get flux of given event.
 
double operator() (const Evt &evt) const
 Get event-weight factor of given event.
 
virtual bool is_valid () const
 Check whether this event-weight factor is valid.
 
void check_validity () const
 Check validity of this event-weight factor.
 
virtual JProperties getProperties (const JEquationParameters &eqpars=JEvtWeightFactor::getEquationParameters())
 Get properties of this class.
 
virtual JProperties getProperties (const JEquationParameters &eqpars=JEvtWeightFactor::getEquationParameters()) const
 Get properties of this class.
 
virtual std::istream & read (std::istream &in)
 Read event-weight factor from input.
 
virtual std::ostream & write (std::ostream &out) const
 Write event-weight factor to output.
 
virtual clone_type clone () const override
 Get clone of this object.
 

Static Public Member Functions

static const char *const getTypeKey ()
 Get type keyword.
 
static JEquationParameters & getEquationParameters ()
 Get equation parameters.
 
static void setEquationParameters (const JEquationParameters &eqpars)
 Set equation parameters.
 

Detailed Description

Low-level interface for diffuse fluxes.

Definition at line 27 of file JDiffuseFlux.hh.

Member Typedef Documentation

◆ clone_type

template<class JClonable_t , class JDerived_t >
JClonable<JClonable_t>::clone_type JLANG::JClonable< JClonable_t, JDerived_t >::clone_type
inherited

Definition at line 61 of file JClonable.hh.

Constructor & Destructor Documentation

◆ ~JDiffuseFlux()

virtual JAANET::JDiffuseFlux::~JDiffuseFlux ( )
inlinevirtual

Virtual destructor.

Definition at line 36 of file JDiffuseFlux.hh.

37 {}

Member Function Documentation

◆ getFactor() [1/2]

double JAANET::JDiffuseFlux::getFactor ( const Evt & evt) const
inlineoverridevirtual

Get diffuse flux for given event.

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

Implements JAANET::JEvtWeightFactor.

Definition at line 46 of file JDiffuseFlux.hh.

47 {
48 const Trk& neutrino = get_neutrino(evt);
49 const double log10E = log10(neutrino.E);
50 const double costh = neutrino.dir.z;
51
52 return dNdEdOmega(neutrino.type, log10E, costh);
53 }
JAANET::get_neutrino
const Trk & get_neutrino(const Evt &evt)
Get incoming neutrino.
Definition JAAnetToolkit.hh:513
Trk
The Trk class represents a Monte Carlo (MC) particle as well as a reconstructed track/shower.
Definition Trk.hh:15
Trk::type
int type
MC: particle type in PDG encoding.
Definition Trk.hh:24
Trk::dir
Vec dir
track direction
Definition Trk.hh:18
Trk::E
double E
Energy [GeV] (either MC truth or reconstructed)
Definition Trk.hh:20
Vec::z
double z
Definition Vec.hh:14

◆ getFactor() [2/2]

double JAANET::JDiffuseFlux::getFactor ( const int type,
const double log10E,
const double costh ) const
inline

Get diffuse flux for given particle PDG-identifier, energy and zenith-angle.

Parameters
typePDG particle type
log10Elogarithmic neutrino energy [GeV]
costhcosine zenith angle
Returns
diffuse flux [GeV^-1 * m^-2 * sr^-1 * s^-1]

Definition at line 64 of file JDiffuseFlux.hh.

67 {
68 return dNdEdOmega(type, log10E, costh);
69 }

◆ getFlux() [1/2]

double JAANET::JDiffuseFlux::getFlux ( const int type,
const double log10E,
const double costh ) const
inline

Get diffuse flux for given particle PDG-identifier, energy and zenith-angle.

Parameters
typePDG particle type
log10Elogarithmic neutrino energy [GeV]
costhcosine zenith angle
Returns
diffuse flux [GeV^-1 * m^-2 * sr^-1 * s^-1]

Definition at line 80 of file JDiffuseFlux.hh.

83 {
84 return dNdEdOmega(type, log10E, costh);
85 }

◆ operator()() [1/2]

double JAANET::JDiffuseFlux::operator() ( const int type,
const double log10E,
const double costh ) const
inline

Get diffuse flux for given particle PDG-identifier, energy and zenith-angle.

Parameters
typePDG particle type
log10Elogarithmic neutrino energy [GeV]
costhcosine zenith angle
Returns
diffuse flux [GeV^-1 * m^-2 * sr^-1 * s^-1]

Definition at line 96 of file JDiffuseFlux.hh.

99 {
100 return dNdEdOmega(type, log10E, costh);
101 }

◆ Print()

void JAANET::JDiffuseFlux::Print ( ) const
inlineoverride

Print flux information.

Definition at line 107 of file JDiffuseFlux.hh.

108 {
109 prnt(std::cout);
110 }

◆ getFlux() [2/2]

double JAANET::JFlux::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 37 of file JFlux.hh.

38 {
39 return getFactor(evt);
40 }
JAANET::JDiffuseFlux::getFactor
double getFactor(const Evt &evt) const override
Get diffuse flux for given event.
Definition JDiffuseFlux.hh:46

◆ getTypeKey()

static const char *const JAANET::JEvtWeightFactor::getTypeKey ( )
inlinestaticinherited

Get type keyword.

Returns
type keyword

Definition at line 45 of file JEvtWeightFactor.hh.

46 {
47 return "type";
48 }

◆ operator()() [2/2]

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

Get event-weight factor of given event.

Parameters
evtevent
Returns
event-weight factor

Definition at line 66 of file JEvtWeightFactor.hh.

67 {
68 return getFactor(evt);
69 }
JAANET::JEvtWeightFactor::getFactor
virtual double getFactor(const Evt &evt) const =0
Get event-weight factor of given event.

◆ is_valid()

virtual bool JAANET::JEvtWeightFactor::is_valid ( ) const
inlinevirtualinherited

Check whether this event-weight factor is valid.

Returns
true if valid; else false

Reimplemented in JAANET::JEvtWeightFactorTFormula.

Definition at line 77 of file JEvtWeightFactor.hh.

78 {
79 return true;
80 }

◆ check_validity()

void JAANET::JEvtWeightFactor::check_validity ( ) const
inlineinherited

Check validity of this event-weight factor.

Definition at line 86 of file JEvtWeightFactor.hh.

87 {
88 using namespace JPP;
89
90 if (!is_valid()) {
91 THROW(JValueOutOfRange, "JEvtWeightFactor:check_validity(): Invalid event-weight factor " << *this);
92 }
93 }
THROW
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition JException.hh:712
JLANG::JValueOutOfRange
Exception for accessing a value in a collection that is outside of its range.
Definition JException.hh:180
JPP
This name space includes all other name spaces (except KM3NETDAQ, KM3NET and ANTARES).
Definition JAAnetToolkit.hh:43
JAANET::JEvtWeightFactor::is_valid
virtual bool is_valid() const
Check whether this event-weight factor is valid.
Definition JEvtWeightFactor.hh:77

◆ getEquationParameters()

static JEquationParameters & JAANET::JEvtWeightFactor::getEquationParameters ( )
inlinestaticinherited

Get equation parameters.

Returns
equation parameters

Definition at line 101 of file JEvtWeightFactor.hh.

102 {
103 static JEquationParameters equation("=", ",\n\r,", "./", "#");
104
105 return equation;
106 }
JLANG::JEquationParameters
Simple data structure to support I/O of equations (see class JLANG::JEquation).
Definition JEquationParameters.hh:20

◆ setEquationParameters()

static void JAANET::JEvtWeightFactor::setEquationParameters ( const JEquationParameters & eqpars)
inlinestaticinherited

Set equation parameters.

Parameters
eqparsequation parameters

Definition at line 114 of file JEvtWeightFactor.hh.

115 {
116 getEquationParameters() = eqpars;
117 }
JAANET::JEvtWeightFactor::getEquationParameters
static JEquationParameters & getEquationParameters()
Get equation parameters.
Definition JEvtWeightFactor.hh:101

◆ getProperties() [1/2]

virtual JProperties JAANET::JEvtWeightFactor::getProperties ( const JEquationParameters & eqpars = JEvtWeightFactor::getEquationParameters())
inlinevirtualinherited

Get properties of this class.

Parameters
eqparsequation parameters

Reimplemented in JAANET::JEvtWeightFactorTFormula.

Definition at line 125 of file JEvtWeightFactor.hh.

126 {
127 return JProperties(eqpars,1);
128 }
JEEP::JProperties
Utility class to parse parameter values.
Definition JProperties.hh:501

◆ getProperties() [2/2]

virtual JProperties JAANET::JEvtWeightFactor::getProperties ( const JEquationParameters & eqpars = JEvtWeightFactor::getEquationParameters()) const
inlinevirtualinherited

Get properties of this class.

Parameters
eqparsequation parameters

Reimplemented in JAANET::JEvtWeightFactorTFormula.

Definition at line 136 of file JEvtWeightFactor.hh.

137 {
138 return JProperties(eqpars,1);
139 }

◆ read()

virtual std::istream & JAANET::JEvtWeightFactor::read ( std::istream & in)
inlinevirtualinherited

Read event-weight factor from input.

Parameters
ininput stream
Returns
input stream

Reimplemented in JAANET::JEvtWeightFactorTFormula.

Definition at line 148 of file JEvtWeightFactor.hh.

149 {
150 using namespace std;
151 using namespace JPP;
152
153 JStringStream is(in);
154
155 if (getFileStatus(is.str().c_str())) {
156 is.load();
157 }
158
159 JProperties properties = getProperties();
160 is >> properties;
161
162 check_validity();
163
164 return in;
165 }
JLANG::JStringStream
Wrapper class around STL stringstream class to facilitate optional loading of data from file.
Definition JStringStream.hh:25
JAANET::JEvtWeightFactor::getProperties
virtual JProperties getProperties(const JEquationParameters &eqpars=JEvtWeightFactor::getEquationParameters())
Get properties of this class.
Definition JEvtWeightFactor.hh:125
JAANET::JEvtWeightFactor::check_validity
void check_validity() const
Check validity of this event-weight factor.
Definition JEvtWeightFactor.hh:86

◆ write()

virtual std::ostream & JAANET::JEvtWeightFactor::write ( std::ostream & out) const
inlinevirtualinherited

Write event-weight factor to output.

Parameters
outoutput stream
Returns
output stream

Definition at line 174 of file JEvtWeightFactor.hh.

175 {
176 return out << getProperties();
177 }

◆ clone()

template<class JClonable_t , class JDerived_t >
virtual clone_type JLANG::JClonable< JClonable_t, JDerived_t >::clone ( ) const
inlineoverridevirtualinherited

Get clone of this object.

Returns
pointer to newly created object

Reimplemented in JPHYSICS::JPD0Transformer_t< JArgument_t >, JPHYSICS::JPDFTransformer< 2, JArgument_t >, JPHYSICS::JPDFTransformer< 3, JArgument_t >, JPHYSICS::JPDFTransformer< 4, JArgument_t >, JPHYSICS::JPDFTransformer< 5, JArgument_t >, JPHYSICS::JPDFTransformer_t< JArgument_t >, JPHYSICS::JPDGTransformer_t< JArgument_t >, and JTOOLS::JMultiMapTransformer< N, JArgument_t >::JMultiMapDefaultTransformer.

Definition at line 69 of file JClonable.hh.

70 {
71 return new JDerived_t(static_cast<const JDerived_t&>(*this));
72 }
The documentation for this struct was generated from the following file:
Generated by doxygen 1.12.0