Jpp  15.0.5
the software that should make you happy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Public Attributes | Static Private Member Functions | Friends | List of all members
JAANET::JHead Struct Reference

Monte Carlo run header. More...

#include <JHead.hh>

Inheritance diagram for JAANET::JHead:
Head TObject std::map< std::string, std::string > JAANET::JEvtWeightHelper JSUPPORT::JEvtWeightFileScanner< JFileScanner_t >

Public Member Functions

 JHead ()
 Default constructor. More...
 
 JHead (const Head &header)
 Copy constructor. More...
 
virtual ~JHead ()
 Virtual destructor. More...
 
const JHeadgetHeader () const
 Get header. More...
 
JHeadgetHeader ()
 Get header. More...
 
void setHeader (const JHead &header)
 Set header. 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...
 
template<class T >
void erase (T JHead::*pd)
 Remove given data member from Head. More...
 
bool match (const JHead &header) const
 Test match of headers. More...
 
bool less (const JHead &header) const
 Comparison of headers. More...
 
JHeadadd (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, 3)
 
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 JLANG::JEquationParametersgetEquationParameters ()
 Get equation parameters corresponding to Monte Carlo ASCII format, i.e: More...
 
static void setEquationParameters (const JLANG::JEquationParameters &equation)
 Set equation parameters. More...
 
static std::map< std::string,
std::vector< std::string > > & 
_hdr_dict ()
 Get internal description of the known lines in header. More...
 

Public Attributes

JAANET::start_run start_run
 
JAANET::XSecFile XSecFile
 
JAANET::drawing drawing
 
std::vector< JAANET::detectordetector
 
JAANET::muon_desc_file muon_desc_file
 
JAANET::target target
 
std::vector< JAANET::physicsphysics
 
std::vector< JAANET::simulsimul
 
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::tgen tgen
 
JAANET::time_interval time_interval
 
JAANET::primary primary
 
std::vector< JAANET::fluxflux
 
JAANET::end_event end_event
 

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 1113 of file JHead.hh.

Constructor & Destructor Documentation

JAANET::JHead::JHead ( )
inline

Default constructor.

Definition at line 1119 of file JHead.hh.

1120  {}
JAANET::JHead::JHead ( const Head header)
inline

Copy constructor.

Parameters
headerheader

Definition at line 1128 of file JHead.hh.

1129  {
1130  copy(header, *this);
1131  }
void copy(const Head &from, JHead &to)
Copy header from from to to.
Definition: JHead.cc:139
virtual JAANET::JHead::~JHead ( )
inlinevirtual

Virtual destructor.

Definition at line 1137 of file JHead.hh.

1138  {}

Member Function Documentation

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

Get header.

Returns
header

Definition at line 1146 of file JHead.hh.

1147  {
1148  return static_cast<const JHead&>(*this);
1149  }
Monte Carlo run header.
Definition: JHead.hh:1113
JHead& JAANET::JHead::getHeader ( )
inline

Get header.

Returns
header

Definition at line 1157 of file JHead.hh.

1158  {
1159  return static_cast<JHead&>(*this);
1160  }
Monte Carlo run header.
Definition: JHead.hh:1113
void JAANET::JHead::setHeader ( const JHead header)
inline

Set header.

Parameters
headerheader

Definition at line 1168 of file JHead.hh.

1169  {
1170  static_cast<JHead&>(*this) = header;
1171  }
Monte Carlo run header.
Definition: JHead.hh:1113
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
pdpointer to data member
Returns
true if valid; else false

Definition at line 1183 of file JHead.hh.

1184  {
1185  return (this->pull(pd) != this->end());
1186  }
const_iterator pull(T JHead::*pd) const
Pull given data member from Head.
Definition: JHead.hh:1213
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
objectobject
Returns
true if valid; else false

Definition at line 1198 of file JHead.hh.

1199  {
1200  static const T value;
1201 
1202  return (object.less(value) || value.less(object));
1203  }
bool less(const JHead &header) const
Comparison of headers.
Definition: JHead.hh:1301
do set_variable OUTPUT_DIRECTORY $WORKDIR T
template<class T >
const_iterator JAANET::JHead::pull ( T JHead::*  pd) const
inline

Pull given data member from Head.

Parameters
pdpointer to data member
Returns
iterator of Head

Definition at line 1213 of file JHead.hh.

1214  {
1215  return this->find(JROOT::getDataMember(pd)->GetName());
1216  }
const TDataMember * getDataMember(const JRootClass &parent, const JRootClass &member)
Get ROOT data member for given parent and member class.
Definition: JRootClass.hh:637
template<class T >
iterator JAANET::JHead::pull ( T JHead::*  pd)
inline

Pull given data member from Head.

Parameters
pdpointer to data member
Returns
iterator of Head

Definition at line 1226 of file JHead.hh.

1227  {
1228  return this->find(JROOT::getDataMember(pd)->GetName());
1229  }
const TDataMember * getDataMember(const JRootClass &parent, const JRootClass &member)
Get ROOT data member for given parent and member class.
Definition: JRootClass.hh:637
template<class T >
void JAANET::JHead::push ( T JHead::*  pd)
inline

Push given data member to Head.

Parameters
pdpointer to data member

Definition at line 1238 of file JHead.hh.

1239  {
1240  (*this)[JROOT::getDataMember(pd)->GetName()] = "";
1241  }
const TDataMember * getDataMember(const JRootClass &parent, const JRootClass &member)
Get ROOT data member for given parent and member class.
Definition: JRootClass.hh:637
template<class T >
void JAANET::JHead::erase ( T JHead::*  pd)
inline

Remove given data member from Head.

Parameters
pdpointer to data member

Definition at line 1250 of file JHead.hh.

1251  {
1252  iterator p = this->pull(pd);
1253 
1254  if (p != this->end()) {
1255 
1256  this->*pd = T();
1257 
1258  static_cast<Head*>(this)->erase(p);
1259  }
1260  }
void erase(T JHead::*pd)
Remove given data member from Head.
Definition: JHead.hh:1250
do set_variable OUTPUT_DIRECTORY $WORKDIR T
The Head class reflects the header of Monte-Carlo event files, which consists of keys (also referred ...
Definition: Head.hh:67
const_iterator pull(T JHead::*pd) const
Pull given data member from Head.
Definition: JHead.hh:1213
bool JAANET::JHead::match ( const JHead header) const
inline

Test match of headers.

Parameters
headersecond header
Returns
true if matches; else false

Definition at line 1269 of file JHead.hh.

1270  {
1271  return (match(*this, header, &JHead::cut_primary) &&
1272  match(*this, header, &JHead::cut_seamuon) &&
1273  match(*this, header, &JHead::cut_in) &&
1274  match(*this, header, &JHead::cut_nu) &&
1275  //match(*this, header, &JHead::detector) &&
1276  match(*this, header, &JHead::physics) &&
1277  match(*this, header, &JHead::simul) &&
1278  match(*this, header, &JHead::spectrum) &&
1279  match(*this, header, &JHead::can) &&
1280  match(*this, header, &JHead::fixedcan) &&
1281  match(*this, header, &JHead::genvol) &&
1282  match(*this, header, &JHead::coord_origin) &&
1283  match(*this, header, &JHead::norma) &&
1284  match(*this, header, &JHead::livetime) &&
1285  match(*this, header, &JHead::seabottom) &&
1286  match(*this, header, &JHead::depth) &&
1287  match(*this, header, &JHead::tgen) &&
1288  match(*this, header, &JHead::time_interval) &&
1289  match(*this, header, &JHead::primary) &&
1290  match(*this, header, &JHead::flux) &&
1291  match(*this, header, &JHead::DAQ));
1292  }
JAANET::depth depth
Definition: JHead.hh:1414
JAANET::genvol genvol
Definition: JHead.hh:1408
JAANET::norma norma
Definition: JHead.hh:1411
std::vector< JAANET::flux > flux
Definition: JHead.hh:1419
JAANET::cut_primary cut_primary
Definition: JHead.hh:1401
std::vector< JAANET::physics > physics
Definition: JHead.hh:1399
bool match(const JHead &header) const
Test match of headers.
Definition: JHead.hh:1269
std::vector< JAANET::simul > simul
Definition: JHead.hh:1400
JAANET::fixedcan fixedcan
Definition: JHead.hh:1407
JAANET::can can
Definition: JHead.hh:1406
JAANET::cut_seamuon cut_seamuon
Definition: JHead.hh:1402
JAANET::livetime livetime
Definition: JHead.hh:1412
JAANET::seabottom seabottom
Definition: JHead.hh:1413
JAANET::spectrum spectrum
Definition: JHead.hh:1405
JAANET::primary primary
Definition: JHead.hh:1418
JAANET::time_interval time_interval
Definition: JHead.hh:1417
JAANET::tgen tgen
Definition: JHead.hh:1416
JAANET::cut_in cut_in
Definition: JHead.hh:1403
JAANET::cut_nu cut_nu
Definition: JHead.hh:1404
JAANET::DAQ DAQ
Definition: JHead.hh:1415
Vec coord_origin() const
Get coordinate origin.
Definition: Head.hh:393
bool JAANET::JHead::less ( const JHead header) const
inline

Comparison of headers.

Parameters
headerheader
Returns
true if this header less than given header; else false

Definition at line 1301 of file JHead.hh.

1302  {
1303 #define RETURN_IF_DIFFERENT(A, B) \
1304  if (less(A,B)) { return true; } \
1305  if (less(B,A)) { return false; }
1306 
1307  // compare physics
1308 
1309  RETURN_IF_DIFFERENT(this->physics, header.physics);
1310 
1311  // compare simulation
1312 
1313  RETURN_IF_DIFFERENT(this->simul, header.simul);
1314 
1315  // compare generation data
1316 
1317  RETURN_IF_DIFFERENT(this->primary, header.primary);
1318  RETURN_IF_DIFFERENT(this->flux, header.flux);
1319  RETURN_IF_DIFFERENT(this->spectrum, header.spectrum);
1322  RETURN_IF_DIFFERENT(this->cut_in, header.cut_in);
1323  RETURN_IF_DIFFERENT(this->cut_nu, header.cut_nu);
1324  RETURN_IF_DIFFERENT(this->genvol, header.genvol);
1325 
1326  // compare compatibility
1327 
1328  if (is_valid(this->livetime) == is_valid(header.livetime) &&
1329  is_valid(this->DAQ) == is_valid(header.DAQ)) {
1330  return false;
1331  }
1332 
1333  THROW(JException, "JHead::less() headers do not compare.");
1334 
1335 #undef RETURN_IF_DIFFERENT
1336  }
Phase space of incident neutrino.
Definition: JHead.hh:393
JAANET::genvol genvol
Definition: JHead.hh:1408
Neutrino vertex volume.
Definition: JHead.hh:583
std::vector< JAANET::flux > flux
Definition: JHead.hh:1419
Livetime of DAQ data.
Definition: JHead.hh:941
#define RETURN_IF_DIFFERENT(A, B)
Phase space of incoming particle.
Definition: JHead.hh:383
Generator for simulation.
Definition: JHead.hh:460
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:670
JAANET::cut_primary cut_primary
Definition: JHead.hh:1401
std::vector< JAANET::physics > physics
Definition: JHead.hh:1399
std::vector< JAANET::simul > simul
Definition: JHead.hh:1400
Physics information.
Definition: JHead.hh:450
JAANET::cut_seamuon cut_seamuon
Definition: JHead.hh:1402
JAANET::livetime livetime
Definition: JHead.hh:1412
Neutrino flux.
Definition: JHead.hh:839
JAANET::spectrum spectrum
Definition: JHead.hh:1405
JAANET::primary primary
Definition: JHead.hh:1418
Normalisation of MUPAGE events.
Definition: JHead.hh:768
JAANET::cut_in cut_in
Definition: JHead.hh:1403
Primary particle.
Definition: JHead.hh:1053
JAANET::cut_nu cut_nu
Definition: JHead.hh:1404
Phase space of atmospheric muon generation.
Definition: JHead.hh:373
Phase space of primary particle.
Definition: JHead.hh:363
bool is_valid(T JHead::*pd) const
Check validity of given data member in JHead.
Definition: JHead.hh:1183
JAANET::DAQ DAQ
Definition: JHead.hh:1415
Neutrino energy spectrum.
Definition: JHead.hh:470
JHead& JAANET::JHead::add ( const JHead header)
inline

Addition of headers.

Parameters
headerheader
Returns
this header

Definition at line 1345 of file JHead.hh.

1346  {
1347  if (match(header)) {
1348 
1349  genvol .add(header.genvol);
1350  norma .add(header.norma);
1351  livetime.add(header.livetime);
1352  DAQ .add(header.DAQ);
1353 
1354  } else {
1355 
1356  THROW(JException, "JHead::add() headers do not match.");
1357  }
1358 
1359  return *this;
1360  }
norma & add(const norma &object)
Addition.
Definition: JHead.hh:751
JAANET::genvol genvol
Definition: JHead.hh:1408
Neutrino vertex volume.
Definition: JHead.hh:583
JAANET::norma norma
Definition: JHead.hh:1411
Livetime of DAQ data.
Definition: JHead.hh:941
livetime & add(const livetime &object)
Addition.
Definition: JHead.hh:806
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:670
Normlisation of CORSIKA events.
Definition: JHead.hh:725
bool match(const JHead &header) const
Test match of headers.
Definition: JHead.hh:1269
DAQ & add(const DAQ &object)
Addition.
Definition: JHead.hh:979
genvol & add(const genvol &object)
Addition.
Definition: JHead.hh:625
JAANET::livetime livetime
Definition: JHead.hh:1412
Normalisation of MUPAGE events.
Definition: JHead.hh:768
JAANET::DAQ DAQ
Definition: JHead.hh:1415
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 1432 of file JHead.hh.

1433  {
1434  static JLANG::JEquationParameters parameters(":", "\n", "", "");
1435 
1436  return parameters;
1437  }
*fatal Wrong number of arguments esac JCookie sh typeset Z DETECTOR typeset Z SOURCE_RUN typeset Z TARGET_RUN set_variable PARAMETERS_FILE $WORKDIR parameters
Definition: diff-Tuna.sh:38
Simple data structure to support I/O of equations (see class JLANG::JEquation).
static void JAANET::JHead::setEquationParameters ( const JLANG::JEquationParameters equation)
inlinestatic

Set equation parameters.

Parameters
equationequation parameters

Definition at line 1445 of file JHead.hh.

1446  {
1447  getEquationParameters() = equation;
1448  }
static JLANG::JEquationParameters & getEquationParameters()
Get equation parameters corresponding to Monte Carlo ASCII format, i.e:
Definition: JHead.hh:1432
std::istream & JAANET::JHead::read ( std::istream &  in)

Read header from input.

Parameters
ininput stream
Returns
input stream

Definition at line 30 of file JHead.cc.

31  {
32  using namespace std;
33  using namespace JPP;
34 
35  JStringStream is(in);
36 
37  if (getFileStatus(is.str().c_str())) {
38  is.load();
39  }
40 
42 
43  JRootReadableClass cls(*this);
44 
45  for (JEquation equation; reader >> equation && equation.getKey() != end_event::Class_Name(); ) {
46 
47  JRedirectString redirect(reader, equation.getValue());
48 
49  const JRootReadableClass abc = cls.find(equation.getKey().c_str());
50 
51  if (abc.is_valid()) {
52  reader.getObject(abc);
53  }
54 
55  (*this)[equation.getKey()] = equation.getValue();
56  }
57 
58  return in;
59  }
is
Definition: JDAQCHSM.chsm:167
T & getInstance(const T &object)
Get static instance from temporary object.
Definition: JObject.hh:75
static JLANG::JEquationParameters & getEquationParameters()
Get equation parameters corresponding to Monte Carlo ASCII format, i.e:
Definition: JHead.hh:1432
static JStat getFileStatus
Function object for file status.
Definition: JStat.hh:173
then fatal Wrong number of arguments fi set_variable DETECTOR $argv[1] set_variable INPUT_FILE $argv[2] eval JPrintDetector a $DETECTOR O IDENTIFIER eval JPrintDetector a $DETECTOR O SUMMARY source JAcoustics sh $DETECTOR_ID CHECK_EXIT_CODE typeset A TRIPODS get_tripods $WORKDIR tripod txt TRIPODS for EMITTER in
Definition: JCanberra.sh:41
std::ostream & JAANET::JHead::write ( std::ostream &  out) const

Write header to output.

Parameters
outoutput stream
Returns
output stream

Definition at line 68 of file JHead.cc.

69  {
70  using namespace std;
71  using namespace JPP;
72 
73  JRootWriter writer(out, JHead::getEquationParameters(), JAAnetDictionary::getInstance());
74 
75  JRootWritableClass cls(*this);
76 
77  TIterator* i = cls.getClass()->GetListOfDataMembers()->MakeIterator();
78 
79  for (const TDataMember* p; (p = (const TDataMember*) i->Next()) != NULL; ) {
80  if (!JRootClass::is_static(*p)) {
81  if (this->find(p->GetName()) != this->end() ||
82  cls.get(*p) == JRootClass(&JHead::start_run) ||
83  cls.get(*p) == JRootClass(&JHead::end_event)) {
84  writer.put(p->GetName(), cls.get(*p), true);
85  }
86  }
87  }
88 
89  return out << flush;
90  }
JAANET::end_event end_event
Definition: JHead.hh:1420
T & getInstance(const T &object)
Get static instance from temporary object.
Definition: JObject.hh:75
static JLANG::JEquationParameters & getEquationParameters()
Get equation parameters corresponding to Monte Carlo ASCII format, i.e:
Definition: JHead.hh:1432
JAANET::start_run start_run
Definition: JHead.hh:1393
std::ostream & JAANET::JHead::print ( std::ostream &  out) const

Print header to output.

Parameters
outoutput stream
Returns
output stream

Definition at line 99 of file JHead.cc.

100  {
101  using namespace std;
102  using namespace JPP;
103 
104  JRootWriter writer(out, JHead::getEquationParameters(), JAAnetDictionary::getInstance());
105 
106  JRootWritableClass cls(*this);
107 
108  TIterator* i = cls.getClass()->GetListOfDataMembers()->MakeIterator();
109 
111 
112  for (const TDataMember* p; (p = (const TDataMember*) i->Next()) != NULL; ) {
113  if (!JRootClass::is_static(*p)) {
114  if (cls.get(*p) != JRootClass(&JHead::end_event))
115  writer.put(p->GetName(), cls.get(*p), true);
116  else
117  end_event = make_pair(p->GetName(), cls.get(*p));
118  }
119  }
120 
121  for (JHead::const_iterator i = this->begin(); i != this->end(); ++i) {
122  if (!cls.find(i->first.c_str()).is_valid()) {
123  writer.put(i->first, i->second);
124  }
125  }
126 
127  writer.put(end_event.first, end_event.second, true);
128 
129  return out << flush;
130  }
JAANET::end_event end_event
Definition: JHead.hh:1420
T & getInstance(const T &object)
Get static instance from temporary object.
Definition: JObject.hh:75
static JLANG::JEquationParameters & getEquationParameters()
Get equation parameters corresponding to Monte Carlo ASCII format, i.e:
Definition: JHead.hh:1432
bool is_valid(T JHead::*pd) const
Check validity of given data member in JHead.
Definition: JHead.hh:1183
JAANET::JHead::ClassDef ( JHead  ,
 
)
template<class T >
static bool JAANET::JHead::less ( const T first,
const T second 
)
inlinestaticprivate

Comparison.

Parameters
firstfirst object
secondsecond object
Returns
true if first less than second; else false

Definition at line 1489 of file JHead.hh.

1491  {
1492  return first.less(second);
1493  }
then echo The file $DIR KM3NeT_00000001_00000000 root already please rename or remove it first
template<class T >
static bool JAANET::JHead::match ( const T first,
const T second 
)
inlinestaticprivate

Test match.

Parameters
firstfirst object
secondsecond object
Returns
true if matches; else false

Definition at line 1504 of file JHead.hh.

1506  {
1507  return first.match(second);
1508  }
then echo The file $DIR KM3NeT_00000001_00000000 root already please rename or remove it first
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
firstfirst object
secondsecond object
Returns
true if first is less than second; else false

Definition at line 1520 of file JHead.hh.

1522  {
1523  if (first.size() == second.size()) {
1524 
1525  for (size_t i = 0; i != first.size(); ++i) {
1526  if (less(first[i], second[i])) {
1527  return true;
1528  }
1529  }
1530 
1531  return false;
1532 
1533  } else {
1534 
1535  return first.size() < second.size();
1536  }
1537  }
bool less(const JHead &header) const
Comparison of headers.
Definition: JHead.hh:1301
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
firstfirst object
secondsecond object
Returns
true if matches; else false

Definition at line 1549 of file JHead.hh.

1551  {
1552  for (size_t i = 0; i != first.size() && i != second.size(); ++i) {
1553  if (!match(first[i], second[i])) {
1554  return false;
1555  }
1556  }
1557 
1558  return first.size() == second.size();
1559  }
bool match(const JHead &header) const
Test match of headers.
Definition: JHead.hh:1269
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
firstfirst header
secondsecond header
pdpointer to data member
Returns
true if matches; else false

Definition at line 1571 of file JHead.hh.

1574  {
1575  return match(first.*pd, second.*pd);
1576  }
bool match(const JHead &header) const
Test match of headers.
Definition: JHead.hh:1269
bool Head::have_line ( std::string  key) const
inlineinherited

Check availability of data with the given key.

Parameters
keykey
Returns
true if data are available; else false

Definition at line 76 of file Head.hh.

77  {
78  return count( key ) != 0;
79  }
std::vector< int > count
Definition: JAlgorithm.hh:180
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
keykey
Returns
data

Definition at line 88 of file Head.hh.

89  {
90  return this->at(key);
91  }
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
keykey
Returns
data

Definition at line 100 of file Head.hh.

101  {
102  return this->at(key);
103  }
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
tagtag (without suffix)

Definition at line 114 of file Head.hh.

115  {
117 
118  auto match = [&] (const std::string & key) {
119 
120  if (key == tag) return true;
121 
122  if ( key.find( tag ) != 0 ) return false;
123 
124  // what is left should be of the form _d(ddd)
125  std::string left = key.substr( tag.length(), key.length() );
126  if (left.length() < 2 || left[0] != '_' ) return false ;
127  for ( unsigned i = 1; i < left.length(); i++ )
128  {
129  if (!std::isdigit( left[i] )) return false ;
130  }
131  return true;
132  };
133 
134  for ( auto& p : *this )
135  {
136  if ( match( p.first ) ) r.push_back( p.first );
137  }
138 
139  return r;
140  }
data_type r[M+1]
Definition: JPolint.hh:742
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
tagtag (without suffix)
Returns
data

Definition at line 153 of file Head.hh.

154  {
156 
157  for ( auto& key : matching_keys( tag ) ) {
158  r.push_back( get_line( key ) );
159  }
160 
161  return r;
162  }
data_type r[M+1]
Definition: JPolint.hh:742
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 &quot;_n&quot;.
Definition: Head.hh:114
const std::string & get_line(std::string key) const
Get data with the given key.
Definition: Head.hh:88
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
tagtag
linedata
ensure_uniqueadd '_n' (with n an integer) to the tag if it would overwrite an existing key.

Definition at line 175 of file Head.hh.

176  {
177  std::string k = tag;
178 
179  if (ensure_unique)
180  for (int i = 1; find(k) != end() ; i++)
181  {
182  k = tag + "_" + std::to_string(i);
183  }
184 
186  return k;
187  }
then fatal No hydrophone data file $HYDROPHONE_TXT fi sort gr k
std::string to_string(const T &value)
Convert value to string.
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
keykey
idxindex
Returns
data

Definition at line 197 of file Head.hh.

198  {
199  using namespace std;
200 
202 
203  if ( idx < 0 || idx >= int ( v.size() ) )
204  {
205  THROW(Exception, "Cannot find word number " << idx << " in line " << get_line(key) << " for key: " << key);
206  }
207  return v[idx];
208  }
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:670
General exception.
Definition: Exception.hh:13
const std::string & get_line(std::string key) const
Get data with the given key.
Definition: Head.hh:88
data_type v[N+1][M+1]
Definition: JPolint.hh:740
std::vector< std::string > splitstring(const std::string &str, char delim= ' ')
Split string at delimiter.
Definition: Head.hh:46
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
keykey
fieldfield
Returns
data

Definition at line 237 of file Head.hh.

238  {
239  int idx = get_index_of_field(key, field);
240 
241  if ( idx == -1 )
242  {
243  THROW(Exception, "Failed to find" << key << " " << field);
244  }
245 
246  return get_field( key, idx );
247  }
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:670
int get_index_of_field(std::string key, std::string field) const
Get index of data with the given key at given field.
Definition: Head.hh:219
General exception.
Definition: Exception.hh:13
std::string get_field(std::string key, int idx) const
Get data with the given key at given index.
Definition: Head.hh:197
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
keykey
fieldfield
Returns
index (-1 if not present)

Definition at line 219 of file Head.hh.

220  {
221  auto v = _hdr_dict()[key];
222  auto i = std::find (v.begin(), v.end(), field );
223  if (i == v.end()) return -1;
224  return i - v.begin();
225  }
data_type v[N+1][M+1]
Definition: JPolint.hh:740
static std::map< std::string, std::vector< std::string > > & _hdr_dict()
Get internal description of the known lines in header.
Definition: Head.hh:312
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
keykey
fieldfield
valuevakue

Definition at line 260 of file Head.hh.

261  {
262  using namespace std;
263 
264  if ( field == "" ) get_line( key ) = value;
265 
266  int idx = get_index_of_field( key, field );
267 
268  if ( idx < 0 )
269  {
270  THROW(Exception, "GFailed to find field in header line: " << key << " " << field);
271  }
272 
273  vector<string> vals = splitstring( get_line( key ) );
274 
275  // if the fields before do not exist, add padding
276  while ( int( vals.size() ) <= idx ) vals.push_back("0");
277 
278  vals[idx] = value;
279  ostringstream ss;
280 
281  for (unsigned i = 0; i < vals.size() ; i++ )
282  {
283  ss << vals[i];
284  if ( i != vals.size() - 1) ss << " ";
285  }
286  set_line( key, ss.str() );
287 
288  }
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:670
int get_index_of_field(std::string key, std::string field) const
Get index of data with the given key at given field.
Definition: Head.hh:219
std::string set_line(std::string tag, std::string line, bool ensure_unique=true)
Set data with the given tag.
Definition: Head.hh:175
General exception.
Definition: Exception.hh:13
const std::string & get_line(std::string key) const
Get data with the given key.
Definition: Head.hh:88
std::vector< std::string > splitstring(const std::string &str, char delim= ' ')
Split string at delimiter.
Definition: Head.hh:46
static 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 312 of file Head.hh.

313  {
314  using namespace std;
315 
316  // map with, for each tag (key), a vector of field-names
317 
318  static map<string, vector<string> > r;
319  if ( r.size() > 0 ) return r;
320 
321  string desc =
322  "DAQ:livetime\n"
323  "cut_primary cut_seamuon cut_in cut_nu:Emin Emax cosTmin cosTmax\n"
324  "generator physics simul:program version date time\n"
325  "seed:program level iseed\n"
326  "PM1_type_area:type area TTS\n"
327  "PDF:i1 i2\n"
328  "model:interaction muon scattering numberOfEnergyBins\n"
329  "can:zmin zmax r\n"
330  "genvol:zmin zmax r volume numberOfEvents\n"
331  "merge:time gain\n"
332  "coord_origin:x y z\n"
333  "translate:x y z\n"
334  "genhencut:gDir Emin\n"
335  "k40:rate time\n"
336  "norma:primaryFlux numberOfPrimaries\n"
337  "livetime:numberOfSeconds errorOfSeconds\n"
338  "flux:type key file_1 file_2\n"
339  "spectrum:alpha\n"
340  "fixedcan:xcenter ycenter zmin zmax radius\n"
341  "start_run:run_id";
342 
343  for ( auto line : splitstring(desc, '\n') )
344  {
345  auto v = splitstring( line, ':');
346 
347  vector< string > fields = splitstring( v[1] );
348  for ( auto key : splitstring( v[0] ) )
349  {
350  r[key] = fields;
351  }
352  }
353  return r;
354  }
data_type r[M+1]
Definition: JPolint.hh:742
data_type v[N+1][M+1]
Definition: JPolint.hh:740
std::vector< std::string > splitstring(const std::string &str, char delim= ' ')
Split string at delimiter.
Definition: Head.hh:46
double Head::ngen ( ) const
inlineinherited

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

Returns
number of events

Definition at line 362 of file Head.hh.

363  {
364  return stod ( get_field("genvol", "numberOfEvents") );
365  }
std::string get_field(std::string key, int idx) const
Get data with the given key at given index.
Definition: Head.hh:197
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 372 of file Head.hh.

373  {
374  return stod ( get_field("DAQ", "livetime") );
375  }
std::string get_field(std::string key, int idx) const
Get data with the given key at given index.
Definition: Head.hh:197
double Head::mc_livetime ( ) const
inlineinherited

Get the Monte Carlo live time.

Returns
live time [s]

Definition at line 383 of file Head.hh.

384  {
385  return stod ( get_field("livetime", "numberOfSeconds") );
386  }
std::string get_field(std::string key, int idx) const
Get data with the given key at given index.
Definition: Head.hh:197
Vec Head::coord_origin ( ) const
inlineinherited

Get coordinate origin.

Returns
position

Definition at line 393 of file Head.hh.

394  {
395  return Vec( stod( get_field("coord_origin", "x") ),
396  stod( get_field("coord_origin", "y") ),
397  stod( get_field("coord_origin", "z") ));
398  }
The Vec class is a straightforward 3-d vector, which also works in pyroot.
Definition: Vec.hh:12
std::string get_field(std::string key, int idx) const
Get data with the given key at given index.
Definition: Head.hh:197
Vec Head::translate ( ) const
inlineinherited

Get coordinate translation.

Returns
translation

Definition at line 405 of file Head.hh.

406  {
407  return Vec( stod( get_field("translate", "x") ),
408  stod( get_field("translate", "y") ),
409  stod( get_field("translate", "z") ));
410  }
The Vec class is a straightforward 3-d vector, which also works in pyroot.
Definition: Vec.hh:12
std::string get_field(std::string key, int idx) const
Get data with the given key at given index.
Definition: Head.hh:197
Head::ClassDef ( Head  ,
 
)
inherited

Friends And Related Function Documentation

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

Equal operator.

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

Parameters
firstfirst header
secondsecond header
Returns
true if two headers are equal; else false

Definition at line 1372 of file JHead.hh.

1374  {
1375  return first.match(second);
1376  }
bool match(const JHead &header) const
Test match of headers.
Definition: JHead.hh:1269
bool operator< ( const JHead first,
const JHead second 
)
friend

Less than operator.

Parameters
firstfirst header
secondsecond header
Returns
true if first header is less than second header; else false

Definition at line 1386 of file JHead.hh.

1388  {
1389  return first.less(second);
1390  }
bool less(const JHead &header) const
Comparison of headers.
Definition: JHead.hh:1301

Member Data Documentation

JAANET::start_run JAANET::JHead::start_run

Definition at line 1393 of file JHead.hh.

JAANET::XSecFile JAANET::JHead::XSecFile

Definition at line 1394 of file JHead.hh.

JAANET::drawing JAANET::JHead::drawing

Definition at line 1395 of file JHead.hh.

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

Definition at line 1396 of file JHead.hh.

JAANET::muon_desc_file JAANET::JHead::muon_desc_file

Definition at line 1397 of file JHead.hh.

JAANET::target JAANET::JHead::target

Definition at line 1398 of file JHead.hh.

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

Definition at line 1399 of file JHead.hh.

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

Definition at line 1400 of file JHead.hh.

JAANET::cut_primary JAANET::JHead::cut_primary

Definition at line 1401 of file JHead.hh.

JAANET::cut_seamuon JAANET::JHead::cut_seamuon

Definition at line 1402 of file JHead.hh.

JAANET::cut_in JAANET::JHead::cut_in

Definition at line 1403 of file JHead.hh.

JAANET::cut_nu JAANET::JHead::cut_nu

Definition at line 1404 of file JHead.hh.

JAANET::spectrum JAANET::JHead::spectrum

Definition at line 1405 of file JHead.hh.

JAANET::can JAANET::JHead::can

Definition at line 1406 of file JHead.hh.

JAANET::fixedcan JAANET::JHead::fixedcan

Definition at line 1407 of file JHead.hh.

JAANET::genvol JAANET::JHead::genvol

Definition at line 1408 of file JHead.hh.

JAANET::coord_origin JAANET::JHead::coord_origin

Definition at line 1409 of file JHead.hh.

JAANET::genhencut JAANET::JHead::genhencut

Definition at line 1410 of file JHead.hh.

JAANET::norma JAANET::JHead::norma

Definition at line 1411 of file JHead.hh.

JAANET::livetime JAANET::JHead::livetime

Definition at line 1412 of file JHead.hh.

JAANET::seabottom JAANET::JHead::seabottom

Definition at line 1413 of file JHead.hh.

JAANET::depth JAANET::JHead::depth

Definition at line 1414 of file JHead.hh.

JAANET::DAQ JAANET::JHead::DAQ

Definition at line 1415 of file JHead.hh.

JAANET::tgen JAANET::JHead::tgen

Definition at line 1416 of file JHead.hh.

JAANET::time_interval JAANET::JHead::time_interval

Definition at line 1417 of file JHead.hh.

JAANET::primary JAANET::JHead::primary

Definition at line 1418 of file JHead.hh.

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

Definition at line 1419 of file JHead.hh.

JAANET::end_event JAANET::JHead::end_event

Definition at line 1420 of file JHead.hh.


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