Implementation of atmospheric neutrino flux using official KM3NeT atmospheric flux function. More...

#include <JAtmosphericNeutrinoFlux.hh>

Inheritance diagram for JAANET::JAtmosphericNeutrinoFlux:

Public Types
typedef JClonable< JClonable_t > ::clone_type	clone_type

typedef JEvtWeightFactorHelper < JDiffuseFlux >	JDiffuseFluxHelper_t

typedef std::shared_ptr < JDiffuseFlux >	pointer_type

typedef JOscProbInterface::JOscParameters_t	JOscParameters_t

typedef JOscProbInterface::JParameter_t	JParameter_t

typedef JOscProbInterface::argument_type	argument_type

Public Member Functions
	JAtmosphericNeutrinoFlux ()
	Default constructor. More...

	JAtmosphericNeutrinoFlux (const JOscProbInterface &oscProbInterface)
	Constructor. More...

template<class JFunction_t >
	JAtmosphericNeutrinoFlux (const JOscProbFunction< JFunction_t > &oscProbFunction)
	Constructor. More...

template<class JOscProbFunction_t >
	JAtmosphericNeutrinoFlux (const JOscProbFunction_t &oscProbCalculator)
	Constructor. More...

double	operator() (const Evt &evt) const
	Get flux for given event. More...

bool	equals (const JOscFlux &object) const
	Check if this flux is equal to given flux. More...

double	getFactor (const Evt &evt) const override
	Get event-weight factor for given event. More...

double	getFactor (const int type, const double log10E, const double costh) const
	Get diffuse flux corresponding to given neutrino type, energy and zenith angle. More...

virtual clone_type	clone () const override
	Get clone of this object. More...

void	configure (const JDiffuseFlux &diffuseFlux)
	Configure oscillation probability function. More...

void	configure (const JOscProbInterface &oscProb)
	Configure oscillation probability function. More...

JDiffuseFlux &	getDiffuseFlux () const
	Get reference to diffuse flux factor. More...

JOscProbInterface &	getOscProbInterface () const
	Get reference to oscillation probability interface. More...

JOscParameters_t &	getParameters () const
	Get reference to oscillation parameters interface. More...

void	set (const JOscParameters_t &parameters) const
	Set oscillation parameters. More...

virtual void	set (const std::string &name, const argument_type &value) const
	Set value for a given oscillation parameter. More...

template<class... Args>
void	set (const std::string &name, const argument_type &value, const Args &...args) const
	Set value for given list of oscillation parameters. More...

double	getP (const JOscChannel &channel, const double energy, const double costh) const
	Get oscillation probability corresponding to given oscillation channel, neutrino energy and zenith angle. More...

double	getP (const JOscParameters_t &parameters, const JOscChannel &channel, const double energy, const double costh) const
	Get oscillation probability for a given set of oscillation parameters and a given oscillation channel. More...

double	getP (const std::string &name, const double value, const JOscChannel &channel, const double E, const double costh) const
	Get oscillation probability for a given oscillation parameter and a given oscillation channel. More...

template<class... Args>
double	getP (const std::string &name, const double value, const Args &...args) const
	Get oscillation probability for a given set of oscillation parameters and a given oscillation channel. More...

virtual double	getCosth (const double L) const
	Get cosine zenith angle for a given baseline. More...

virtual double	getBaseline (const double costh) const
	Get baseline for a given cosine zenith angle. More...

Detailed Description

Implementation of atmospheric neutrino flux using official KM3NeT atmospheric flux function.

Definition at line 33 of file JAtmosphericNeutrinoFlux.hh.

Member Typedef Documentation

template<class JClonable_t, class JDerived_t = JNullType>

typedef JClonable<JClonable_t>::clone_type JLANG::JClonable< JClonable_t, JDerived_t >::clone_type

inherited

Definition at line 61 of file JClonable.hh.

typedef JEvtWeightFactorHelper<JDiffuseFlux> JAANET::JEvtWeightFactorHelper< JDiffuseFlux >::JDiffuseFluxHelper_t

inherited

Definition at line 112 of file JEvtWeightFactorHelper.hh.

typedef std::shared_ptr<JDiffuseFlux> JAANET::JEvtWeightFactorHelper< JDiffuseFlux >::pointer_type

inherited

Definition at line 113 of file JEvtWeightFactorHelper.hh.

typedef JOscProbInterface::JOscParameters_t JOSCPROB::JOscProbHelper::JOscParameters_t

inherited

Definition at line 28 of file JOscProbHelper.hh.

typedef JOscProbInterface::JParameter_t JOSCPROB::JOscProbHelper::JParameter_t

inherited

Definition at line 29 of file JOscProbHelper.hh.

typedef JOscProbInterface::argument_type JOSCPROB::JOscProbHelper::argument_type

inherited

Definition at line 30 of file JOscProbHelper.hh.

Constructor & Destructor Documentation

JAANET::JAtmosphericNeutrinoFlux::JAtmosphericNeutrinoFlux ( )

inline

Default constructor.

Definition at line 39 of file JAtmosphericNeutrinoFlux.hh.

40 {}

JAANET::JAtmosphericNeutrinoFlux::JAtmosphericNeutrinoFlux ( const JOscProbInterface & oscProbInterface )

inlineexplicit

Constructor.

Parameters

oscProbInterface oscillation probability interface

Definition at line 48 of file JAtmosphericNeutrinoFlux.hh.

                                                                                  :
       JOscFlux(make_diffuseFluxFunction(Flux_Atmospheric()), oscProbInterface)       
     {}

template<class JFunction_t >

JAANET::JAtmosphericNeutrinoFlux::JAtmosphericNeutrinoFlux ( const JOscProbFunction< JFunction_t > & oscProbFunction )

inlineexplicit

Constructor.

The template argument refers to an oscillation probability function object or pointer. For this, the copy constructor needs to be defined

Parameters

oscProbFunction oscillation probability function object

Definition at line 62 of file JAtmosphericNeutrinoFlux.hh.

                                                                                             :
       JAtmosphericNeutrinoFlux(static_cast<const JOscProbInterface&>(oscProbFunction))
     {}

template<class JOscProbFunction_t >

JAANET::JAtmosphericNeutrinoFlux::JAtmosphericNeutrinoFlux ( const JOscProbFunction_t & oscProbCalculator )

inline

Constructor.

The template argument refers to an oscillation probability function object or pointer. For this, the copy constructor needs to be defined

Parameters

oscProbCalculator oscillation probability calculator

Definition at line 76 of file JAtmosphericNeutrinoFlux.hh.

                                                                           :
       JAtmosphericNeutrinoFlux(make_oscProbFunction(oscProbCalculator))
     {}

Member Function Documentation

double JAANET::JOscFlux::operator() ( const Evt & evt ) const

inlineinherited

Get flux for given event.

Note that in this evaluation the zenith-angle is defined
with respect to the line of sight (i.e. a neutrino pointing straight at you
from the center of the Earth has $cos(\theta) = -1.0$ ).

Parameters

evt event

Returns: flux $\left[\mathrm{GeV}^{-1} \, \mathrm{m}^{-2} \, \mathrm{sr}^{-1} * \mathrm{s}^{-1}\right]$

Definition at line 78 of file JOscFlux.hh.

     {
       using namespace JPP;
       
       double flux = 0.0;
 
       const Trk& neutrino = get_neutrino(evt);
       const double costh  = -neutrino.dir.z / neutrino.dir.len(); 
 
       for (int i = 0; i != NUMBER_OF_OSCCHANNELS; ++i) {
 
         const JOscChannel& channel = getOscChannel[i];
 
         const int inType  = ((int) channel.Cparity) * ((int) channel.in);
         const int outType = ((int) channel.Cparity) * ((int) channel.out);
         
         if (outType == neutrino.type) {
           
           flux += ( JDiffuseFluxHelper::getFactor(inType, log10(neutrino.E), costh) *
                     JOscProbHelper::getP(channel, neutrino.E, costh) );
         }
       }
       
       return flux;
     }

bool JAANET::JOscFlux::equals ( const JOscFlux & object ) const

inlineinherited

Check if this flux is equal to given flux.

Parameters

object flux object

Returns: true if this flux is identical to given flux; else false

Definition at line 111 of file JOscFlux.hh.

     {
       return (static_cast<const JDiffuseFluxHelper&>(object) == static_cast<const JDiffuseFluxHelper&>(*this) &&
               static_cast<const JOscProbHelper&>(object)     == static_cast<const JOscProbHelper&>    (*this));
     }

double JAANET::JOscFlux::getFactor ( const Evt & evt ) const

inlineoverrideinherited

Get event-weight factor for given event.

Parameters

evt event

Returns: event-weight factor [GeV^-1 * m^-2 * sr^-1 * s^-1]

Definition at line 124 of file JOscFlux.hh.

     {
       return (*this)(evt);
     }

double JAANET::JEvtWeightFactorHelper< JDiffuseFlux >::getFactor	(	const int	type,
		const double	log10E,
		const double	costh
	)		const

inlineinherited

Get diffuse flux corresponding to given neutrino type, 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 178 of file JEvtWeightFactorHelper.hh.

     {
       const JDiffuseFlux& diffuseFlux = getDiffuseFlux();
 
       return diffuseFlux.getFactor(type, log10E, costh);
     }

template<class JClonable_t, class JDerived_t = JNullType>

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::JPDFTransformer< 5, JArgument_t >, JPHYSICS::JPDFTransformer< 4, JArgument_t >, JPHYSICS::JPDFTransformer< 3, JArgument_t >, JPHYSICS::JPDFTransformer< 2, JArgument_t >, JPHYSICS::JPDGTransformer_t< JArgument_t >, JPHYSICS::JPD0Transformer_t< JArgument_t >, JTOOLS::JMultiMapTransformer< N, JArgument_t >::JMultiMapDefaultTransformer, JPHYSICS::JPDFTransformer_t< JArgument_t >, JLANG::JClonable< JMatch< hit_type > >, JLANG::JClonable< JMatch< hit_type >, JMatch3D >, JLANG::JClonable< JMatch< JTRIGGER::JHitR1 > >, and JLANG::JClonable< JMatch< JTRIGGER::JHitR1 >, JMatch3G< JTRIGGER::JHitR1 > >.

Definition at line 69 of file JClonable.hh.

     {
       return new JDerived_t(static_cast<const JDerived_t&>(*this));
     }

void JAANET::JEvtWeightFactorHelper< JDiffuseFlux >::configure ( const JDiffuseFlux & diffuseFlux )

inlineinherited

Configure oscillation probability function.

Parameters

diffuseFlux diffuse flux function

Definition at line 139 of file JEvtWeightFactorHelper.hh.

     {
       using namespace JPP;
       
       JDiffuseFlux* p = dynamic_cast<JDiffuseFlux*>(diffuseFlux.clone());
 
       if (p != NULL) {
         reset(p);
       } else {
         THROW(JNullPointerException, "JDiffuseFluxHelper::configure(): Unable to retrieve diffuse flux interface.");
       }      
     }

void JOSCPROB::JOscProbHelper::configure ( const JOscProbInterface & oscProb )

inlineinherited

Configure oscillation probability function.

Parameters

oscProb oscillation probability function

Definition at line 66 of file JOscProbHelper.hh.

     {
       this->reset(oscProb.clone());
     }

JDiffuseFlux& JAANET::JEvtWeightFactorHelper< JDiffuseFlux >::getDiffuseFlux ( ) const

inlineinherited

Get reference to diffuse flux factor.

Returns: reference to diffuse flux factor

Definition at line 158 of file JEvtWeightFactorHelper.hh.

     {
       using namespace JPP;
 
       if (static_cast<const JDiffuseFluxHelper_t&>(*this)) {
         return *(this->get());
       } else {
         THROW(JNullPointerException, "JDiffuseFluxHelper::getDiffuseFlux(): Diffuse flux factor is not set.");
       }
     }

JOscProbInterface& JOSCPROB::JOscProbHelper::getOscProbInterface ( ) const

inlineinherited

Get reference to oscillation probability interface.

Returns: oscillation parameters

Definition at line 77 of file JOscProbHelper.hh.

     {
       using namespace JPP;
 
       if (static_cast<const JOscProbHelper&>(*this)) {
         return *(this->get());
       } else {
         THROW(JNullPointerException, "JOscProbHelper::getOscProbInterface(): Oscillation probability interface is not set.");
       }
     }

JOscParameters_t& JOSCPROB::JOscProbHelper::getParameters ( ) const

inlineinherited

Get reference to oscillation parameters interface.

Returns: reference to oscillation parameters interface

Definition at line 94 of file JOscProbHelper.hh.

     {
       return getOscProbInterface().getParameters();
     }

void JOSCPROB::JOscProbHelper::set ( const JOscParameters_t & parameters ) const

inlineinherited

Set oscillation parameters.

Parameters

parameters oscillation parameters

Definition at line 105 of file JOscProbHelper.hh.

     {
       return getParameters().set(parameters);
     }

virtual void JOSCPROB::JOscProbHelper::set	(	const std::string &	name,
		const argument_type &	value
	)		const

inlinevirtualinherited

Set value for a given oscillation parameter.

Parameters

name	parameter name
value	parameter value

Definition at line 117 of file JOscProbHelper.hh.

     {
       getParameters().set(name, value);
     }

template<class... Args>

void JOSCPROB::JOscProbHelper::set	(	const std::string &	name,
		const argument_type &	value,
		const Args &...	args
	)		const

inlineinherited

Set value for given list of oscillation parameters.

Parameters

name	parameter name
value	parameter value
args	remaining pairs of parameter names and values

Definition at line 132 of file JOscProbHelper.hh.

     {
       getParameters().set(name, value, args...);
     }

double JOSCPROB::JOscProbHelper::getP	(	const JOscChannel &	channel,
		const double	energy,
		const double	costh
	)		const

inlineinherited

Get oscillation probability corresponding to given oscillation channel, neutrino energy and zenith angle.

Parameters

channel	oscillation channel
energy	neutrino energy [GeV]
costh	cosine zenith angle

Returns: oscillation probability

Definition at line 149 of file JOscProbHelper.hh.

     {
       return getOscProbInterface().getP(channel, energy, costh);
     }

double JOSCPROB::JOscProbHelper::getP	(	const JOscParameters_t &	parameters,
		const JOscChannel &	channel,
		const double	energy,
		const double	costh
	)		const

inlineinherited

Get oscillation probability for a given set of oscillation parameters
and a given oscillation channel.

Parameters

channel	oscillation channel
parameters	oscillation parameters
energy	neutrino energy [GeV]
costh	cosine zenith angle

Returns: oscillation probability

Definition at line 167 of file JOscProbHelper.hh.

     {
       return getOscProbInterface().getP(parameters, channel, energy, costh);
     }

double JOSCPROB::JOscProbHelper::getP	(	const std::string &	name,
		const double	value,
		const JOscChannel &	channel,
		const double	E,
		const double	costh
	)		const

inlineinherited

Get oscillation probability for a given oscillation parameter
and a given oscillation channel.

Parameters

name	parameter name
value	parameter value
channel	oscillation channel
E	neutrino energy [GeV]
costh	cosine zenith angle

Returns: oscillation probability

Definition at line 187 of file JOscProbHelper.hh.

     {
       return getOscProbInterface().getP(name, value, channel, E, costh);
     }

template<class... Args>

double JOSCPROB::JOscProbHelper::getP	(	const std::string &	name,
		const double	value,
		const Args &...	args
	)		const

inlineinherited

Get oscillation probability for a given set of oscillation parameters
and a given oscillation channel.

Parameters

name	parameter name
value	parameter value
args	remaining arguments

Definition at line 206 of file JOscProbHelper.hh.

     {
       return getOscProbInterface().getP(name, value, args...);
     }

virtual double JOSCPROB::JOscProbHelper::getCosth ( const double L ) const

inlinevirtualinherited

Get cosine zenith angle for a given baseline.

Parameters

L	baseline [km]

Returns: cosine zenith angle

Definition at line 220 of file JOscProbHelper.hh.

     {
       return getOscProbInterface().getCosth(L);
     }

virtual double JOSCPROB::JOscProbHelper::getBaseline ( const double costh ) const

inlinevirtualinherited

Get baseline for a given cosine zenith angle.

Parameters

costh cosine zenith angle

Returns: baseline [km]

Definition at line 232 of file JOscProbHelper.hh.

     {
       return getOscProbInterface().getBaseline(costh);
     }

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

JAtmosphericNeutrinoFlux.hh

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation