Helper class for event weighing. More...

#include <JEvtWeightHelper.hh>

Inheritance diagram for JAANET::JEvtWeightHelper:

Public Types
typedef JPointer< JClass_t >	pointer_type

typedef JStorage< JClass_t, JMemory_t >	storage_type

typedef JMemory_t< JClass_t >	memory_type

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

	JEvtWeightHelper (const JEvtWeight &weighter)
	Constructor. More...

void	configure (const JEvtWeight &weighter)
	Configuration. More...

bool	check (const JHead &header) const
	Check if a given header is consistent with this event weighter. More...

void	add (const JHead &header)
	Add header. More...

double	getWeight (const Evt &evt) const
	Get weight of given event. More...

double	getNormalisation () const
	Get event-weight normalisation. More...

double	getNormalisation (const Evt &evt) const
	Get event-weight normalisation. More...

const JSharedPointer &	getSharedPointer () const
	Get shared pointer. More...

JSharedPointer &	getSharedPointer ()
	Get shared pointer. More...

void	setSharedPointer (const JSharedPointer &object)
	Set shared pointer. More...

virtual void	reset () override
	Reset pointer. More...

template<class T >
void	reset (const JPointer< T > &pointer)
	Reset pointer. More...

void	reset (JClass_t *p)
	Reset pointer. More...

template<class T >
void	set (const JPointer< T > &pointer)
	Set pointer. More...

void	initialise ()
	Initialise counter. More...

void	attach (const JSharedCounter &object)
	Attach this counter to given shared counter object. More...

bool	detach ()
	Detach. More...

const int	getCount ()
	Get count. More...

void	recreate ()
	Recreate object in memory. More...

void	create ()
	Create object in memory. More...

void	create (const unsigned int size)
	Create array of objects in memory. More...

virtual JClass_t *	get () const override
	Get pointer. More...

JClass_t *const &	getReference () const
	Get rereference to internal pointer. More...

JClass_t *&	getReference ()
	Get rereference to internal pointer. More...

virtual bool	equals (const JAbstractPointer &object) const
	Equals. More...

bool	is_valid () const
	Check validity of pointer. More...

JClass_t *	operator-> () const
	Smart pointer operator. More...

	operator JClass_t * () const
	Type conversion operator. More...

Vec	coord_origin () const
	Get coordinate origin. More...

const JHead &	getHeader () const
	Get header. More...

JHead &	getHeader ()
	Get header. More...

void	setHeader (const JHead &header)
	Set header. More...

void	createUUID ()
	Create UUID if not already set. More...

template<class T >
bool	is_valid (T JHead::*pd) const
	Check validity of given data member in JHead. More...

template<class T >
const_iterator	pull (T JHead::*pd) const
	Pull given data member from Head. More...

template<class T >
iterator	pull (T JHead::*pd)
	Pull given data member from Head. More...

template<class T >
void	push (T JHead::*pd)
	Push given data member to Head. More...

void	push ()
	Push all data members to Head. More...

template<class T >
void	erase (T JHead::*pd)
	Reset and remove given data member from Head. More...

JHead	getMatch (const JHead &header) const
	Get matching fields. More...

size_t	getNumberOfMatches (const JHead &header) const
	Get number of matching fields. More...

bool	match (const JHead &header) const
	Test match of headers. More...

bool	less (const JHead &header) const
	Comparison of headers. More...

std::istream &	read (std::istream &in)
	Read header from input. More...

std::ostream &	write (std::ostream &out) const
	Write header to output. More...

std::ostream &	print (std::ostream &out) const
	Print header to output. More...

	ClassDef (JHead, 5)

	ClassDef (Head, 2)

bool	have_line (std::string key) const
	Check availability of data with the given key. More...

const std::string &	get_line (std::string key) const
	Get data with the given key. More...

std::string &	get_line (std::string key)
	Get data with the given key. More...

std::vector< std::string >	matching_keys (const std::string &tag) const
	In case of duplicate keys, they are internally stored in the map with a suffix "_n". More...

std::vector< std::string >	get_lines (const std::string &tag) const
	Get all data compatible with the given key. More...

std::string	set_line (std::string tag, std::string line, bool ensure_unique=true)
	Set data with the given tag. More...

std::string	get_field (std::string key, int idx) const
	Get data with the given key at given index. More...

std::string	get_field (std::string key, std::string field) const
	Get data with the given key at given field. More...

int	get_index_of_field (std::string key, std::string field) const
	Get index of data with the given key at given field. More...

void	set_field (std::string key, std::string field, std::string value)
	Set data with the given key at given field. More...

double	ngen () const
	Get the number of generated events needed for computing event rates. More...

double	daq_livetime () const
	Get the the live time provided by the DAQ sytstem (=number of processed timeslices * frametime). More...

double	mc_livetime () const
	Get the Monte Carlo live time. More...

Vec	translate () const
	Get coordinate translation. More...

Static Public Member Functions
template<class T >
static bool	is_valid (const T &object)
	Check validity of given data member in JHead. More...

static const size_t	getMaximumNumberOfMatches ()
	Get maximum number of matching header fields. More...

static JLANG::JEquationParameters &	getEquationParameters ()
	Get equation parameters corresponding to Monte Carlo ASCII format, i.e: More...

static void	setEquationParameters (const JLANG::JEquationParameters &equation)
	Set equation parameters. More...

static const std::map < std::string, std::vector < std::string > > &	_hdr_dict ()
	Get internal description of the known lines in header. More...

static void	actionAtFileOpen (int version)
	Action method at file open. More...

Public Attributes
JAANET::start_run	start_run

JUUID	UUID

JAANET::XSecFile	XSecFile

JAANET::drawing	drawing

std::vector< JAANET::detector >	detector

JAANET::muon_desc_file	muon_desc_file

JAANET::target	target

std::vector< JAANET::physics >	physics

std::vector< JAANET::simul >	simul

JAANET::calibration	calibration

JAANET::cut_primary	cut_primary

JAANET::cut_seamuon	cut_seamuon

JAANET::cut_in	cut_in

JAANET::cut_nu	cut_nu

JAANET::spectrum	spectrum

JAANET::can	can

JAANET::fixedcan	fixedcan

JAANET::genvol	genvol

JAANET::coord_origin	coord_origin

JAANET::genhencut	genhencut

JAANET::norma	norma

JAANET::livetime	livetime

JAANET::seabottom	seabottom

JAANET::depth	depth

JAANET::DAQ	DAQ

JAANET::K40	K40

JAANET::tgen	tgen

JAANET::time_interval	time_interval

JAANET::primary	primary

std::vector< JAANET::flux >	flux

JAANET::end_event	end_event

Static Public Attributes
static int	ROOT_IO_VERSION = -1
	Streamer version as obtained from ROOT file. More...

Protected Member Functions
void	set (const JSharedPointer &object)
	Set pointer. More...

virtual void	set (JClass_t *p) override
	Set pointer. More...

void	release ()
	Release memory. More...

Protected Attributes
JClass_t *	__p
	pointer to object More...

Private Attributes
int	counter

Detailed Description

Helper class for event weighing.

Definition at line 28 of file JEvtWeightHelper.hh.

Member Typedef Documentation

template<class JClass_t, template< class > class JMemory_t = JNew>

typedef JPointer<JClass_t> JLANG::JSharedPointer< JClass_t, JMemory_t >::pointer_type

inherited

Definition at line 34 of file JSharedPointer.hh.

template<class JClass_t, template< class > class JMemory_t = JNew>

typedef JStorage<JClass_t, JMemory_t> JLANG::JSharedPointer< JClass_t, JMemory_t >::storage_type

inherited

Definition at line 35 of file JSharedPointer.hh.

template<class JClass_t, template< class > class JMemory_t = JNew>

typedef JMemory_t<JClass_t> JLANG::JStorage< JClass_t, JMemory_t >::memory_type

inherited

Definition at line 33 of file JStorage.hh.

Constructor & Destructor Documentation

JAANET::JEvtWeightHelper::JEvtWeightHelper ( )

inline

Default constructor.

Definition at line 37 of file JEvtWeightHelper.hh.

                        :
       counter(0)
     {}

JAANET::JEvtWeightHelper::JEvtWeightHelper ( const JEvtWeight & weighter )

inline

Constructor.

Parameters

weighter event weighter

Definition at line 47 of file JEvtWeightHelper.hh.

                                                  :
       counter(0)
     {
       this->configure(weighter);
     }

Member Function Documentation

void JAANET::JEvtWeightHelper::configure ( const JEvtWeight & weighter )

inline

Configuration.

Parameters

weighter event weighter

Definition at line 59 of file JEvtWeightHelper.hh.

     {
       counter = 0;
       
       reset(weighter.clone());
     }

bool JAANET::JEvtWeightHelper::check ( const JHead & header ) const

inline

Check if a given header is consistent with this event weighter.

Parameters

header header

Returns: true if header is consistent with this event weighter; else false.

Definition at line 73 of file JEvtWeightHelper.hh.

     {
       return (is_valid() ? get()->check(header) : false);
     }

void JAANET::JEvtWeightHelper::add ( const JHead & header )

inline

Add header.

Parameters

header header

Definition at line 84 of file JEvtWeightHelper.hh.

     {
       using namespace JPP;
       
       if (check(header)) {
         
         if (counter == 0) {
           JHead::setHeader(header);
         } else {
           JHead::add(header);
         }
 
         ++counter;
         
         get()->configure(getHeader());
         
       } else {
         
         THROW(JNullPointerException, "JEvtWeightHelper::add(): headers do not match.");
       }
     }

double JAANET::JEvtWeightHelper::getWeight ( const Evt & evt ) const

inline

Get weight of given event.

Parameters

evt event

Returns: weight [Hz]

Definition at line 113 of file JEvtWeightHelper.hh.

     {
       using namespace JPP;
       
       if (is_valid()) {
         return get()->getWeight(evt);
       } else {
         THROW(JNullPointerException, "JEvtWeightHelper::getWeight(): Event weighter is null.");
       }
     }

double JAANET::JEvtWeightHelper::getNormalisation ( ) const

inline

Get event-weight normalisation.

Returns: event-weight normalisation

Definition at line 130 of file JEvtWeightHelper.hh.

     {
       using namespace JPP;
       
       if (is_valid()) {
         return get()->getNormalisation();
       } else {
         THROW(JNullPointerException, "JEvtWeightHelper::getWeightNormalisation(): Event weighter is null.");
       }
     }

double JAANET::JEvtWeightHelper::getNormalisation ( const Evt & evt ) const

inline

Get event-weight normalisation.

Parameters

evt event

Returns: event-weight normalisation

Definition at line 148 of file JEvtWeightHelper.hh.

     {
       using namespace JPP;
       
       if (is_valid()) {
         return get()->getNormalisation(evt);
       } else {
         THROW(JNullPointerException, "JEvtWeightHelper::getWeightNormalisation(): Event weighter is null.");
       }
     }

template<class JClass_t, template< class > class JMemory_t = JNew>

const JSharedPointer& JLANG::JSharedPointer< JClass_t, JMemory_t >::getSharedPointer ( ) const

inlineinherited

Get shared pointer.

Returns: this shared pointer

Definition at line 95 of file JSharedPointer.hh.

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

template<class JClass_t, template< class > class JMemory_t = JNew>

JSharedPointer& JLANG::JSharedPointer< JClass_t, JMemory_t >::getSharedPointer ( )

inlineinherited

Get shared pointer.

Returns: this shared pointer

Definition at line 106 of file JSharedPointer.hh.

     {
       return static_cast<JSharedPointer&>(*this);
     }

template<class JClass_t, template< class > class JMemory_t = JNew>

void JLANG::JSharedPointer< JClass_t, JMemory_t >::setSharedPointer ( const JSharedPointer< JClass_t, JMemory_t > & object )

inlineinherited

Set shared pointer.

Parameters

object shared pointer

Definition at line 117 of file JSharedPointer.hh.

     {
       if (this->get() != object.get()) {
 
         this->reset();
 
         if (object.is_valid()) {
           this->set(object);
         }
       }
     }

template<class JClass_t, template< class > class JMemory_t = JNew>

virtual void JLANG::JSharedPointer< JClass_t, JMemory_t >::reset ( )

inlineoverridevirtualinherited

Reset pointer.

The reference counter is decremented by one and the object pointed to previously is deleted when its reference counter is zero.

Reimplemented from JLANG::JStorage< JClass_t, JMemory_t >.

Definition at line 171 of file JSharedPointer.hh.

     {
       if (this->detach()) {
         storage_type::reset();
       }
 
       pointer_type::reset();
     }

template<class JClass_t>

template<class T >

void JLANG::JPointer< JClass_t >::reset ( const JPointer< T > & pointer )

inlineinherited

Reset pointer.

Parameters

pointer pointer to object

Definition at line 108 of file JPointer.hh.

     {
       this->reset(pointer.get());
     }

template<class JClass_t>

void JLANG::JAbstractPointer< JClass_t >::reset ( JClass_t * p )

inlineinherited

Reset pointer.

Parameters

p	pointer to object

Definition at line 94 of file JAbstractPointer.hh.

     {
       if (this->get() != p) {
 
         this->reset();
 
         if (p != NULL) {
           this->set(p);
         }
       }
     }

template<class JClass_t, template< class > class JMemory_t = JNew>

void JLANG::JSharedPointer< JClass_t, JMemory_t >::set ( const JSharedPointer< JClass_t, JMemory_t > & object )

inlineprotectedinherited

Set pointer.

The reference counter of the shared object pointed to is incremented by one.

Parameters

object shared pointer

Definition at line 188 of file JSharedPointer.hh.

     {
       pointer_type::set(object.get());
 
       this->attach(object);
     }

template<class JClass_t, template< class > class JMemory_t = JNew>

virtual void JLANG::JSharedPointer< JClass_t, JMemory_t >::set ( JClass_t * p )

inlineoverrideprotectedvirtualinherited

Set pointer.

The reference counter of the shared object pointed to is initialised to one.

Parameters

p	pointer to derived class object

Reimplemented from JLANG::JPointer< JClass_t >.

Definition at line 202 of file JSharedPointer.hh.

     {
       pointer_type::set(p);
 
       this->initialise();
     }

template<class JClass_t>

template<class T >

void JLANG::JPointer< JClass_t >::set ( const JPointer< T > & pointer )

inlineinherited

Set pointer.

Parameters

pointer pointer to object

Definition at line 96 of file JPointer.hh.

     {
       this->set(pointer.get());
     }

void JLANG::JSharedCounter::initialise ( )

inlineinherited

Initialise counter.

Definition at line 33 of file JSharedCounter.hh.

     {
       detach();
 
       counter = new int(1);
     }

void JLANG::JSharedCounter::attach ( const JSharedCounter & object )

inlineinherited

Attach this counter to given shared counter object.

Parameters

object shared counter

Definition at line 46 of file JSharedCounter.hh.

     {
       detach();
 
       counter = object.counter;
 
       if (counter != NULL) {
         ++(*counter);
       }
     }

bool JLANG::JSharedCounter::detach ( )

inlineinherited

Detach.

Returns: true if counter at zero; else false

Definition at line 63 of file JSharedCounter.hh.

     {
       if (counter != NULL) {
 
         if (--(*counter) == 0) {
 
           delete counter;
 
           counter = NULL;
 
           return true;
         }
 
         counter = NULL;
       }
 
       return false;
     }

const int JLANG::JSharedCounter::getCount ( )

inlineinherited

Get count.

Returns: count

Definition at line 88 of file JSharedCounter.hh.

     {
       return (counter != NULL ? *counter : 0);
     }

template<class JClass_t, template< class > class JMemory_t = JNew>

void JLANG::JStorage< JClass_t, JMemory_t >::recreate ( )

inlineinherited

Recreate object in memory.

A new object is created if no memory is allocated yet, else the previously created object is maintained.

Definition at line 57 of file JStorage.hh.

     {
       if (!this->is_valid()) {
         this->set(memory_type::create());
       }
     }

template<class JClass_t, template< class > class JMemory_t = JNew>

void JLANG::JStorage< JClass_t, JMemory_t >::create ( )

inlineinherited

Create object in memory.

The memory allocated by a previously created object will be released.

Definition at line 69 of file JStorage.hh.

     {
       this->reset(memory_type::create());
     }

template<class JClass_t, template< class > class JMemory_t = JNew>

void JLANG::JStorage< JClass_t, JMemory_t >::create ( const unsigned int size )

inlineinherited

Create array of objects in memory.

The memory allocated by previously created objects will be released.

Parameters

size	number of elements

Definition at line 81 of file JStorage.hh.

     {
       this->reset(memory_type::create(size));
     }

template<class JClass_t, template< class > class JMemory_t = JNew>

void JLANG::JStorage< JClass_t, JMemory_t >::release ( )

inlineprotectedinherited

Release memory.

Definition at line 91 of file JStorage.hh.

     { 
       memory_type::release(this->get());
     }

template<class JClass_t>

virtual JClass_t* JLANG::JPointer< JClass_t >::get ( ) const

inlineoverridevirtualinherited

Get pointer.

Returns: pointer to object

Implements JLANG::JAbstractPointer< JClass_t >.

Reimplemented in JLANG::JMultiPointer< JTypeList< JHead_t, JTail_t > >, JLANG::JMultiPointer< JClass_t >, JLANG::JMultiPointer< JTail_t >, JLANG::JMultiPointer< JHead_t >, JLANG::JMultiPointer< T >, and JLANG::JMultiPointer< JTypeList< JDAQEvent, JTypelist_t > >.

Definition at line 64 of file JPointer.hh.

     {
       return this->__p;
     }

template<class JClass_t>

JClass_t* const& JLANG::JPointer< JClass_t >::getReference ( ) const

inlineinherited

Get rereference to internal pointer.

Returns: reference to internal pointer

Definition at line 119 of file JPointer.hh.

     {
       return __p;
     }

template<class JClass_t>

JClass_t* & JLANG::JPointer< JClass_t >::getReference ( )

inlineinherited

Get rereference to internal pointer.

Returns: reference to internal pointer

Definition at line 130 of file JPointer.hh.

     {
       return __p;
     }

template<class JClass_t>

virtual bool JLANG::JAbstractPointer< JClass_t >::equals ( const JAbstractPointer< JClass_t > & object ) const

inlinevirtualinherited

Equals.

The equality is evaluated by comparison of the internal pointers.

Parameters

object abstract pointer

Returns: true if equals; else false

Definition at line 50 of file JAbstractPointer.hh.

     {
       return this->get() == object.get();
     }

template<class JClass_t>

bool JLANG::JAbstractPointer< JClass_t >::is_valid ( ) const

inlineinherited

Check validity of pointer.

Returns: true if pointer not null; else false

Definition at line 83 of file JAbstractPointer.hh.

     { 
       return this->get() != NULL; 
     }

template<class JClass_t>

JClass_t* JLANG::JAbstractPointer< JClass_t >::operator-> ( ) const

inlineinherited

Smart pointer operator.

Returns: pointer to object

Definition at line 112 of file JAbstractPointer.hh.

     { 
       if (!is_valid())
         THROW(JNullPointerException, "JAbstractPointer::operator->()");
       else
         return this->get();
     }

template<class JClass_t>

JLANG::JAbstractPointer< JClass_t >::operator JClass_t * ( ) const

inlineinherited

Type conversion operator.

Returns: pointer to object

Definition at line 126 of file JAbstractPointer.hh.

     {
       return this->get();
     }

Vec Head::coord_origin ( ) const

inlineinherited

Get coordinate origin.

Returns: position

Definition at line 398 of file Head.hh.

   {
     return Vec( stod( get_field("coord_origin", "x") ),
                 stod( get_field("coord_origin", "y") ),
                 stod( get_field("coord_origin", "z") ));
   }

const JHead& JAANET::JHead::getHeader ( ) const

inlineinherited

Get header.

Returns: header

Definition at line 1270 of file JHead.hh.

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

JHead& JAANET::JHead::getHeader ( )

inlineinherited

Get header.

Returns: header

Definition at line 1281 of file JHead.hh.

     {
       return static_cast<JHead&>(*this);
     }

void JAANET::JHead::setHeader ( const JHead & header )

inlineinherited

Set header.

Parameters

header header

Definition at line 1292 of file JHead.hh.

     {
       static_cast<JHead&>(*this) = header;
     }

void JAANET::JHead::createUUID ( )

inlineinherited

Create UUID if not already set.

Definition at line 1301 of file JHead.hh.

     {
       if (!is_valid(&JHead::UUID)) {
         this->UUID = JUUID::rndm();
         this->push(&JHead::UUID);
       }
     }

template<class T >

bool JAANET::JHead::is_valid ( T JHead::* pd ) const

inlineinherited

Check validity of given data member in JHead.

The validity is defined by the presence of the name of the data member in the underlying map.

Parameters

pd	pointer to data member

Returns: true if valid; else false

Definition at line 1319 of file JHead.hh.

     {
       return (this->pull(pd) != this->end());
     }

template<class T >

static bool JAANET::JHead::is_valid ( const T & object )

inlinestaticinherited

Check validity of given data member in JHead.

The validity is defined by difference between actual and default value.

Parameters

object object

Returns: true if valid; else false

Definition at line 1334 of file JHead.hh.

     {
       static const T value;
 
       return (object.less(value) || value.less(object));
     }

template<class T >

const_iterator JAANET::JHead::pull ( T JHead::* pd ) const

inlineinherited

Pull given data member from Head.

Parameters

pd	pointer to data member

Returns: iterator of Head

Definition at line 1349 of file JHead.hh.

     {
       return this->find(JROOT::getDataMember(pd)->GetName());
     }

template<class T >

iterator JAANET::JHead::pull ( T JHead::* pd )

inlineinherited

Pull given data member from Head.

Parameters

pd	pointer to data member

Returns: iterator of Head

Definition at line 1362 of file JHead.hh.

     {
       return this->find(JROOT::getDataMember(pd)->GetName());
     }

template<class T >

void JAANET::JHead::push ( T JHead::* pd )

inlineinherited

Push given data member to Head.

Parameters

pd	pointer to data member

Definition at line 1374 of file JHead.hh.

     {
       (*this)[JROOT::getDataMember(pd)->GetName()] = "";
     }

void JAANET::JHead::push ( )

inherited

Push all data members to Head.

Definition at line 28 of file JHead.cc.

   {
     using namespace std;
     using namespace JPP;
 
     JRootReadableClass cls(*this);
 
     unique_ptr<TIterator> i(cls.getClass()->GetListOfDataMembers()->MakeIterator());
 
     for (const TDataMember* p; (p = (const TDataMember*) i->Next()) != NULL; ) {
       if (!JRootClass::is_static(*p)) {
         if (this->count(p->GetName()) == 0) {
           (*this)[p->GetName()] = "";
         }
       }
     }
   }

template<class T >

void JAANET::JHead::erase ( T JHead::* pd )

inlineinherited

Reset and remove given data member from Head.

Parameters

pd	pointer to data member

Definition at line 1392 of file JHead.hh.

     {
       this->*pd = T();
       
       iterator p = this->pull(pd);
 
       if (p != this->end()) {
         static_cast<Head*>(this)->erase(p);
       }
     }

JHead JAANET::JHead::getMatch ( const JHead & header ) const

inlineinherited

Get matching fields.

Parameters

header header

Returns: header with matching fields

Definition at line 1410 of file JHead.hh.

     {
 #define IF_MATCH(A, B, C, D)            \
       if (match(B,C,D)) { A.push(D);  } \
       else              { A.erase(D); }
       
       JHead buffer(*this);
 
       buffer.clear();
 
       buffer.createUUID();
 
       IF_MATCH(buffer, *this, header, &JHead::cut_primary);
       IF_MATCH(buffer, *this, header, &JHead::cut_seamuon);
       IF_MATCH(buffer, *this, header, &JHead::cut_in);
       IF_MATCH(buffer, *this, header, &JHead::cut_nu);
       IF_MATCH(buffer, *this, header, &JHead::simul);
       IF_MATCH(buffer, *this, header, &JHead::spectrum);
       IF_MATCH(buffer, *this, header, &JHead::can);
       IF_MATCH(buffer, *this, header, &JHead::fixedcan);
       IF_MATCH(buffer, *this, header, &JHead::genvol);
       IF_MATCH(buffer, *this, header, &JHead::coord_origin);
 
       IF_MATCH(buffer, *this, header, &JHead::norma);
       IF_MATCH(buffer, *this, header, &JHead::livetime);
 
       IF_MATCH(buffer, *this, header, &JHead::seabottom);
       IF_MATCH(buffer, *this, header, &JHead::depth);
       IF_MATCH(buffer, *this, header, &JHead::tgen);
       IF_MATCH(buffer, *this, header, &JHead::time_interval);
 
       IF_MATCH(buffer, *this, header, &JHead::primary);
       IF_MATCH(buffer, *this, header, &JHead::flux);
       IF_MATCH(buffer, *this, header, &JHead::DAQ);      
       IF_MATCH(buffer, *this, header, &JHead::K40);
 
       return buffer;
       
 #undef IF_MATCH
     }

size_t JAANET::JHead::getNumberOfMatches ( const JHead & header ) const

inlineinherited

Get number of matching fields.

Parameters

header header

Returns: number of matching header fields

Definition at line 1458 of file JHead.hh.

     {
       const JHead head = getMatch(header);
 
       return head.size();
     }

bool JAANET::JHead::match ( const JHead & header ) const

inlineinherited

Test match of headers.

Parameters

header second header

Returns: true if all header fields match; else false

Definition at line 1472 of file JHead.hh.

     {
       return getNumberOfMatches(header) == getNumberOfMatches(*this);
     }

bool JAANET::JHead::less ( const JHead & header ) const

inlineinherited

Comparison of headers.

Parameters

header header

Returns: true if this header less than given header; else false

Definition at line 1484 of file JHead.hh.

     {
 #define RETURN_IF_DIFFERENT(A, B)       \
       if (less(A,B)) { return true;  }  \
       if (less(B,A)) { return false; } 
 
       // compare physics
 
       RETURN_IF_DIFFERENT(this->physics,     header.physics);
       
       // compare simulation
       
       RETURN_IF_DIFFERENT(this->simul,       header.simul);
       
       // compare generation data
       
       RETURN_IF_DIFFERENT(this->primary,     header.primary);
       RETURN_IF_DIFFERENT(this->flux,        header.flux);
       RETURN_IF_DIFFERENT(this->spectrum,    header.spectrum);
       RETURN_IF_DIFFERENT(this->cut_primary, header.cut_primary);
       RETURN_IF_DIFFERENT(this->cut_seamuon, header.cut_seamuon);
       RETURN_IF_DIFFERENT(this->cut_in,      header.cut_in);
       RETURN_IF_DIFFERENT(this->cut_nu,      header.cut_nu);
       RETURN_IF_DIFFERENT(this->genvol,      header.genvol);
 
       // compare compatibility
 
       if (is_valid(this->livetime) == is_valid(header.livetime)  &&
           is_valid(this->DAQ)      == is_valid(header.DAQ)       &&
           is_valid(this->K40)      == is_valid(header.K40))      { 
         return false;
       }
 
       THROW(JException, "JHead::less() headers do not compare.");
 
 #undef RETURN_IF_DIFFERENT
     }

static const size_t JAANET::JHead::getMaximumNumberOfMatches ( )

inlinestaticinherited

Get maximum number of matching header fields.

Returns: maximum number of matching header fields

Definition at line 1618 of file JHead.hh.

     {
       static JHead header;
 
       header.push();
       
       static const size_t value = header.getNumberOfMatches(header);
       
       return value;
     }

static JLANG::JEquationParameters& JAANET::JHead::getEquationParameters ( )

inlinestaticinherited

Get equation parameters corresponding to Monte Carlo ASCII format, i.e:

   <key>: <value> [<value>]*
   <key>: <value> [<value>]*

Returns: equation parameters

Definition at line 1639 of file JHead.hh.

     {
       static JLANG::JEquationParameters parameters(":", "\n", "", "");
       
       return parameters;
     }

static void JAANET::JHead::setEquationParameters ( const JLANG::JEquationParameters & equation )

inlinestaticinherited

Set equation parameters.

Parameters

equation equation parameters

Definition at line 1652 of file JHead.hh.

     {
       getEquationParameters() = equation;
     }

std::istream & JAANET::JHead::read ( std::istream & in )

inherited

Read header from input.

Parameters

in	input stream

Returns: input stream

Definition at line 53 of file JHead.cc.

   {
     using namespace std;
     using namespace JPP;
 
     JStringStream is(in);
 
     if (getFileStatus(is.str().c_str())) {
       is.load();
     }
 
     JRootReader reader(is, JHead::getEquationParameters(), JAAnetDictionary::getInstance());
 
     JRootReadableClass cls(*this);
     
     for (JEquation equation; reader >> equation && equation.getKey() != end_event::Class_Name(); ) {
 
       JRedirectString redirect(reader, equation.getValue());
 
       const JRootReadableClass abc = cls.find(equation.getKey().c_str());
 
       if (abc.is_valid()) {
         reader.getObject(abc);
       }
 
       (*this)[equation.getKey()] = equation.getValue();
     }
 
     return in;
   }

std::ostream & JAANET::JHead::write ( std::ostream & out ) const

inherited

Write header to output.

Parameters

out	output stream

Returns: output stream

Definition at line 91 of file JHead.cc.

   {
     using namespace std;
     using namespace JPP;
 
     JRootWriter writer(out, JHead::getEquationParameters(), JAAnetDictionary::getInstance());
 
     JRootWritableClass cls(*this);
 
     unique_ptr<TIterator> i(cls.getClass()->GetListOfDataMembers()->MakeIterator());
 
     for (const TDataMember* p; (p = (const TDataMember*) i->Next()) != NULL; ) {
       if (!JRootClass::is_static(*p)) {
         if (this->find(p->GetName()) != this->end()                    ||
             cls.get(*p)              == JRootClass(&JHead::start_run)  ||
             cls.get(*p)              == JRootClass(&JHead::end_event)) {
           writer.put(p->GetName(), cls.get(*p), true);
         }
       }
     }
 
     return out << flush;
   }

std::ostream & JAANET::JHead::print ( std::ostream & out ) const

inherited

Print header to output.

Parameters

out	output stream

Returns: output stream

Definition at line 122 of file JHead.cc.

   {
     using namespace std;
     using namespace JPP;
 
     JRootWriter writer(out, JHead::getEquationParameters(), JAAnetDictionary::getInstance());
 
     JRootWritableClass cls(*this);
 
     unique_ptr<TIterator> i(cls.getClass()->GetListOfDataMembers()->MakeIterator());
 
     pair<string, JRootWritableClass> end_event("", this->end_event);
 
     for (const TDataMember* p; (p = (const TDataMember*) i->Next()) != NULL; ) {
       if (!JRootClass::is_static(*p)) {
         if (cls.get(*p) != JRootClass(&JHead::end_event)) 
           writer.put(p->GetName(), cls.get(*p), true);
         else
           end_event = make_pair(p->GetName(), cls.get(*p));
       }
     }
 
     for (JHead::const_iterator i = this->begin(); i != this->end(); ++i) {
       if (!cls.find(i->first.c_str()).is_valid()) {
         writer.put(i->first, i->second);
       }
     }
 
     writer.put(end_event.first, end_event.second, true);
 
     return out << flush;
   }

JAANET::JHead::ClassDef	(	JHead	,
		5
	)

inherited

Head::ClassDef	(	Head	,
		2
	)

inherited

bool Head::have_line ( std::string key ) const

inlineinherited

Check availability of data with the given key.

Parameters

key key

Returns: true if data are available; else false

Definition at line 78 of file Head.hh.

   {
     return count( key ) != 0;
   }

const std::string& Head::get_line ( std::string key ) const

inlineinherited

Get data with the given key.

This method throws a run-time exception if no data are available.

Parameters

key key

Returns: data

Definition at line 90 of file Head.hh.

   {
     return this->at(key);
   }

std::string& Head::get_line ( std::string key )

inlineinherited

Get data with the given key.

This method throws a run-time exception if no data are available.

Parameters

key key

Returns: data

Definition at line 102 of file Head.hh.

   {
     return this->at(key);
   }

std::vector< std::string> Head::matching_keys ( const std::string & tag ) const

inlineinherited

In case of duplicate keys, they are internally stored in the map with a suffix "_n".

This function returns all the keys that start with 'key' and end in "_n", with n an integer

Parameters

tag	tag (without suffix)

Definition at line 116 of file Head.hh.

   {
     std::vector< std::string> r;
 
     auto match = [&] (const std::string & key) {
 
       if (key == tag) return true;
 
       if ( key.find( tag ) != 0 ) return false;
 
       // what is left should be of the form _d(ddd)
       std::string left = key.substr( tag.length(), key.length() );
       if (left.length() < 2 || left[0] != '_' ) return false ;
       for ( unsigned i = 1; i < left.length(); i++ )
       {
         if (!std::isdigit( left[i] )) return false ;
       }
       return true;
     };
 
     for ( auto& p : *this )
     {
       if ( match( p.first ) ) r.push_back( p.first );
     }
 
     return r;
   }

std::vector< std::string > Head::get_lines ( const std::string & tag ) const

inlineinherited

Get all data compatible with the given key.

This means all data that is internally stored with "key_n", with n an integer
This method throws a run-time exception if no data are available.

Parameters

tag	tag (without suffix)

Returns: data

Definition at line 155 of file Head.hh.

   {
     std::vector< std::string > r;
 
     for ( auto& key : matching_keys( tag ) ) {
       r.push_back( get_line( key ) );
     }
 
     return r;
   }

std::string Head::set_line	(	std::string	tag,
		std::string	line,
		bool	ensure_unique = `true`
	)

inlineinherited

Set data with the given tag.

The function will return the actual key that is used internally to store the result, which is equal to the tag with an optional "_n" added to ensure uniqueness.

Parameters

tag	tag
line	data
ensure_unique	add '_n' (with n an integer) to the tag if it would overwrite an existing key.

Definition at line 177 of file Head.hh.

   {
     std::string k = tag;
 
     if (ensure_unique)
       for (int i = 1; find(k) != end() ; i++)
       {
         k = tag + "_" + std::to_string(i);
       }
 
     std::map<std::string, std::string>::operator[]( k ) = line;
     return k;
   }

std::string Head::get_field	(	std::string	key,
		int	idx
	)		const

inlineinherited

Get data with the given key at given index.

This method throws a run-time exception if no data are available.

Parameters

key	key
idx	index

Returns: data

Definition at line 199 of file Head.hh.

   {
     using namespace std;
 
     vector<string> v = splitstring( get_line(key) );
 
     if ( idx < 0 || idx >= int ( v.size() ) )
     {
       THROW(Exception, "Cannot find word number " << idx << " in line " << get_line(key) << " for key: " << key);
     }
     return v[idx];
   }

std::string Head::get_field	(	std::string	key,
		std::string	field
	)		const

inlineinherited

Get data with the given key at given field.

This method throws a run-time exception if no field is available.

Note that this method uses the dictionary define in method Head::_hdr_dict.

Parameters

key	key
field	field

Returns: data

Definition at line 241 of file Head.hh.

   {
     int idx = get_index_of_field(key, field);
 
     if ( idx == -1 )
     {
       THROW(Exception, "Failed to find" << key << " " << field);
     }
 
     return get_field( key, idx );
   }

int Head::get_index_of_field	(	std::string	key,
		std::string	field
	)		const

inlineinherited

Get index of data with the given key at given field.

Note that this method uses the dictionary define in method Head::_hdr_dict.

Parameters

key	key
field	field

Returns: index (-1 if not present)

Definition at line 221 of file Head.hh.

   {
     auto& d = _hdr_dict();
     if ( d.count(key) == 0 ) return -1;
     auto v = d.at(key);
     auto i = std::find (v.begin(), v.end(), field );
     if (i == v.end()) return -1;
     return i - v.begin();
   }

void Head::set_field	(	std::string	key,
		std::string	field,
		std::string	value
	)

inlineinherited

Set data with the given key at given field.

This method throws a run-time exception if no field available.

Note that this method uses the dictionary define in method Head::_hdr_dict.

Parameters

key	key
field	field
value	vakue

Definition at line 264 of file Head.hh.

   {
     using namespace std;
 
     if ( field == "" ) get_line( key ) = value;
 
     int idx = get_index_of_field( key, field );
 
     if ( idx < 0 )
     {
       THROW(Exception, "GFailed to find field in header line: " << key << " " << field);
     }
 
     vector<string> vals = splitstring( get_line( key ) );
 
     // if the fields before do not exist, add padding
     while ( int( vals.size() ) <= idx ) vals.push_back("0");
 
     vals[idx] = value;
     ostringstream ss;
 
     for (unsigned i = 0; i < vals.size() ; i++ )
     {
       ss << vals[i];
       if ( i != vals.size() - 1) ss << " ";
     }
     set_line( key, ss.str() );
 
   }

static const std::map<std::string, std::vector<std::string> >& Head::_hdr_dict ( )

inlinestaticinherited

Get internal description of the known lines in header.

Returns: internal dictionary

Definition at line 316 of file Head.hh.

   {
     using namespace std;
 
     // map with, for each tag (key), a vector of field-names
 
     static map<string, vector<string> > r;
     if ( r.size() > 0 ) return r;
 
     string desc =
       "DAQ:livetime\n"
       "cut_primary cut_seamuon cut_in cut_nu:Emin Emax cosTmin cosTmax\n"
       "generator physics simul:program version date time\n"
       "seed:program level iseed\n"
       "PM1_type_area:type area TTS\n"
       "PDF:i1 i2\n"
       "model:interaction muon scattering numberOfEnergyBins\n"
       "can:zmin zmax r\n"
       "genvol:zmin zmax r volume numberOfEvents\n"
       "merge:time gain\n"
       "coord_origin:x y z\n"
       "translate:x y z\n"
       "genhencut:gDir Emin\n"
       "k40:rate time\n"               // note lower-case k  
       "K40:livetime\n"                // note capital K
       "norma:primaryFlux numberOfPrimaries\n"
       "livetime:numberOfSeconds errorOfSeconds\n"
       "flux:type key file_1 file_2\n"
       "spectrum:alpha\n"
       "fixedcan:xcenter ycenter zmin zmax radius\n"
       "start_run:run_id";
 
     for ( auto line : splitstring(desc, '\n') )
     {
       auto v = splitstring( line, ':');
 
       vector< string > fields = splitstring( v[1] );
       for ( auto key : splitstring( v[0] ) )
       {
         r[key] = fields;
       }
     }
     return r;
   }

double Head::ngen ( ) const

inlineinherited

Get the number of generated events needed for computing event rates.

Returns: number of events

Definition at line 367 of file Head.hh.

   {
     return stod ( get_field("genvol", "numberOfEvents") );
   }

double Head::daq_livetime ( ) const

inlineinherited

Get the the live time provided by the DAQ sytstem (=number of processed timeslices * frametime).

Returns: live time [s]

Definition at line 377 of file Head.hh.

   {
     return stod ( get_field("DAQ", "livetime") );
   }

double Head::mc_livetime ( ) const

inlineinherited

Get the Monte Carlo live time.

Returns: live time [s]

Definition at line 388 of file Head.hh.

   {
     return stod ( get_field("livetime", "numberOfSeconds") );
   }

Vec Head::translate ( ) const

inlineinherited

Get coordinate translation.

Returns: translation

Definition at line 410 of file Head.hh.

   {
     return Vec( stod( get_field("translate", "x") ),
                 stod( get_field("translate", "y") ),
                 stod( get_field("translate", "z") ));
   }

static void Head::actionAtFileOpen ( int version )

inlinestaticinherited

Action method at file open.

Parameters

version version

Definition at line 424 of file Head.hh.

   {
     ROOT_IO_VERSION = version;
   }

Member Data Documentation

int JAANET::JEvtWeightHelper::counter

private

Definition at line 161 of file JEvtWeightHelper.hh.

template<class JClass_t>

JClass_t* JLANG::JPointer< JClass_t >::__p

protectedinherited

pointer to object

Definition at line 136 of file JPointer.hh.

JAANET::start_run JAANET::JHead::start_run

inherited

Definition at line 1580 of file JHead.hh.

JUUID JAANET::JHead::UUID

inherited

Definition at line 1581 of file JHead.hh.

JAANET::XSecFile JAANET::JHead::XSecFile

inherited

Definition at line 1582 of file JHead.hh.

JAANET::drawing JAANET::JHead::drawing

inherited

Definition at line 1583 of file JHead.hh.

std::vector<JAANET::detector> JAANET::JHead::detector

inherited

Definition at line 1584 of file JHead.hh.

JAANET::muon_desc_file JAANET::JHead::muon_desc_file

inherited

Definition at line 1585 of file JHead.hh.

JAANET::target JAANET::JHead::target

inherited

Definition at line 1586 of file JHead.hh.

std::vector<JAANET::physics> JAANET::JHead::physics

inherited

Definition at line 1587 of file JHead.hh.

std::vector<JAANET::simul> JAANET::JHead::simul

inherited

Definition at line 1588 of file JHead.hh.

JAANET::calibration JAANET::JHead::calibration

inherited

Definition at line 1589 of file JHead.hh.

JAANET::cut_primary JAANET::JHead::cut_primary

inherited

Definition at line 1590 of file JHead.hh.

JAANET::cut_seamuon JAANET::JHead::cut_seamuon

inherited

Definition at line 1591 of file JHead.hh.

JAANET::cut_in JAANET::JHead::cut_in

inherited

Definition at line 1592 of file JHead.hh.

JAANET::cut_nu JAANET::JHead::cut_nu

inherited

Definition at line 1593 of file JHead.hh.

JAANET::spectrum JAANET::JHead::spectrum

inherited

Definition at line 1594 of file JHead.hh.

JAANET::can JAANET::JHead::can

inherited

Definition at line 1595 of file JHead.hh.

JAANET::fixedcan JAANET::JHead::fixedcan

inherited

Definition at line 1596 of file JHead.hh.

JAANET::genvol JAANET::JHead::genvol

inherited

Definition at line 1597 of file JHead.hh.

JAANET::coord_origin JAANET::JHead::coord_origin

inherited

Definition at line 1598 of file JHead.hh.

JAANET::genhencut JAANET::JHead::genhencut

inherited

Definition at line 1599 of file JHead.hh.

JAANET::norma JAANET::JHead::norma

inherited

Definition at line 1600 of file JHead.hh.

JAANET::livetime JAANET::JHead::livetime

inherited

Definition at line 1601 of file JHead.hh.

JAANET::seabottom JAANET::JHead::seabottom

inherited

Definition at line 1602 of file JHead.hh.

JAANET::depth JAANET::JHead::depth

inherited

Definition at line 1603 of file JHead.hh.

JAANET::DAQ JAANET::JHead::DAQ

inherited

Definition at line 1604 of file JHead.hh.

JAANET::K40 JAANET::JHead::K40

inherited

Definition at line 1605 of file JHead.hh.

JAANET::tgen JAANET::JHead::tgen

inherited

Definition at line 1606 of file JHead.hh.

JAANET::time_interval JAANET::JHead::time_interval

inherited

Definition at line 1607 of file JHead.hh.

JAANET::primary JAANET::JHead::primary

inherited

Definition at line 1608 of file JHead.hh.

std::vector<JAANET::flux> JAANET::JHead::flux

inherited

Definition at line 1609 of file JHead.hh.

JAANET::end_event JAANET::JHead::end_event

inherited

Definition at line 1610 of file JHead.hh.

int Head::ROOT_IO_VERSION = -1

staticinherited

Streamer version as obtained from ROOT file.

Definition at line 429 of file Head.hh.

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

JEvtWeightHelper.hh

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation