JAANET::JHead Class Reference

Monte Carlo run header. More...

#include <JHead.hh>

Inheritance diagram for JAANET::JHead:

Public Member Functions
	JHead ()
	Default constructor. More...
	JHead (const Head &header)
	Copy constructor. More...
virtual	~JHead ()
	Virtual destructor. 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...
JHead &	add (const JHead &header)
	Addition 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)
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	coord_origin () const
	Get coordinate origin. More...
Vec	translate () const
	Get coordinate translation. More...
	ClassDef (Head, 2)

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...

Static Private Member Functions
template<class T >
static bool	less (const T &first, const T &second)
	Comparison. More...
template<class T >
static bool	match (const T &first, const T &second)
	Test match. More...
template<class T >
static bool	less (const std::vector< T > &first, const std::vector< T > &second)
	Comparison of containers. More...
template<class T >
static bool	match (const std::vector< T > &first, const std::vector< T > &second)
	Test is containers match. More...
template<class T >
static bool	match (const JHead &first, const JHead &second, T JHead::*pd)
	Test match of given data member of headers. More...

Friends
bool	operator== (const JHead &first, const JHead &second)
	Equal operator. More...
bool	operator< (const JHead &first, const JHead &second)
	Less than operator. More...

Detailed Description

Monte Carlo run header.

This class extends the Head class so that the data from specific tags can be promoted to concrete data types.

Note that for the copy of new JHead data (e.g. data not obtained via a previous JAANET::copy) to become effective, the key words in the corresponding map of the Head class should be set.
To this end, member method JHead::push can be used.

Definition at line 1234 of file JHead.hh.

Constructor & Destructor Documentation

JHead() [1/2]

JAANET::JHead::JHead ( )

inline

Default constructor.

Definition at line 1241 of file JHead.hh.

    {
      createUUID();
    }

JHead() [2/2]

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

inline

Copy constructor.

Parameters

header

header

Definition at line 1252 of file JHead.hh.

    {
      copy(header, *this);
    }

~JHead()

virtual JAANET::JHead::~JHead ( )

inlinevirtual

Virtual destructor.

Definition at line 1261 of file JHead.hh.

    {}

Member Function Documentation

getHeader() [1/2]

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

inline

Get header.

Returns

header

Definition at line 1270 of file JHead.hh.

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

getHeader() [2/2]

JHead& JAANET::JHead::getHeader ( )

inline

Get header.

Returns

header

Definition at line 1281 of file JHead.hh.

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

setHeader()

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

inline

Set header.

Parameters

header

header

Definition at line 1292 of file JHead.hh.

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

createUUID()

void JAANET::JHead::createUUID ( )

inline

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

is_valid() [1/2]

template<class T >

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

inline

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

is_valid() [2/2]

template<class T >

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

inlinestatic

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

pull() [1/2]

template<class T >

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

inline

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

pull() [2/2]

template<class T >

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

inline

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

push() [1/2]

template<class T >

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

inline

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()] = "";
    }

push() [2/2]

void JAANET::JHead::push

(

)

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()] = "";
        }
      }
    }
  }

erase()

template<class T >

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

inline

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

getMatch()

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

inline

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::physics);
      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);
      IF_MATCH(buffer, *this, header, &JHead::target);
 
      return buffer;
      
#undef IF_MATCH
    }

getNumberOfMatches()

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

inline

Get number of matching fields.

Parameters

header

header

Returns

number of matching header fields

Definition at line 1460 of file JHead.hh.

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

match() [1/4]

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

inline

Test match of headers.

Parameters

header

second header

Returns

true if all header fields match; else false

Definition at line 1474 of file JHead.hh.

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

less() [1/3]

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

inline

Comparison of headers.

Parameters

header

header

Returns

true if this header less than given header; else false

Definition at line 1486 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);
      RETURN_IF_DIFFERENT(this->target,      header.target);
 
      // 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
    }

add()

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

inline

Addition of headers.

Parameters

header

header

Returns

this header

Definition at line 1532 of file JHead.hh.

    {
      if (match(header)) {
 
        this->createUUID();
        this->UUID = JUUID::rndm();
        
        genvol  .add(header.genvol);
        norma   .add(header.norma);
        livetime.add(header.livetime);
        DAQ     .add(header.DAQ);
        K40     .add(header.K40);
 
      } else {
 
        THROW(JException, "JHead::add() headers do not match.");
      }
 
      return *this;
    }

getMaximumNumberOfMatches()

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

inlinestatic

Get maximum number of matching header fields.

Returns

maximum number of matching header fields

Definition at line 1621 of file JHead.hh.

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

getEquationParameters()

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

inlinestatic

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

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

Returns

equation parameters

Definition at line 1642 of file JHead.hh.

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

setEquationParameters()

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

inlinestatic

Set equation parameters.

Parameters

equation

equation parameters

Definition at line 1655 of file JHead.hh.

    {
      getEquationParameters() = equation;
    }

read()

std::istream & JAANET::JHead::read

(

std::istream &

in

)

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

write()

std::ostream & JAANET::JHead::write

(

std::ostream &

out

)

const

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

print()

std::ostream & JAANET::JHead::print

(

std::ostream &

out

)

const

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

ClassDef() [1/2]

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

less() [2/3]

template<class T >

static bool JAANET::JHead::less ( const T &  first, const T &  second  )

inlinestaticprivate

Comparison.

Parameters

first	first object
second	second object

Returns

true if first less than second; else false

Definition at line 1699 of file JHead.hh.

    {
      return first.less(second);
    }

match() [2/4]

template<class T >

static bool JAANET::JHead::match ( const T &  first, const T &  second  )

inlinestaticprivate

Test match.

Parameters

first	first object
second	second object

Returns

true if matches; else false

Definition at line 1714 of file JHead.hh.

    {
      return first.match(second);
    }

less() [3/3]

template<class T >

static bool JAANET::JHead::less ( const std::vector< T > &  first, const std::vector< T > &  second  )

inlinestaticprivate

Comparison of containers.

It is assumed that the containers are ordered in the same way.

Parameters

first	first object
second	second object

Returns

true if first is less than second; else false

Definition at line 1730 of file JHead.hh.

    {
      if (first.size() == second.size()) {
 
        for (size_t i = 0; i != first.size(); ++i) {
          if (less(first[i], second[i])) {
            return true;
          }
        }
 
        return false;
 
      } else {
 
        return first.size() < second.size();
      }
    }

match() [3/4]

template<class T >

static bool JAANET::JHead::match ( const std::vector< T > &  first, const std::vector< T > &  second  )

inlinestaticprivate

Test is containers match.

It is assumed that the containers are ordered in the same way.

Parameters

first	first object
second	second object

Returns

true if matches; else false

Definition at line 1759 of file JHead.hh.

    {
      for (size_t i = 0; i != first.size() && i != second.size(); ++i) {
        if (!match(first[i], second[i])) {
          return false;
        }
      }
 
      return first.size() == second.size();
    }

match() [4/4]

template<class T >

static bool JAANET::JHead::match ( const JHead &  first, const JHead &  second, T JHead::*  pd  )

inlinestaticprivate

Test match of given data member of headers.

Parameters

first	first header
second	second header
pd	pointer to data member

Returns

true if matches; else false

Definition at line 1781 of file JHead.hh.

    {
      return (first .is_valid(pd) &&
              second.is_valid(pd) &&
              match(first.*pd, second.*pd));
    }

have_line()

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 77 of file Head.hh.

  {
    return count( key ) != 0;
  }

get_line() [1/2]

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 89 of file Head.hh.

  {
    return this->at(key);
  }

get_line() [2/2]

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 101 of file Head.hh.

  {
    return this->at(key);
  }

matching_keys()

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

get_lines()

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 154 of file Head.hh.

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

set_line()

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

get_field() [1/2]

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 198 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];
  }

get_field() [2/2]

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

get_index_of_field()

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

set_field()

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

_hdr_dict()

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

ngen()

double Head::ngen ( ) const

inlineinherited

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

Returns

number of events

Definition at line 366 of file Head.hh.

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

daq_livetime()

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 376 of file Head.hh.

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

mc_livetime()

double Head::mc_livetime ( ) const

inlineinherited

Get the Monte Carlo live time.

Returns

live time [s]

Definition at line 387 of file Head.hh.

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

coord_origin()

Vec Head::coord_origin ( ) const

inlineinherited

Get coordinate origin.

Returns

position

Definition at line 397 of file Head.hh.

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

translate()

Vec Head::translate ( ) const

inlineinherited

Get coordinate translation.

Returns

translation

Definition at line 409 of file Head.hh.

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

actionAtFileOpen()

static void Head::actionAtFileOpen ( int  version )

inlinestaticinherited

Action method at file open.

Parameters

version

version

Definition at line 423 of file Head.hh.

  {
    ROOT_IO_VERSION = version;
  }

ClassDef() [2/2]

Head::ClassDef ( Head  , 2    )

inherited

Friends And Related Function Documentation

operator==

bool operator== ( const JHead &  first, const JHead &  second  )

friend

Equal operator.

Note that this operator uses the JHead::match method.

Parameters

first	first header
second	second header

Returns

true if two headers are equal; else false

Definition at line 1563 of file JHead.hh.

    {
      return first.match(second);
    }

operator<

bool operator< ( const JHead &  first, const JHead &  second  )

friend

Less than operator.

Parameters

first	first header
second	second header

Returns

true if first header is less than second header; else false

Definition at line 1577 of file JHead.hh.

    {
      return first.less(second);
    }

Member Data Documentation

start_run

JAANET::start_run JAANET::JHead::start_run

Definition at line 1583 of file JHead.hh.

UUID

JUUID JAANET::JHead::UUID

Definition at line 1584 of file JHead.hh.

XSecFile

JAANET::XSecFile JAANET::JHead::XSecFile

Definition at line 1585 of file JHead.hh.

drawing

JAANET::drawing JAANET::JHead::drawing

Definition at line 1586 of file JHead.hh.

detector

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

Definition at line 1587 of file JHead.hh.

muon_desc_file

JAANET::muon_desc_file JAANET::JHead::muon_desc_file

Definition at line 1588 of file JHead.hh.

target

JAANET::target JAANET::JHead::target

Definition at line 1589 of file JHead.hh.

physics

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

Definition at line 1590 of file JHead.hh.

simul

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

Definition at line 1591 of file JHead.hh.

calibration

JAANET::calibration JAANET::JHead::calibration

Definition at line 1592 of file JHead.hh.

cut_primary

JAANET::cut_primary JAANET::JHead::cut_primary

Definition at line 1593 of file JHead.hh.

cut_seamuon

JAANET::cut_seamuon JAANET::JHead::cut_seamuon

Definition at line 1594 of file JHead.hh.

cut_in

JAANET::cut_in JAANET::JHead::cut_in

Definition at line 1595 of file JHead.hh.

cut_nu

JAANET::cut_nu JAANET::JHead::cut_nu

Definition at line 1596 of file JHead.hh.

spectrum

JAANET::spectrum JAANET::JHead::spectrum

Definition at line 1597 of file JHead.hh.

can

JAANET::can JAANET::JHead::can

Definition at line 1598 of file JHead.hh.

fixedcan

JAANET::fixedcan JAANET::JHead::fixedcan

Definition at line 1599 of file JHead.hh.

genvol

JAANET::genvol JAANET::JHead::genvol

Definition at line 1600 of file JHead.hh.

coord_origin

JAANET::coord_origin JAANET::JHead::coord_origin

Definition at line 1601 of file JHead.hh.

genhencut

JAANET::genhencut JAANET::JHead::genhencut

Definition at line 1602 of file JHead.hh.

norma

JAANET::norma JAANET::JHead::norma

Definition at line 1603 of file JHead.hh.

livetime

JAANET::livetime JAANET::JHead::livetime

Definition at line 1604 of file JHead.hh.

seabottom

JAANET::seabottom JAANET::JHead::seabottom

Definition at line 1605 of file JHead.hh.

depth

JAANET::depth JAANET::JHead::depth

Definition at line 1606 of file JHead.hh.

DAQ

JAANET::DAQ JAANET::JHead::DAQ

Definition at line 1607 of file JHead.hh.

K40

JAANET::K40 JAANET::JHead::K40

Definition at line 1608 of file JHead.hh.

tgen

JAANET::tgen JAANET::JHead::tgen

Definition at line 1609 of file JHead.hh.

time_interval

JAANET::time_interval JAANET::JHead::time_interval

Definition at line 1610 of file JHead.hh.

primary

JAANET::primary JAANET::JHead::primary

Definition at line 1611 of file JHead.hh.

flux

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

Definition at line 1612 of file JHead.hh.

end_event

JAANET::end_event JAANET::JHead::end_event

Definition at line 1613 of file JHead.hh.

ROOT_IO_VERSION

int Head::ROOT_IO_VERSION = -1

staticinherited

Streamer version as obtained from ROOT file.

Definition at line 428 of file Head.hh.

---

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

• JHead.hh
• JHead.cc