Template specialisation for a map between event categories and flux factors. More...

#include <JEvtCategoryMap.hh>

Inheritance diagram for JAANET::JEvtCategoryMap< JFluxHelper >:

Classes
struct	JEvtCategoryMapHelper
	Auxiliary class for I/O of map of event categories and weight factors. More...

Public Types
typedef JEvtCategoryMap< JFluxHelper >	JEvtCategoryMap_t

typedef std::map< JEvtCategoryHelper, JFluxHelper >	map_type

typedef map_type::iterator	iterator

typedef map_type::const_iterator	const_iterator

typedef JClonable< JClonable_t >::clone_type	clone_type

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

	JEvtCategoryMap (const JOscProbHelper &oscProb)
	Constructor. More...

	JEvtCategoryMap (const JOscProbHelper &oscProb, const JEvtCategoryHelper &category, const JFluxHelper &factor)
	Constructor. More...

template<class ... Args>
	JEvtCategoryMap (const JOscProbHelper &oscProb, const JEvtCategoryHelper &category, const JFluxHelper &factor, const Args &...args)
	Constructor. More...

	JEvtCategoryMap (const JEvtCategoryHelper &category, const JFluxHelper &flux)
	Constructor. More...

template<class ... Args>
	JEvtCategoryMap (const JEvtCategoryHelper &category, const JFluxHelper &flux, const Args &...args)
	Constructor. More...

void	insert (const JEvtCategoryHelper &category, const JFluxHelper &flux)
	Insert pair of an event category and a flux function. More...

template<class ... Args>
void	insert (const JEvtCategoryHelper &category, const JFluxHelper &flux, const Args &...args)
	Insert pairs of event categories and flux functions. More...

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

bool	is_valid () const override final
	Check whether this flux factor is valid. More...

JProperties	getProperties (const JEquationParameters &eqpars=JEvtWeightFactor::getEquationParameters()) override final
	Get properties of this class. More...

JProperties	getProperties (const JEquationParameters &eqpars=JEvtWeightFactor::getEquationParameters()) const override final
	Get properties of this class. More...

std::istream &	read (std::istream &in) override final
	Read map between event categories and flux factors. More...

std::ostream &	write (std::ostream &out) const override final
	Write event-weight factor to output. More...

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

Public Attributes
JOscProbHelper	oscProb
	oscillation probability calculator More...

Detailed Description

Template specialisation for a map between event categories and flux factors.

Input syntax as follows:

      <PDG type> [<PDG type>]...;           <flux identifier> [<flux arguments>];
      <key>=<value>[,<key>=<value>]...; <flux identifier> [<flux arguments>];

where

<PDG type> refers to a PDG identifier;
<key> to one of the data members of a data structure derived from JAANET::JEvtCategory;
<value> to the corresponding value; and
<flux identifier> to a flux identifier (c.f. JAANET::JFluxDictionary) and
<flux arguments> to the list of arguments of the corresponding flux factor.

Definition at line 512 of file JEvtCategoryMap.hh.

Member Typedef Documentation

◆ JEvtCategoryMap_t

typedef JEvtCategoryMap<JFluxHelper> JAANET::JEvtCategoryMap< JFluxHelper >::JEvtCategoryMap_t

Definition at line 518 of file JEvtCategoryMap.hh.

◆ map_type

typedef std::map<JEvtCategoryHelper, JFluxHelper> JAANET::JEvtCategoryMap< JFluxHelper >::map_type

Definition at line 520 of file JEvtCategoryMap.hh.

◆ iterator

typedef map_type::iterator JAANET::JEvtCategoryMap< JFluxHelper >::iterator

Definition at line 522 of file JEvtCategoryMap.hh.

◆ const_iterator

typedef map_type::const_iterator JAANET::JEvtCategoryMap< JFluxHelper >::const_iterator

Definition at line 523 of file JEvtCategoryMap.hh.

◆ clone_type

template<class JClonable_t , class JDerived_t >

typedef 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

◆ JEvtCategoryMap() [1/6]

JAANET::JEvtCategoryMap< JFluxHelper >::JEvtCategoryMap ( )

inline

Default constructor.

Definition at line 530 of file JEvtCategoryMap.hh.

                       :
       map_type(),
       oscProb()
     {}

◆ JEvtCategoryMap() [2/6]

JAANET::JEvtCategoryMap< JFluxHelper >::JEvtCategoryMap ( const JOscProbHelper & oscProb )

inline

Constructor.

Parameters

oscProb oscillation probability calculator

Definition at line 541 of file JEvtCategoryMap.hh.

                                                    :
       map_type(),
       oscProb(oscProb)
     {}

◆ JEvtCategoryMap() [3/6]

JAANET::JEvtCategoryMap< JFluxHelper >::JEvtCategoryMap	(	const JOscProbHelper &	oscProb,
		const JEvtCategoryHelper &	category,
		const JFluxHelper &	factor
	)

inline

Constructor.

Parameters

oscProb	oscillation probability calculator
category	event category
factor	event-weight factor

Definition at line 554 of file JEvtCategoryMap.hh.

                                                       :
       map_type(),
       oscProb(oscProb)
     {
       insert(category, factor);
     }

◆ JEvtCategoryMap() [4/6]

template<class ... Args>

JAANET::JEvtCategoryMap< JFluxHelper >::JEvtCategoryMap	(	const JOscProbHelper &	oscProb,
		const JEvtCategoryHelper &	category,
		const JFluxHelper &	factor,
		const Args &...	args
	)

inline

Constructor.

Parameters

oscProb	oscillation probability calculator
category	event category
factor	event-weight factor
args	remaining pairs of event categories and event-weight factors

Definition at line 573 of file JEvtCategoryMap.hh.

                                                     :
       map_type(),
       oscProb(oscProb)
     {
       insert(category, factor, args...);
     }

◆ JEvtCategoryMap() [5/6]

JAANET::JEvtCategoryMap< JFluxHelper >::JEvtCategoryMap	(	const JEvtCategoryHelper &	category,
		const JFluxHelper &	flux
	)

inline

Constructor.

Parameters

category	event category
flux	flux function

Definition at line 590 of file JEvtCategoryMap.hh.

                                                     :
       map_type(),
       oscProb()
     {
       insert(category, flux);
     }

◆ JEvtCategoryMap() [6/6]

template<class ... Args>

JAANET::JEvtCategoryMap< JFluxHelper >::JEvtCategoryMap	(	const JEvtCategoryHelper &	category,
		const JFluxHelper &	flux,
		const Args &...	args
	)

inline

Constructor.

Parameters

category	event category
flux	flux function
args	remaining pairs of event categories and flux functions

Definition at line 608 of file JEvtCategoryMap.hh.

                                                     :
       map_type()
     {
       insert(category, flux, args...);
     }

Member Function Documentation

◆ insert() [1/2]

void JAANET::JEvtCategoryMap< JFluxHelper >::insert	(	const JEvtCategoryHelper &	category,
		const JFluxHelper &	flux
	)

inline

Insert pair of an event category and a flux function.

Parameters

category	event category
flux	flux function

Definition at line 623 of file JEvtCategoryMap.hh.

     {
       map_type::insert(std::make_pair(category, flux));
     }

◆ insert() [2/2]

template<class ... Args>

void JAANET::JEvtCategoryMap< JFluxHelper >::insert	(	const JEvtCategoryHelper &	category,
		const JFluxHelper &	flux,
		const Args &...	args
	)

inline

Insert pairs of event categories and flux functions.

Parameters

category	event category
flux	flux function
args	remaining pairs of event categories and flux functions

Definition at line 638 of file JEvtCategoryMap.hh.

     {
       insert(category, flux);
       insert(args...);
     }

◆ getFactor()

double JAANET::JEvtCategoryMap< JFluxHelper >::getFactor ( const Evt & evt ) const

inlinefinaloverride

Get weight factor of given event.

Parameters

evt event

Returns: weight-factor for given event

Definition at line 653 of file JEvtCategoryMap.hh.

     {
       using namespace JPP;
  
       for (typename map_type::const_iterator i = this->cbegin(); i != this->cend(); ++i) {
         if (i->first.match(evt)) {
           return i->second.getFactor(evt);
         }
       }
       
       THROW(JValueOutOfRange, "JEvtCategoryMap<JFluxHelper>::getFactor(): No flux factor for given event.");
     }

◆ is_valid()

bool JAANET::JEvtCategoryMap< JFluxHelper >::is_valid ( ) const

inlinefinaloverride

Check whether this flux factor is valid.

Returns: true if valid; else false

Definition at line 672 of file JEvtCategoryMap.hh.

     {
       for (typename map_type::const_iterator i = this->cbegin(); i != this->cend(); ++i) {
         if (!(i->second.is_valid())) { return false; }
       }
  
       return true;
     }

◆ getProperties() [1/2]

JProperties JAANET::JEvtCategoryMap< JFluxHelper >::getProperties ( const JEquationParameters & eqpars = JEvtWeightFactor::getEquationParameters() )

inlinefinaloverride

Get properties of this class.

Parameters

eqpars equation parameters

Definition at line 687 of file JEvtCategoryMap.hh.

     {
       return JEvtCategoryMapHelper(*this, eqpars);
     }

◆ getProperties() [2/2]

JProperties JAANET::JEvtCategoryMap< JFluxHelper >::getProperties ( const JEquationParameters & eqpars = JEvtWeightFactor::getEquationParameters() ) const

inlinefinaloverride

Get properties of this class.

Parameters

eqpars equation parameters

Definition at line 698 of file JEvtCategoryMap.hh.

     {
       return JEvtCategoryMapHelper(*this, eqpars);
     }

◆ read()

std::istream& JAANET::JEvtCategoryMap< JFluxHelper >::read ( std::istream & in )

inlinefinaloverride

Read map between event categories and flux factors.

Parameters

in	input stream

Returns: input stream

Definition at line 710 of file JEvtCategoryMap.hh.

     {
       using namespace std;
       using namespace JPP;
       
       static const JFluxDictionary dictionary(oscProb);
  
       JStringStream is(in);
  
       if (getFileStatus(is.str().c_str())) {
         is.load();
       }
  
       for (JToken<';'> token1, token2; is >> token1 >> token2; ) {
  
         istringstream iss1(token1); // Read event categories
  
         JEvtCategorySet categories;
  
         iss1 >> categories;
         
         istringstream iss2(token2); // Read event-weight factors
         
         int fluxID = 0;
         
         if (iss2 >> fluxID) {
           
           JFluxHelper helper(dictionary.at(fluxID).getFlux());
  
           JFlux& flux = helper.getFlux();
  
           iss2 >> flux;
  
           if (!fail(iss2)) {
             for (JEvtCategorySet::const_iterator i = categories.cbegin(); i != categories.cend(); ++i) {
               this->insert(*i, helper);
             }
           }
         }
       }
  
       return in;
     }

◆ write()

std::ostream& JAANET::JEvtCategoryMap< JFluxHelper >::write ( std::ostream & out ) const

inlinefinaloverride

Write event-weight factor to output.

Parameters

out	output stream

Returns: output stream

Definition at line 761 of file JEvtCategoryMap.hh.

     {
       return out << getProperties(JEquationParameters("=", "\n", "./", "#"));
     }

◆ 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 JTOOLS::JMultiMapTransformer< N, JArgument_t >::JMultiMapDefaultTransformer, 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 >, and JPHYSICS::JPDFTransformer_t< JArgument_t >.

Definition at line 69 of file JClonable.hh.

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

Member Data Documentation

◆ oscProb

JOscProbHelper JAANET::JEvtCategoryMap< JFluxHelper >::oscProb

oscillation probability calculator

Definition at line 767 of file JEvtCategoryMap.hh.

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

JEvtCategoryMap.hh

Classes

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ JEvtCategoryMap_t

◆ map_type

◆ iterator

◆ const_iterator

◆ clone_type

Constructor & Destructor Documentation

◆ JEvtCategoryMap() [1/6]

◆ JEvtCategoryMap() [2/6]

◆ JEvtCategoryMap() [3/6]

◆ JEvtCategoryMap() [4/6]

◆ JEvtCategoryMap() [5/6]

◆ JEvtCategoryMap() [6/6]

Member Function Documentation

◆ insert() [1/2]

◆ insert() [2/2]

◆ getFactor()

◆ is_valid()

◆ getProperties() [1/2]

◆ getProperties() [2/2]

◆ read()

◆ write()

◆ clone()

Member Data Documentation

◆ oscProb