JAANET::JEvtCategoryMap< JFluxHelper > Class Reference

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.
	JEvtCategoryMap (const JOscProbHelper &oscProb)
	Constructor.
	JEvtCategoryMap (const JOscProbHelper &oscProb, const JEvtCategoryHelper &category, const JFluxHelper &factor)
	Constructor.
template<class ... Args>
	JEvtCategoryMap (const JOscProbHelper &oscProb, const JEvtCategoryHelper &category, const JFluxHelper &factor, const Args &...args)
	Constructor.
	JEvtCategoryMap (const JEvtCategoryHelper &category, const JFluxHelper &flux)
	Constructor.
template<class ... Args>
	JEvtCategoryMap (const JEvtCategoryHelper &category, const JFluxHelper &flux, const Args &...args)
	Constructor.
void	insert (const JEvtCategoryHelper &category, const JFluxHelper &flux)
	Insert pair of an event category and a flux function.
template<class ... Args>
void	insert (const JEvtCategoryHelper &category, const JFluxHelper &flux, const Args &...args)
	Insert pairs of event categories and flux functions.
const JOscProbHelper &	getOscProb () const
	Get oscillation probability calculator.
size_t	setOscProb (const JOscProbHelper &oscProb)
	Set oscillation probability calculator for all compatible flux factors.
double	getFactor (const Evt &evt) const override final
	Get weight factor of given event.
bool	is_valid () const override final
	Check whether this flux factor is valid.
JProperties	getProperties (const JEquationParameters &eqpars=JEvtWeightFactor::getEquationParameters()) override final
	Get properties of this class.
JProperties	getProperties (const JEquationParameters &eqpars=JEvtWeightFactor::getEquationParameters()) const override final
	Get properties of this class.
std::istream &	read (std::istream &in) override final
	Read map between event categories and flux factors.
std::ostream &	write (std::ostream &out) const override final
	Write event-weight factor to output.
virtual clone_type	clone () const override
	Get clone of this object.

Private Attributes
JOscProbHelper	oscProb
	oscillation probability calculator

Detailed Description

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

The input syntax follows the following scheme:

[oscillation probabilities configuration] (<categories> <flux>)+,

in which:

• oscillation probabilities configuration refers to an optional specification of the oscillation parameters, which can be given according to one of the following formats:
  1. <oscprob_file>;,
  2. oscprob=<oscprob_file>;,
  3. <oscprob_key>=<oscprob_value>[<end of line> <oscprob_key>=<oscprob_value>]+; or
  4. oscprob.<oscprob_key>=<oscprob_value>[<end of line> oscprob.<oscprob_key>=<oscprob_value>]+;, where:
  • oscprob_key refers to an oscillation probability calculator configuration key;
  • oscprob_value to an oscillation probability calculator configuration value and
  • oscprob_file to an oscillation probability calculator configuration file with key-value pairs,
• categories refers to a set of event categories, which can be specified according to one of the following formats:
  1. <PDG type> [ & <PDG type>]+;
  2. <key>=<value>[<end of line> <key>=<value>]+ [ & <key>=<value>[<end of line> <key>=<value>]+ ]+; where:
  • PDG type refers to a PDG identifier;
  • key to one of the data members of a data structure derived from JAANET::JEvtCategory and
  • value to the corresponding value;
• flux refers to a flux, which needs to be specified according to the following format:
  1. <flux identifier> [<flux arguments>];, where:
  • flux identifier refers to an event-weight flux identifier (c.f. JAANET::JFluxDictionary::factors); and
  • flux arguments to the list of arguments for the corresponding flux,
• each set of arguments for the oscillation probabilities, an event category or flux needs to be separated by a semi-colon (';') and
• multiple event categories can be specified as a group, separated by the '&' character.
  

Definition at line 607 of file JEvtCategoryMap.hh.

Member Typedef Documentation

JEvtCategoryMap_t

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

Definition at line 613 of file JEvtCategoryMap.hh.

map_type

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

Definition at line 615 of file JEvtCategoryMap.hh.

iterator

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

Definition at line 617 of file JEvtCategoryMap.hh.

const_iterator

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

Definition at line 618 of file JEvtCategoryMap.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

JEvtCategoryMap() [1/6]

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

inline

Default constructor.

Definition at line 625 of file JEvtCategoryMap.hh.

                      :
      map_type(),
      oscProb(JOscProbInterpolator<>())
    {}

JEvtCategoryMap() [2/6]

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

inline

Constructor.

Parameters

oscProb

oscillation probability calculator

Definition at line 636 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 649 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 668 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 685 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 703 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 718 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 733 of file JEvtCategoryMap.hh.

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

getOscProb()

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

inline

Get oscillation probability calculator.

Returns

oscillation probability calculator

Definition at line 747 of file JEvtCategoryMap.hh.

    {
      return oscProb;
    }

setOscProb()

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

inline

Set oscillation probability calculator for all compatible flux factors.

Parameters

oscProb

oscillation probability calculator

Returns

number of modified event weighters

Definition at line 759 of file JEvtCategoryMap.hh.

    {
      using namespace JPP;
      
      if (oscProb) {
      
        size_t n = 0;
      
        this->oscProb = oscProb;
      
        for (iterator i = this->begin(); i != this->end(); ++i) {
        
          JOscFlux* p = dynamic_cast<JOscFlux*>(&(i->second.getFlux()));
        
          if (p != NULL) {
            p->setOscProb(oscProb);
            ++n;
          }
        }
      
        return n;
        
      } else {
 
        THROW(JNullPointerException, "JEvtCategoryMap<JFluxHelper>::setOscProb(): Given oscillation probability function is invalid.");
      }
    }

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 794 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 813 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 828 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 839 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 851 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();
      }
 
      const streampos         pos   = is.tellg();
      const ios_base::iostate state = is.rdstate();
      
      // Read optional oscillation probability calculator configuration
 
      JToken<';'> token;
      is >> token;
        
      istringstream iss(token);
      iss >> oscProb;
 
      if (fail(iss)) {
        is.clear(state);
        is.seekg(pos);
      }
      
      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) {
          
          const JFluxHelper helper = dictionary[fluxID];
 
          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 918 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 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

oscProb

JOscProbHelper JAANET::JEvtCategoryMap< JFluxHelper >::oscProb

private

oscillation probability calculator

Definition at line 959 of file JEvtCategoryMap.hh.

---

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

• JEvtCategoryMap.hh