Head Struct Reference

The Head class reflects the header of Monte-Carlo event files, which consists of keys (also referred to as "tags") and values. More...

#include <Head.hh>

Inheritance diagram for Head:

Classes
struct	tags

Public Member Functions
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...
int	get_index_of_field (std::string key, std::string field) const
	Get index of data with the given key at given field. More...
std::string	get_field (std::string key, std::string field) const
	Get 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...
void	print (std::ostream &out=std::cout) const
	Print header. 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...
virtual	~Head ()
	ClassDef (Head, 2)

Static Public Member Functions
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...

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

Detailed Description

The Head class reflects the header of Monte-Carlo event files, which consists of keys (also referred to as "tags") and values.

Definition at line 65 of file Head.hh.

Constructor & Destructor Documentation

virtual Head::~Head ( )

inlinevirtual

Definition at line 417 of file Head.hh.

{}

Member Function Documentation

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

inline

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

inline

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 )

inline

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

inline

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

inline

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  )

inline

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

inline

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

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

inline

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

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

inline

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

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

inline

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

  }

void Head::print ( std::ostream &  out = std::cout ) const

inline

Print header.

Parameters

out	output stream

Definition at line 299 of file Head.hh.

  {
    if (count("start_run")) out << "start_run: " << at("start_run") << std::endl;

    for ( auto& p : *this )
    {
      if ( p.first == "start_run" || p.first == "end_event" ) continue;
      out << p.first << ": " << p.second << std::endl ;
    }
    out << "end_event:" << std::endl;
  }

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

inlinestatic

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

inline

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

inline

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

inline

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::coord_origin ( ) const

inline

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

Vec Head::translate ( ) const

inline

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 )

inlinestatic

Action method at file open.

Parameters

version

version

Definition at line 424 of file Head.hh.

  {
    ROOT_IO_VERSION = version;
  }

Head::ClassDef	(	Head	,
		2
	)

Member Data Documentation

int Head::ROOT_IO_VERSION = -1

static

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 files:

• Head.hh
• Head.cc