Auxiliary class for organising Monte Carlo file scanners associated with event weighters. More...

#include <JEvtWeightFileScannerSet.hh>

Inheritance diagram for JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >:

Public Types
typedef JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >	filescannerset_type

typedef JEvtWeightFileScanner< JFileScanner_t >	filescanner_type

typedef filescanner_type::input_type	input_type

typedef std::vector< filescanner_type >::value_type	value_type

typedef std::vector< filescanner_type >::reference	reference

typedef std::vector< filescanner_type >::const_reference	const_reference

typedef std::vector< filescanner_type >::const_iterator	const_iterator

typedef std::vector< filescanner_type >::iterator	iterator

typedef std::vector< filescanner_type >::const_reverse_iterator	const_reverse_iterator

typedef std::vector< filescanner_type >::reverse_iterator	reverse_iterator

Public Member Functions
	JEvtWeightFileScannerSet ()
	Default constructor.

	JEvtWeightFileScannerSet (const input_type &input)
	Constructor.

size_t	put (const input_type &input)
	Put files.

bool	put (const std::string &input)
	Put file.

std::string	getUniqueIdentifier (const_iterator p) const
	Get unique identifier for a file-scanner contained within this set of event-weighter-associated file-scanners.

const_reference	find (const JHead &head) const
	Find file scanner compatible with a given header.

size_t	setEvtWeightFactor (const JEvtCategoryHelper &category, const JEvtWeightFactorHelper &factor)
	Set event-weighting factor for all MC-files corresponding to a given PDG code.

size_t	setEvtWeightFactor (const JEvtCategorySet &categories, const JEvtWeightFactorHelper &factor, const bool requireAll=false)
	Set event-weight factor of all MC-files corresponding to a given set of event categories.

template<class JEvtWeightFactorHelper_t >
size_t	setEvtWeightFactor (const JEvtCategoryMap< JEvtWeightFactorHelper_t > &object, const bool requireAll=false)
	Set event-weight factor of all MC-files according to a given map between event categories and event-weight factors.

size_t	setFlux (const JEvtCategoryHelper &category, const JFluxHelper &flux)
	Set flux function for all MC-files corresponding to a given event category.

size_t	setFlux (const JEvtCategorySet &categories, const JFluxHelper &flux, const bool requireAll=false)
	Set flux function of all MC-files corresponding to a given set of event categories.

size_t	setFlux (const JEvtCategoryMap< JFluxHelper > &object, const bool requireAll=false)
	Set event-weight factor of all MC-files according to a given map between event categories and event-weight factors.

Public Attributes
JComparator_t	compare
	Function object for comparison of headers.

Detailed Description

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>
struct JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >

Auxiliary class for organising Monte Carlo file scanners associated with event weighters.

Note: The template class JFileScanner_t must be derived from JMultipleFileScanner<Evt>.

Definition at line 59 of file JEvtWeightFileScannerSet.hh.

Member Typedef Documentation

◆ filescannerset_type

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

JEvtWeightFileScannerSet<JFileScanner_t, JComparator_t> JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::filescannerset_type

Definition at line 62 of file JEvtWeightFileScannerSet.hh.

◆ filescanner_type

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

JEvtWeightFileScanner<JFileScanner_t> JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::filescanner_type

Definition at line 63 of file JEvtWeightFileScannerSet.hh.

◆ input_type

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

filescanner_type::input_type JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::input_type

Definition at line 65 of file JEvtWeightFileScannerSet.hh.

◆ value_type

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

std::vector<filescanner_type>::value_type JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::value_type

Definition at line 67 of file JEvtWeightFileScannerSet.hh.

◆ reference

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

std::vector<filescanner_type>::reference JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::reference

Definition at line 68 of file JEvtWeightFileScannerSet.hh.

◆ const_reference

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

std::vector<filescanner_type>::const_reference JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::const_reference

Definition at line 69 of file JEvtWeightFileScannerSet.hh.

◆ const_iterator

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

std::vector<filescanner_type>::const_iterator JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::const_iterator

Definition at line 71 of file JEvtWeightFileScannerSet.hh.

◆ iterator

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

std::vector<filescanner_type>::iterator JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::iterator

Definition at line 72 of file JEvtWeightFileScannerSet.hh.

◆ const_reverse_iterator

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

std::vector<filescanner_type>::const_reverse_iterator JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::const_reverse_iterator

Definition at line 73 of file JEvtWeightFileScannerSet.hh.

◆ reverse_iterator

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

std::vector<filescanner_type>::reverse_iterator JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::reverse_iterator

Definition at line 74 of file JEvtWeightFileScannerSet.hh.

Constructor & Destructor Documentation

◆ JEvtWeightFileScannerSet() [1/2]

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::JEvtWeightFileScannerSet ( )

inline

Default constructor.

Definition at line 81 of file JEvtWeightFileScannerSet.hh.

82 {}

◆ JEvtWeightFileScannerSet() [2/2]

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::JEvtWeightFileScannerSet ( const input_type & input )

inline

Constructor.

Parameters

input input files

Definition at line 90 of file JEvtWeightFileScannerSet.hh.

    {
      put(input);
    }

Member Function Documentation

◆ put() [1/2]

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

size_t JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::put ( const input_type & input )

inline

Put files.

Parameters

input input files

Returns: number of added files

Definition at line 102 of file JEvtWeightFileScannerSet.hh.

    {
      size_t n = 0;
      
      for (typename input_type::const_iterator i = input.begin(); i != input.end(); ++i) {
        n += size_t(this->put(*i));
      }
 
      return n;
    }

◆ put() [2/2]

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

bool JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::put ( const std::string & input )

inline

Put file.

Parameters

input input file

Returns: true if successfully added; else false.

Definition at line 120 of file JEvtWeightFileScannerSet.hh.

    {
      using namespace std;
      using namespace JPP;
      
      const JHead& head = getHeader(input);
 
      iterator i = lower_bound(this->begin(),  this->end(),  head,
                               make_comparator(&JHead::getHeader, compare));
 
      if (i == this->end() || !i->getHeader().match(head)) {
        i = this->insert(i, value_type(getEventWeighter(head)));
      }
 
      return i->put(input);
    }

◆ getUniqueIdentifier()

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

std::string JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::getUniqueIdentifier ( const_iterator p ) const

inline

Get unique identifier for a file-scanner contained within this set of event-weighter-associated file-scanners.

Parameters

p	iterator to contained file-scanner

Returns: unique identifier of contained file-scanner

Definition at line 144 of file JEvtWeightFileScannerSet.hh.

    {
      using namespace std;
      using namespace JPP;
 
      static const char SEPARATOR = '.';
 
      string name  = p->getProgramName();
      int    index = 0;
      
      for (const_iterator i = this->cbegin(); i != this->cend() && i != p; ++i) {
        if (i->getProgramName() == name) {
          ++index;
        }
      }
      
      return MAKE_STRING(name << SEPARATOR << index);
    }

◆ find()

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

const_reference JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::find ( const JHead & head ) const

inline

Find file scanner compatible with a given header.

Parameters

head header

Returns: file scanner

Definition at line 170 of file JEvtWeightFileScannerSet.hh.

    {
      using namespace JPP;
      
      for (const_iterator i = this->begin(); i != this->end(); ++i) {
        if (i->match(head)) {
          return *i;
        }
      }
 
      THROW(JValueOutOfRange, "JEvtWeightFileScannerSet::get(): No corresponding scanner found for given header.");
    }

◆ setEvtWeightFactor() [1/3]

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

size_t JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::setEvtWeightFactor	(	const JEvtCategoryHelper &	category,
		const JEvtWeightFactorHelper &	factor )

inline

Set event-weighting factor for all MC-files corresponding to a given PDG code.

Parameters

category	event category
factor	event-weight factor

Returns: number of modified event weighters

Definition at line 191 of file JEvtWeightFileScannerSet.hh.

    {
      using namespace std;
      using namespace JPP;
 
      size_t n = 0;
        
      for (iterator i = this->begin(); i != this->end(); ++i) {
        n += (size_t) i->setEvtWeightFactor(category, factor);
      }
 
      return n;
    }

◆ setEvtWeightFactor() [2/3]

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

size_t JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::setEvtWeightFactor	(	const JEvtCategorySet &	categories,
		const JEvtWeightFactorHelper &	factor,
		const bool	requireAll = false )

inline

Set event-weight factor of all MC-files corresponding to a given set of event categories.

If the boolean requireAll argument is set to true,
the given event-weighting factor will only be assigned to those files
whose header matches all of the specified event categories.

Parameters

categories	set of event categories
factor	event-weight factor
requireAll	toggle requirement that the file headers match all given event categories

Returns: number of modified event weighters

Definition at line 219 of file JEvtWeightFileScannerSet.hh.

    {
      using namespace std;
      using namespace JPP;
 
      size_t n = 0;
 
      if (requireAll) {
 
        for (iterator i = this->begin(); i != this->end(); ++i) {
          n += (size_t) i->setEvtWeightFactor(categories, factor);
        }
        
      } else {
 
        for (iterator i = this->begin(); i != this->end(); ++i) {
 
          bool isSet = false;
          
          for (JEvtCategorySet::const_iterator j = categories.cbegin(); j != categories.cend() && !isSet; ++j) {
            isSet = i->setEvtWeightFactor(*j, factor);
          }
 
          n += (size_t) isSet;
        }
      }
      
      return n;
    }

◆ setEvtWeightFactor() [3/3]

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

template<class JEvtWeightFactorHelper_t >

size_t JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::setEvtWeightFactor	(	const JEvtCategoryMap< JEvtWeightFactorHelper_t > &	object,
		const bool	requireAll = false )

inline

Set event-weight factor of all MC-files according to a given map between event categories and event-weight factors.

The template argument refers either to the class JAANET::JEvtWeightFactorHelper or JAANET::JFluxHelper.

If the boolean requireAll argument is set to true,
the given event-weighting factor will only be assigned to those files
whose header matches all of the specified event categories.

Parameters

object	map between event categories and event-weight factors
requireAll	toggle requirement that the file headers match all given event categories

Returns: number of modified event weighters

Definition at line 266 of file JEvtWeightFileScannerSet.hh.

    {
      using namespace std;
      using namespace JPP;
 
      size_t n = 0;
 
      if (requireAll) {
 
        for (iterator i = this->begin(); i != this->end(); ++i) {
          n += (size_t) i->template setEvtWeightFactor<JEvtWeightFactorHelper_t>(object);
        }
        
      } else {
 
        for (iterator i = this->begin(); i != this->end(); ++i) {
 
          bool isSet = false;
          
          for (typename JEvtCategoryMap<JEvtWeightFactorHelper_t>::const_iterator j = object.cbegin(); j != object.cend() && !isSet; ++j) {
            isSet = i->setEvtWeightFactor(j->first, j->second);
          }
 
          n += (size_t) isSet;
        }
      }
      
      return n;
    }

◆ setFlux() [1/3]

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

size_t JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::setFlux	(	const JEvtCategoryHelper &	category,
		const JFluxHelper &	flux )

inline

Set flux function for all MC-files corresponding to a given event category.

Parameters

category	event category
flux	flux function

Returns: number of modified event weighters

Definition at line 305 of file JEvtWeightFileScannerSet.hh.

    {
      return setEvtWeightFactor(category, flux);
    }

◆ setFlux() [2/3]

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

size_t JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::setFlux	(	const JEvtCategorySet &	categories,
		const JFluxHelper &	flux,
		const bool	requireAll = false )

inline

Set flux function of all MC-files corresponding to a given set of event categories.

If the boolean requireAll argument is set to true, the given flux function will only be assigned to those files
whose header lists all of the specified PDG codes as primaries.

Parameters

categories	set of event categories
flux	flux function
requireAll	toggle requirement that each file header must contain every given PDG code.

Returns: number of modified event weighters

Definition at line 324 of file JEvtWeightFileScannerSet.hh.

    {
      return setEvtWeightFactor(categories, flux, requireAll);
    }

◆ setFlux() [3/3]

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

size_t JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::setFlux	(	const JEvtCategoryMap< JFluxHelper > &	object,
		const bool	requireAll = false )

inline

Set event-weight factor of all MC-files according to a given map between event categories and event-weight factors.

If the boolean requireAll argument is set to true, the given flux function will only be assigned to those files
whose header matches all of the specified event categories.

Parameters

object	map between event categories and flux functions
requireAll	toggle requirement that the file headers match all given event categories

Returns: number of modified event weighters

Definition at line 343 of file JEvtWeightFileScannerSet.hh.

    {
      return setEvtWeightFactor(object, requireAll);
    }

Member Data Documentation

◆ compare

template<class JFileScanner_t = JMultipleFileScanner<Evt>, class JComparator_t = std::less<JHead>>

JComparator_t JSUPPORT::JEvtWeightFileScannerSet< JFileScanner_t, JComparator_t >::compare

Function object for comparison of headers.

Definition at line 353 of file JEvtWeightFileScannerSet.hh.

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

JEvtWeightFileScannerSet.hh

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ filescannerset_type

◆ filescanner_type

◆ input_type

◆ value_type

◆ reference

◆ const_reference

◆ const_iterator

◆ iterator

◆ const_reverse_iterator

◆ reverse_iterator

Constructor & Destructor Documentation

◆ JEvtWeightFileScannerSet() [1/2]

◆ JEvtWeightFileScannerSet() [2/2]

Member Function Documentation

◆ put() [1/2]

◆ put() [2/2]

◆ getUniqueIdentifier()

◆ find()

◆ setEvtWeightFactor() [1/3]

◆ setEvtWeightFactor() [2/3]

◆ setEvtWeightFactor() [3/3]

◆ setFlux() [1/3]

◆ setFlux() [2/3]

◆ setFlux() [3/3]

Member Data Documentation

◆ compare