JOSCPROB::JOscProbHelper Struct Reference

Helper class for oscillation probability calculators. More...

#include <JOscProbHelper.hh>

Inheritance diagram for JOSCPROB::JOscProbHelper:

Public Types
typedef JOscProbInterface::JOscParameters_t	JOscParameters_t
typedef JOscProbInterface::JOscParameterReferences_t	JOscParameterReferences_t
typedef JOscProbInterface::JParameter_t	JParameter_t
typedef JOscProbInterface::argument_type	argument_type
typedef JOscProbInterface::value_type	value_type
typedef std::shared_ptr< JOscProbInterface >	pointer_type

Public Member Functions
	JOscProbHelper ()
	Default constructor.
	JOscProbHelper (const pointer_type &pOscProb)
	Copy constructor.
	JOscProbHelper (const JOscProbInterface &oscProb)
	Constructor.
void	configure (const pointer_type &pOscProb)
	Configure oscillation probability function.
void	configure (const JOscProbInterface &oscProb)
	Configure oscillation probability function.
JOscProbInterface &	getOscProbInterface () const
	Get reference to oscillation probability interface.
JOscParameterReferences_t &	getParameters () const
	Get reference to oscillation parameters interface.
void	set (const JOscParameters_t &parameters) const
	Set oscillation parameters.
void	set (const std::string &name, const value_type &value) const
	Set value for a given oscillation parameter.
template<class ... Args>
void	set (const std::string &name, const value_type &value, const Args &...args) const
	Set value for given list of oscillation parameters.
double	getCosth (const double L) const
	Get cosine zenith angle for a given baseline.
double	getBaseline (const double costh) const
	Get baseline for a given cosine zenith angle.
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.
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.
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.
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.
JProperties	getProperties (const JEquationParameters &eqpars=JOscProbInterface::getEquationParameters())
	Get properties of this class.
JProperties	getProperties (const JEquationParameters &eqpars=JOscProbInterface::getEquationParameters()) const
	Get properties of this class.

Friends
std::istream &	operator>> (std::istream &in, JOscProbHelper &object)
	Read from input.
std::ostream &	operator<< (std::ostream &out, const JOscProbHelper &object)
	Write to output.

Detailed Description

Helper class for oscillation probability calculators.

Definition at line 30 of file JOscProbHelper.hh.

Member Typedef Documentation

JOscParameters_t

JOscProbInterface::JOscParameters_t JOSCPROB::JOscProbHelper::JOscParameters_t

Definition at line 33 of file JOscProbHelper.hh.

JOscParameterReferences_t

JOscProbInterface::JOscParameterReferences_t JOSCPROB::JOscProbHelper::JOscParameterReferences_t

Definition at line 34 of file JOscProbHelper.hh.

JParameter_t

JOscProbInterface::JParameter_t JOSCPROB::JOscProbHelper::JParameter_t

Definition at line 35 of file JOscProbHelper.hh.

argument_type

JOscProbInterface::argument_type JOSCPROB::JOscProbHelper::argument_type

Definition at line 37 of file JOscProbHelper.hh.

value_type

JOscProbInterface::value_type JOSCPROB::JOscProbHelper::value_type

Definition at line 38 of file JOscProbHelper.hh.

pointer_type

std::shared_ptr<JOscProbInterface> JOSCPROB::JOscProbHelper::pointer_type

Definition at line 40 of file JOscProbHelper.hh.

Constructor & Destructor Documentation

JOscProbHelper() [1/3]

JOSCPROB::JOscProbHelper::JOscProbHelper ( )

inline

Default constructor.

Definition at line 46 of file JOscProbHelper.hh.

    {}

JOscProbHelper() [2/3]

JOSCPROB::JOscProbHelper::JOscProbHelper ( const pointer_type & pOscProb )

inline

Copy constructor.

Parameters

pOscProb

shared pointer to oscillation probability function

Definition at line 55 of file JOscProbHelper.hh.

                                                 :
      pointer_type(pOscProb)
    {}

JOscProbHelper() [3/3]

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

inline

Constructor.

Parameters

oscProb

oscillation probability function

Definition at line 65 of file JOscProbHelper.hh.

    {
      configure(oscProb);
    }

Member Function Documentation

configure() [1/2]

void JOSCPROB::JOscProbHelper::configure ( const pointer_type & pOscProb )

inline

Configure oscillation probability function.

Parameters

pOscProb

shared pointer to oscillation probability function

Definition at line 76 of file JOscProbHelper.hh.

    {
      static_cast<pointer_type&>(*this) = pOscProb;
    }

configure() [2/2]

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

inline

Configure oscillation probability function.

Parameters

oscProb

oscillation probability function

Definition at line 87 of file JOscProbHelper.hh.

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

getOscProbInterface()

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

inline

Get reference to oscillation probability interface.

Returns

oscillation parameters

Definition at line 98 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.");
      }
    }

getParameters()

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

inline

Get reference to oscillation parameters interface.

Returns

reference to oscillation parameters interface

Definition at line 115 of file JOscProbHelper.hh.

    {
      return getOscProbInterface().getParameters();
    }

set() [1/3]

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

inline

Set oscillation parameters.

Parameters

parameters

oscillation parameters

Definition at line 126 of file JOscProbHelper.hh.

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

set() [2/3]

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

inline

Set value for a given oscillation parameter.

Parameters

name	parameter name
value	parameter value

Definition at line 138 of file JOscProbHelper.hh.

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

set() [3/3]

template<class ... Args>

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

inline

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 153 of file JOscProbHelper.hh.

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

getCosth()

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

inline

Get cosine zenith angle for a given baseline.

Parameters

L	baseline [km]

Returns

cosine zenith angle

Definition at line 167 of file JOscProbHelper.hh.

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

getBaseline()

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

inline

Get baseline for a given cosine zenith angle.

Parameters

costh

cosine zenith angle

Returns

baseline [km]

Definition at line 179 of file JOscProbHelper.hh.

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

getP() [1/4]

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

inline

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 194 of file JOscProbHelper.hh.

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

getP() [2/4]

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

inline

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 212 of file JOscProbHelper.hh.

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

getP() [3/4]

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

inline

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 232 of file JOscProbHelper.hh.

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

getP() [4/4]

template<class ... Args>

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

inline

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 251 of file JOscProbHelper.hh.

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

getProperties() [1/2]

JProperties JOSCPROB::JOscProbHelper::getProperties ( const JEquationParameters & eqpars = JOscProbInterface::getEquationParameters() )

inline

Get properties of this class.

Parameters

eqpars

equation parameters

Definition at line 264 of file JOscProbHelper.hh.

    {
      return getOscProbInterface().getProperties(eqpars);
    }

getProperties() [2/2]

JProperties JOSCPROB::JOscProbHelper::getProperties ( const JEquationParameters & eqpars = JOscProbInterface::getEquationParameters() ) const

inline

Get properties of this class.

Parameters

eqpars

equation parameters

Definition at line 275 of file JOscProbHelper.hh.

    {
      return getOscProbInterface().getProperties(eqpars);
    }

Friends And Related Symbol Documentation

operator>>

std::istream & operator>> ( std::istream & in, JOscProbHelper & object )

friend

Read from input.

Input syntax as follows:

      <oscprob_key>=<oscprob_value>[,<oscprob_key>=<oscprob_value>]...

      oscprob.<oscprob_key>=<oscprob_value>[,oscprob.<oscprob_key>=<oscprob_value>]...

      oscprob=<oscprob_file>

      <oscprob_file>

where

• <oscprob_key> refers to an oscillation probability calculator configuration key;
• <oscprob_value> to an oscillation probability calculator configuration value;
• <oscprob_file> to an oscillation probability calculator configuration file with key-value pairs;

Parameters

in	input stream
object	object

Returns

input stream

Definition at line 303 of file JOscProbHelper.hh.

    {
      using namespace std;
      using namespace JPP;
    
      static const char* KEYWORD = "oscprob";
 
      if (!object)   { return in; }
 
      // Attempt to read oscillation probability calculator configuration directly as key-value pairs
 
      JProperties properties1 = object.getProperties();
 
      streampos pos = in.tellg();
 
      in >> properties1;
 
      if (!fail(in)) { return in; }
 
      // Attempt to read oscillation probability calculator configuration from input file specified by equation
 
      in.clear();
      in.seekg(pos);
 
      JProperties properties2 = properties1;      
 
      JEquation equation;
      in >> equation;
 
      if (equation.getKey() == KEYWORD && getFileStatus(equation.getValue().c_str())) {
 
        properties2 = properties1;
        
        properties2.getEndOfLine() += '\n';
        
        ifstream ifs(equation.getValue().c_str());
 
        ifs >> properties2;
        
        ifs.close();
 
        return in;
      }
      
      // Attempt to read oscillation probability calculator configuration as key-value pairs with separator
 
      in.clear();
      in.seekg(pos);
 
      properties2.clear();
 
      properties2[KEYWORD] = properties1;
 
      in >> properties2;
 
      if (!fail(in)) { return in; }
 
      // Attempt to read oscillation probability calculator configuration from input file
 
      in.clear();
      in.seekg(pos);
 
      std::string buffer;
      in >> buffer;
 
      if (getFileStatus(buffer.c_str())) {
 
        ifstream ifs(buffer.c_str());
 
        ifs >> object;
 
        ifs.close();
        
      } else {
 
        in.clear();
        in.seekg(pos);
      }
 
      return in;
    }

operator<<

std::ostream & operator<< ( std::ostream & out, const JOscProbHelper & object )

friend

Write to output.

Parameters

out	output stream
object	object

Returns

output stream

Definition at line 393 of file JOscProbHelper.hh.

    {
      if (object) {
        out << object.getProperties();
      }
 
      return out;
    }

---

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

• JOscProbHelper.hh