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::unique_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.
virtual std::istream &	read (std::istream &in)
	Read configuration of oscillation probability calculator from input.
virtual std::ostream &	write (std::ostream &out) const
	Write configuration of oscillation probability calculator to output.
virtual double	getCosth (const double L) const =0
	Get cosine zenith angle for a given baseline.
virtual double	getBaseline (const double costh) const =0
	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.
virtual JProperties	getProperties (const JEquationParameters &equation=JOscParameters_t::getEquationParameters())
	Get properties of this class.
virtual JProperties	getProperties (const JEquationParameters &equation=JOscParameters_t::getEquationParameters()) const
	Get properties of this class.
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.

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

Detailed Description

Low-level interface for oscillation probability calculators.

Definition at line 33 of file JOscProbInterface.hh.

Member Typedef Documentation

JOscParametersHelper_t

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

Definition at line 40 of file JOscProbInterface.hh.

JOscParameters_t

JOscParametersInterface<double> JOSCPROB::JOscProbInterface::JOscParameters_t

Definition at line 42 of file JOscProbInterface.hh.

JOscParameterReferences_t

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

Definition at line 43 of file JOscProbInterface.hh.

JOscParameter_t

JOscParameters_t::JOscParameter_t JOSCPROB::JOscProbInterface::JOscParameter_t

Definition at line 45 of file JOscProbInterface.hh.

JParameter_t

JOscParameters_t::JParameter_t JOSCPROB::JOscProbInterface::JParameter_t

Definition at line 46 of file JOscProbInterface.hh.

argument_type

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

inherited

Definition at line 35 of file JOscParametersHelper.hh.

value_type

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

inherited

Definition at line 36 of file JOscParametersHelper.hh.

pointer_type

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

inherited

Definition at line 38 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 52 of file JOscProbInterface.hh.

    {}

JOscProbInterface() [2/3]

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

inline

Constructor.

Parameters

parameters

oscillation parameters

Definition at line 61 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 75 of file JOscProbInterface.hh.

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

~JOscProbInterface()

virtual JOSCPROB::JOscProbInterface::~JOscProbInterface ( )

inlinevirtual

Virtual destructor.

Definition at line 86 of file JOscProbInterface.hh.

    {}

Member Function Documentation

getTypeKey()

static const char *const JOSCPROB::JOscProbInterface::getTypeKey ( )

inlinestatic

Get type keyword.

Returns

type keyword

Definition at line 95 of file JOscProbInterface.hh.

    {
      return "type";
    }

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 124 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 146 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 167 of file JOscProbInterface.hh.

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

operator()() [1/4]

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 185 of file JOscProbInterface.hh.

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

operator()() [2/4]

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 203 of file JOscProbInterface.hh.

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

operator()() [3/4]

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 223 of file JOscProbInterface.hh.

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

operator()() [4/4]

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 242 of file JOscProbInterface.hh.

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

getEquationParameters()

static JEquationParameters & JOSCPROB::JOscProbInterface::getEquationParameters ( )

inlinestatic

Get equation parameters.

Returns

equation parameters

Definition at line 255 of file JOscProbInterface.hh.

    {
      static JEquationParameters equation("=", " ,\t\n\v\f\r", "./", "#");
       
      return equation;
    }    

setEquationParameters()

static void JOSCPROB::JOscProbInterface::setEquationParameters ( const JEquationParameters & eqpars )

inlinestatic

Set equation parameters.

Parameters

eqpars

equation parameters

Definition at line 268 of file JOscProbInterface.hh.

    {
      getEquationParameters() = eqpars;
    }

read()

virtual std::istream & JOSCPROB::JOscProbInterface::read ( std::istream & in )

inlinevirtual

Read configuration of oscillation probability calculator from input.

Parameters

in	input stream

Returns

input stream

Definition at line 280 of file JOscProbInterface.hh.

    {
      using namespace std;
      using namespace JPP;
 
      JStringStream is(in);
 
      if (getFileStatus(is.str().c_str())) {
        is.load();
      }
      
      is >> getProperties();
      
      return in;
    }

write()

virtual std::ostream & JOSCPROB::JOscProbInterface::write ( std::ostream & out ) const

inlinevirtual

Write configuration of oscillation probability calculator to output.

Parameters

out	output stream

Returns

output stream

Definition at line 303 of file JOscProbInterface.hh.

    {
      return out << getProperties();
    }

getCosth()

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

pure virtualinherited

Get cosine zenith angle for a given baseline.

Parameters

L	baseline [km]

Returns

cosine zenith angle

Implemented in JOSCPROB::JBaselineComputer.

getBaseline()

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

pure virtualinherited

Get baseline for a given cosine zenith angle.

Parameters

costh

cosine zenith angle

Returns

baseline [km]

Implemented in JOSCPROB::JBaselineComputer.

configure() [1/2]

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

inlineinherited

Configure oscillation parameters.

Parameters

p	unique pointer to oscillation parameters

Definition at line 95 of file JOscParametersHelper.hh.

    {
      if (p) { this->reset(p->clone()); }
    }

configure() [2/2]

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

inlineinherited

Configure oscillation parameters.

Parameters

parameters

oscillation parameters

Definition at line 106 of file JOscParametersHelper.hh.

    {
      using namespace std;
      using namespace JPP;
      
      JOscParameters_t* p = dynamic_cast<JOscParameters_t*>(parameters.clone());
 
      if (p != NULL) {
        this->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 126 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 143 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 155 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 168 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 183 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 197 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());
      }
    }

getProperties() [1/2]

virtual JProperties JOSCPROB::JOscParametersHelper< double & >::getProperties ( const JEquationParameters & equation = JOscParameters_t::getEquationParameters() )

inlinevirtualinherited

Get properties of this class.

Parameters

equation

equation parameters

Returns

properties of this class

Definition at line 219 of file JOscParametersHelper.hh.

    {
      return getParameters().getProperties(equation);
    }

getProperties() [2/2]

virtual JProperties JOSCPROB::JOscParametersHelper< double & >::getProperties ( const JEquationParameters & equation = JOscParameters_t::getEquationParameters() ) const

inlinevirtualinherited

Get properties of this class.

Parameters

equation

equation parameters

Returns

properties of this class

Definition at line 231 of file JOscParametersHelper.hh.

    {
      return getParameters().getProperties(equation);      
    }

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

Friends And Related Symbol Documentation

operator>>

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

friend

Read oscillation probability calculator from input.

Parameters

in	input stream
object	oscillation probability calculator

Returns

input stream

Definition at line 316 of file JOscProbInterface.hh.

    {
      return object.read(in);
    }

operator<<

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

friend

Write oscillation probability calculator to output.

Parameters

out	output stream
object	oscillation probability calculator

Returns

output stream

Definition at line 329 of file JOscProbInterface.hh.

    {
      return object.write(out);
    }

---

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

• JOscProbInterface.hh