JOSCPROB::JOscillogram Struct Reference

Auxiliary class for creating oscillograms. More...

#include <JOscillogram.hh>

Inheritance diagram for JOSCPROB::JOscillogram:

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
	JOscillogram (const JOscillogramAxis &abscissa, const JOscillogramAxis &ordinate, const JOscChannel &channel, const JOscProbInterface &oscprob)
	Constructor.
	JOscillogram (const std::string &abscissaName, const JGrid< double > abscissaBinning, const std::string &ordinateName, const JGrid< double > ordinateBinning, const JOscChannel &channel, const JOscProbInterface &oscprob)
	Constructor.
double	getEnergy (const int i, const int j) const
	Get energy corrresponding to the given bin indices.
double	getCosth (const int i, const int j) const
	Get cosine zenith angle corrresponding to the given bin indices.
double	getP (const int i, const int j) const
	Get oscillation probability for given bin indices.
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	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.

Private Member Functions
std::pair< double, double >	getTransformation (const int i, const int j) const
	Get energy and cosine zenith angle corresponding to the given bin indices.
double	getCosth (const double L) const
	Get cosine zenith angle for a given baseline.

Private Attributes
JOscillogramAxis	abscissa
	Abscissa axis.
JOscillogramAxis	ordinate
	Ordinate axis.
JOscChannel	channel
	Oscillation channel.

Detailed Description

Auxiliary class for creating oscillograms.

Definition at line 80 of file JOscillogram.hh.

Member Typedef Documentation

JOscParameters_t

JOscProbInterface::JOscParameters_t JOSCPROB::JOscProbHelper::JOscParameters_t

inherited

Definition at line 33 of file JOscProbHelper.hh.

JOscParameterReferences_t

JOscProbInterface::JOscParameterReferences_t JOSCPROB::JOscProbHelper::JOscParameterReferences_t

inherited

Definition at line 34 of file JOscProbHelper.hh.

JParameter_t

JOscProbInterface::JParameter_t JOSCPROB::JOscProbHelper::JParameter_t

inherited

Definition at line 35 of file JOscProbHelper.hh.

argument_type

JOscProbInterface::argument_type JOSCPROB::JOscProbHelper::argument_type

inherited

Definition at line 37 of file JOscProbHelper.hh.

value_type

JOscProbInterface::value_type JOSCPROB::JOscProbHelper::value_type

inherited

Definition at line 38 of file JOscProbHelper.hh.

pointer_type

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

inherited

Definition at line 40 of file JOscProbHelper.hh.

Constructor & Destructor Documentation

JOscillogram() [1/2]

JOSCPROB::JOscillogram::JOscillogram ( const JOscillogramAxis & abscissa, const JOscillogramAxis & ordinate, const JOscChannel & channel, const JOscProbInterface & oscprob )

inline

Constructor.

Parameters

abscissa	oscillogram abscissa axis definition
ordinate	oscillogram ordinate axis definition
channel	oscillation channel
oscprob	oscillation probability calculator

Definition at line 91 of file JOscillogram.hh.

                                                   :
      JOscProbHelper(oscprob),
      abscissa      (abscissa),
      ordinate      (ordinate),
      channel       (channel)
    {}

JOscillogram() [2/2]

JOSCPROB::JOscillogram::JOscillogram ( const std::string & abscissaName, const JGrid< double > abscissaBinning, const std::string & ordinateName, const JGrid< double > ordinateBinning, const JOscChannel & channel, const JOscProbInterface & oscprob )

inline

Constructor.

Parameters

abscissaName	oscillogram abscissa variable name
abscissaBinning	oscillogram abscissa binning
ordinateName	oscillogram ordinate variable name
ordinateBinning	oscillogram ordinate binning
channel	oscillation channel
oscprob	oscillation probability calculator

Definition at line 112 of file JOscillogram.hh.

                                                   :
      JOscProbHelper(oscprob),
      abscissa      (JOscVars::getType(abscissaName), abscissaBinning),
      ordinate      (JOscVars::getType(ordinateName), ordinateBinning),
      channel       (channel)
    {}

Member Function Documentation

getEnergy()

double JOSCPROB::JOscillogram::getEnergy ( const int i, const int j ) const

inline

Get energy corrresponding to the given bin indices.

Parameters

i	abscissa bin index
j	ordinate bin index

Returns

energy [GeV]

Definition at line 132 of file JOscillogram.hh.

    {
      const std::pair<double, double>& result = getTransformation(i, j);
 
      return result.first;
    }

getCosth() [1/2]

double JOSCPROB::JOscillogram::getCosth ( const int i, const int j ) const

inline

Get cosine zenith angle corrresponding to the given bin indices.

Parameters

i	abscissa bin index
j	ordinate bin index

Returns

energy [GeV]

Definition at line 147 of file JOscillogram.hh.

    {
      const std::pair<double, double>& result = getTransformation(i, j);
 
      return result.second;
    }

getP() [1/5]

double JOSCPROB::JOscillogram::getP ( const int i, const int j ) const

inline

Get oscillation probability for given bin indices.

Parameters

i	abscissa bin index
j	ordinate bin index

Returns

oscillation probability

Definition at line 161 of file JOscillogram.hh.

    {
      const double& energy = getEnergy(i, j);
      const double& costh  = getCosth (i, j);
      
      return JOscProbHelper::getP(channel, energy, costh);
    }

getTransformation()

std::pair< double, double > JOSCPROB::JOscillogram::getTransformation ( const int i, const int j ) const

inlineprivate

Get energy and cosine zenith angle corresponding to the given bin indices.

Parameters

i	abscissa bin index
j	ordinate bin index

Returns

transformed coordinate (E [GeV], costh)

Definition at line 180 of file JOscillogram.hh.

    {
      using namespace std;
      
      static int ix = -1;
      static int iy = -1;
 
      static pair<double, double> result = {0.0, 0.0}; // Cache result
 
      if (i != ix || j != iy) {
 
        ix = i;
        iy = j;
        
        const double x = abscissa.getX(i);
        const double y = ordinate.getX(j);
 
        switch (ordinate.type) {
        case (int) JOscVars::COSTH:
          result.second = y;
          break;
        case (int) JOscVars::SINTH:
          result.second = sqrt((1 + y) * (1 - y));
          break;
        case (int) JOscVars::BASELINE:
          result.second = JOscProbHelper::getCosth(y);
          break;
        default:
          THROW(JValueOutOfRange, "JOscillogram::getCosth(const double): Invalid ordinate type " << ordinate.type);
        }
 
        switch (abscissa.type) {
        case (int) JOscVars::ENERGY:
          result.first = x;
          break;
        case (int) JOscVars::LOG10E:
          result.first = pow(10.0, x);
          break;
        case (int) JOscVars::LOE:
          result.first = (x > 0.0 ? this->getBaseline(result.second) / x : 0.0);
          break;
        default:
          THROW(JValueOutOfRange, "JOscillogram::getEnergy(const double, const double): Invalid abscissa type " << abscissa.type);      
        }
      }
 
      return result;
    }

getCosth() [2/2]

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

inlineprivate

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);
    }

configure() [1/2]

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

inlineinherited

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 )

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

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

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

getBaseline()

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

inlineinherited

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() [2/5]

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

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

getP() [3/5]

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

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

getP() [4/5]

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

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

getP() [5/5]

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

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

getProperties() [1/2]

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

inlineinherited

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

inlineinherited

Get properties of this class.

Parameters

eqpars

equation parameters

Definition at line 275 of file JOscProbHelper.hh.

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

Member Data Documentation

abscissa

JOscillogramAxis JOSCPROB::JOscillogram::abscissa

private

Abscissa axis.

Definition at line 230 of file JOscillogram.hh.

ordinate

JOscillogramAxis JOSCPROB::JOscillogram::ordinate

private

Ordinate axis.

Definition at line 231 of file JOscillogram.hh.

channel

JOscChannel JOSCPROB::JOscillogram::channel

private

Oscillation channel.

Definition at line 233 of file JOscillogram.hh.

---

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

• JOscillogram.hh