JOSCPROB::JOscProbInterface Class Reference

Low-level interface for oscillation probability calculators. More...

#include <JOscProbInterface.hh>

Inheritance diagram for JOSCPROB::JOscProbInterface:

Public Types
typedef JOscParametersHelper< double & >	JOscParametersHelper_t
typedef JOscParametersInterface< double >	JOscParameters_t
typedef JOscParametersInterface< double & >	JOscParameterReferences_t
typedef JOscParameters_t::JOscParameter_t	JOscParameter_t
typedef JOscParameters_t::JParameter_t	JParameter_t
typedef JOscParameters_t::argument_type	argument_type
typedef JOscParameters_t::value_type	value_type
typedef std::shared_ptr< JOscParameters_t >	pointer_type
typedef JClonable< JClonable_t >::clone_type	clone_type

Public Member Functions
	JOscProbInterface ()
	Default constructor.
	JOscProbInterface (const JOscParameterReferences_t &parameters)
	Constructor.
template<class ... Args>
	JOscProbInterface (const JOscParameterReferences_t &parameters, const std::string &name, double &value, const Args &...args)
	Constructor.
virtual	~JOscProbInterface ()
	Virtual destructor.
virtual double	getP (const JOscChannel &channel, const double E, const double costh) const =0
	Get oscillation probability for a given oscillation channel.
double	getP (const JOscParameters_t &parameters, const JOscChannel &channel, const double E, 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.
double	operator() (const JOscChannel &channel, const double E, const double costh) const
	Get oscillation probability for a given oscillation channel.
double	operator() (const JOscParameters_t &parameters, const JOscChannel &channel, const double E, const double costh) const
	Get oscillation probability for a given set of oscillation parameters and a given oscillation channel.
double	operator() (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	operator() (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.
double	getMinimumBaseline () const
	Get minimum baseline.
double	getMaximumBaseline () const
	Get maximum baseline.
double	getInnerRadius () const
	Get inner radius.
double	getOuterRadius () const
	Get outer radius.
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	operator() (const double costh) const
	Get baseline for a given cosine zenith angle.
void	configure (const pointer_type &p)
	Configure oscillation parameters.
void	configure (const JOscParameters_t &parameters)
	Configure oscillation parameters.
JOscParameters_t &	getParameters () const
	Get reference to oscillation parameters interface.
JOscParameters_t *	get () const
	Get pointer to oscillation parameters interface.
JOscParameter_t &	get (const std::string &name) const
	Get oscillation parameter.
void	set (const std::string &name, const value_type &value) const
	Set value for a given oscillation parameter.
void	set (const std::string &name, const value_type &value, const Args &...args) const
	Set value for given list of oscillation parameters.
void	set (const JOscParametersInterface< value_type > &parameters) const
	Set oscillation parameters.
bool	is_valid () const
	Check validity of oscillation parameters.
virtual clone_type	clone () const override
	Get clone of this object.

Protected Attributes
double	Lmin
	Minimum baseline [km].
double	Lmax
	Maximum baseline [km].

Detailed Description

Low-level interface for oscillation probability calculators.

Definition at line 29 of file JOscProbInterface.hh.

Member Typedef Documentation

JOscParametersHelper_t

JOscParametersHelper<double&> JOSCPROB::JOscProbInterface::JOscParametersHelper_t

Definition at line 36 of file JOscProbInterface.hh.

JOscParameters_t

JOscParametersInterface<double> JOSCPROB::JOscProbInterface::JOscParameters_t

Definition at line 38 of file JOscProbInterface.hh.

JOscParameterReferences_t

JOscParametersInterface<double&> JOSCPROB::JOscProbInterface::JOscParameterReferences_t

Definition at line 39 of file JOscProbInterface.hh.

JOscParameter_t

JOscParameters_t::JOscParameter_t JOSCPROB::JOscProbInterface::JOscParameter_t

Definition at line 41 of file JOscProbInterface.hh.

JParameter_t

JOscParameters_t::JParameter_t JOSCPROB::JOscProbInterface::JParameter_t

Definition at line 42 of file JOscProbInterface.hh.

argument_type

JOscParameters_t::argument_type JOSCPROB::JOscParametersHelper< double & >::argument_type

inherited

Definition at line 33 of file JOscParametersHelper.hh.

value_type

JOscParameters_t::value_type JOSCPROB::JOscParametersHelper< double & >::value_type

inherited

Definition at line 34 of file JOscParametersHelper.hh.

pointer_type

std::shared_ptr<JOscParameters_t> JOSCPROB::JOscParametersHelper< double & >::pointer_type

inherited

Definition at line 36 of file JOscParametersHelper.hh.

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

JOscProbInterface() [1/3]

JOSCPROB::JOscProbInterface::JOscProbInterface ( )

inline

Default constructor.

Definition at line 48 of file JOscProbInterface.hh.

    {}

JOscProbInterface() [2/3]

JOSCPROB::JOscProbInterface::JOscProbInterface ( const JOscParameterReferences_t & parameters )

inline

Constructor.

Parameters

parameters

oscillation parameters

Definition at line 57 of file JOscProbInterface.hh.

                                                                   :
      JOscParametersHelper_t(parameters)
    {}

JOscProbInterface() [3/3]

template<class ... Args>

JOSCPROB::JOscProbInterface::JOscProbInterface ( const JOscParameterReferences_t & parameters, const std::string & name, double & value, const Args &... args )

inline

Constructor.

Parameters

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

Definition at line 71 of file JOscProbInterface.hh.

                                                             :
      JOscParametersHelper_t(parameters, name, value, args...)
    {}

~JOscProbInterface()

virtual JOSCPROB::JOscProbInterface::~JOscProbInterface ( )

inlinevirtual

Virtual destructor.

Definition at line 82 of file JOscProbInterface.hh.

    {}

Member Function Documentation

getP() [1/4]

virtual double JOSCPROB::JOscProbInterface::getP ( const JOscChannel & channel, const double E, const double costh ) const

pure virtual

Get oscillation probability for a given oscillation channel.

Parameters

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

Returns

oscillation probability

getP() [2/4]

double JOSCPROB::JOscProbInterface::getP ( const JOscParameters_t & parameters, const JOscChannel & channel, const double E, 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
E	neutrino energy [GeV]
costh	cosine zenith angle

Returns

oscillation probability

Definition at line 109 of file JOscProbInterface.hh.

    {
      this->set(parameters);
 
      return getP(channel, E, costh);      
    }

getP() [3/4]

double JOSCPROB::JOscProbInterface::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 131 of file JOscProbInterface.hh.

    {
      this->set(name, value);
 
      return getP(channel, E, costh);
    }

getP() [4/4]

template<class ... Args>

double JOSCPROB::JOscProbInterface::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 152 of file JOscProbInterface.hh.

    {
      this->set(name, value);
      
      return getP(args...);
    }

operator()() [1/5]

double JOSCPROB::JOscProbInterface::operator() ( const JOscChannel & channel, const double E, const double costh ) const

inline

Get oscillation probability for a given oscillation channel.

Parameters

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

Returns

oscillation probability

Definition at line 170 of file JOscProbInterface.hh.

    {
      return getP(channel, E, costh);
    }

operator()() [2/5]

double JOSCPROB::JOscProbInterface::operator() ( const JOscParameters_t & parameters, const JOscChannel & channel, const double E, 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
E	neutrino energy [GeV]
costh	cosine zenith angle

Returns

oscillation probability

Definition at line 188 of file JOscProbInterface.hh.

    {
      return getP(parameters, channel, E, costh);
    }

operator()() [3/5]

double JOSCPROB::JOscProbInterface::operator() ( 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 208 of file JOscProbInterface.hh.

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

operator()() [4/5]

template<class ... Args>

double JOSCPROB::JOscProbInterface::operator() ( 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 227 of file JOscProbInterface.hh.

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

getMinimumBaseline()

double JOSCPROB::JBaselineComputer::getMinimumBaseline ( ) const

inlineinherited

Get minimum baseline.

Returns

maximum baseline [km]

Definition at line 52 of file JBaselineComputer.hh.

    {
      return Lmin;
    }

getMaximumBaseline()

double JOSCPROB::JBaselineComputer::getMaximumBaseline ( ) const

inlineinherited

Get maximum baseline.

Returns

maximum baseline [km]

Definition at line 63 of file JBaselineComputer.hh.

    {
      return Lmax;
    }

getInnerRadius()

double JOSCPROB::JBaselineComputer::getInnerRadius ( ) const

inlineinherited

Get inner radius.

Returns

inner radius [km]

Definition at line 74 of file JBaselineComputer.hh.

    {
      return 0.5 * (Lmax - Lmin);
    }

getOuterRadius()

double JOSCPROB::JBaselineComputer::getOuterRadius ( ) const

inlineinherited

Get outer radius.

Returns

outer radius [km]

Definition at line 85 of file JBaselineComputer.hh.

    {
      return 0.5 * (Lmax + Lmin);;
    }

getCosth()

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

inlineinherited

Get cosine zenith angle for a given baseline.

Parameters

L	baseline [km]

Returns

cosine zenith angle

Definition at line 97 of file JBaselineComputer.hh.

    {
      const double r = getInnerRadius();
      const double R = getOuterRadius();
      
      return (R*R - r*r - L*L) / (2*L*r);
    }

getBaseline()

double JOSCPROB::JBaselineComputer::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 112 of file JBaselineComputer.hh.

    {
      const double r = getInnerRadius();
      const double R = getOuterRadius();
 
      const double ct = (fabs(costh) < 1.0 ? costh : (costh < 0 ? -1.0 : 1.0));
    
      return (-r * ct + sqrt(R*R - r*r * (1 - ct) * (1 + ct)));
    }

operator()() [5/5]

double JOSCPROB::JBaselineComputer::operator() ( const double costh ) const

inlineinherited

Get baseline for a given cosine zenith angle.

Parameters

costh

cosine zenith angle

Returns

baseline [km]

Definition at line 129 of file JBaselineComputer.hh.

    {
      return getBaseline(costh);
    }

configure() [1/2]

void JOSCPROB::JOscParametersHelper< double & >::configure ( const pointer_type & p )

inlineinherited

Configure oscillation parameters.

Parameters

p	shared pointer to oscillation parameters

Definition at line 94 of file JOscParametersHelper.hh.

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

configure() [2/2]

void JOSCPROB::JOscParametersHelper< double & >::configure ( const JOscParameters_t & parameters )

inlineinherited

Configure oscillation parameters.

Parameters

parameters

oscillation parameters

Definition at line 105 of file JOscParametersHelper.hh.

    {
      using namespace std;
      using namespace JPP;
      
      JOscParameters_t* p = dynamic_cast<JOscParameters_t*>(parameters.clone());
 
      if (p != NULL) {
        reset(p);
      } else {
        THROW(JNullPointerException, "JOscParametersHelper::configure(): Unable to retrieve oscillation parameters interface.");
      }
    }

getParameters()

JOscParameters_t & JOSCPROB::JOscParametersHelper< double & >::getParameters ( ) const

inlineinherited

Get reference to oscillation parameters interface.

Returns

reference to oscillation parameters interface

Definition at line 125 of file JOscParametersHelper.hh.

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

get() [1/2]

JOscParameters_t * JOSCPROB::JOscParametersHelper< double & >::get ( ) const

inlineinherited

Get pointer to oscillation parameters interface.

Returns

pointer to oscillation parameters interface

Definition at line 142 of file JOscParametersHelper.hh.

    {
      return pointer_type::get();
    }

get() [2/2]

JOscParameter_t & JOSCPROB::JOscParametersHelper< double & >::get ( const std::string & name ) const

inlineinherited

Get oscillation parameter.

Parameters

name	parameter name

Returns

parameter

Definition at line 154 of file JOscParametersHelper.hh.

    {
      return getParameters().get(name);
    }

set() [1/3]

void JOSCPROB::JOscParametersHelper< double & >::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 167 of file JOscParametersHelper.hh.

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

set() [2/3]

void JOSCPROB::JOscParametersHelper< double & >::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 182 of file JOscParametersHelper.hh.

    {
      this->set(name, value);
      this->set(args...);
    }

set() [3/3]

void JOSCPROB::JOscParametersHelper< double & >::set ( const JOscParametersInterface< value_type > & parameters ) const

inlineinherited

Set oscillation parameters.

Parameters

parameters

oscillation parameters

Definition at line 196 of file JOscParametersHelper.hh.

    {
      using namespace std;
      using namespace JPP;
 
      const JProperties properties = parameters.getProperties();
 
      for (JProperties::const_iterator i = properties.cbegin(); i != properties.cend(); ++i) {
        
        const JOscParameter<value_type>& parameter = i->second.getValue<const JOscParameter<value_type> >();
        
        this->set(i->first, parameter.getValue());
      }
    }

is_valid()

bool JOSCPROB::JOscParametersHelper< double & >::is_valid ( ) const

inlineinherited

Check validity of oscillation parameters.

Returns

true if all oscillation parameters are valid; else false

Definition at line 217 of file JOscParametersHelper.hh.

    {
      return getParameters().is_valid();
    }

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.

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

Member Data Documentation

Lmin

double JOSCPROB::JBaselineComputer::Lmin

protectedinherited

Minimum baseline [km].

Definition at line 165 of file JBaselineComputer.hh.

Lmax

double JOSCPROB::JBaselineComputer::Lmax

protectedinherited

Maximum baseline [km].

Definition at line 166 of file JBaselineComputer.hh.

---

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

• JOscProbInterface.hh