Jpp  17.1.0
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...
 
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...
 
template<class T >
void erase (T JHead::*pd)
 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...
 
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, 4)
 
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::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
 
JUUID UUID
 
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 1167 of file JHead.hh.

Constructor & Destructor Documentation

JAANET::JHead::JHead ( )
inline

Default constructor.

Definition at line 1173 of file JHead.hh.

1174  {
1175  createUUID();
1176  }
void createUUID()
Create UUID if not already set.
Definition: JHead.hh:1233
JAANET::JHead::JHead ( const Head header)
inline

Copy constructor.

Parameters
headerheader

Definition at line 1184 of file JHead.hh.

1185  {
1186  copy(header, *this);
1187  }
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 1193 of file JHead.hh.

1194  {}

Member Function Documentation

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

Get header.

Returns
header

Definition at line 1202 of file JHead.hh.

1203  {
1204  return static_cast<const JHead&>(*this);
1205  }
Monte Carlo run header.
Definition: JHead.hh:1167
JHead& JAANET::JHead::getHeader ( )
inline

Get header.

Returns
header

Definition at line 1213 of file JHead.hh.

1214  {
1215  return static_cast<JHead&>(*this);
1216  }
Monte Carlo run header.
Definition: JHead.hh:1167
void JAANET::JHead::setHeader ( const JHead header)
inline

Set header.

Parameters
headerheader

Definition at line 1224 of file JHead.hh.

1225  {
1226  static_cast<JHead&>(*this) = header;
1227  }
Monte Carlo run header.
Definition: JHead.hh:1167
void JAANET::JHead::createUUID ( )
inline

Create UUID if not already set.

Definition at line 1233 of file JHead.hh.

1234  {
1235  if (!is_valid(&JHead::UUID)) {
1236  this->UUID = JUUID::rndm();
1237  this->push(&JHead::UUID);
1238  }
1239  }
static const JUUID & rndm()
Generate random UUID.
Definition: JUUID.hh:67
void push(T JHead::*pd)
Push given data member to Head.
Definition: JHead.hh:1306
JUUID UUID
Definition: JHead.hh:1496
bool is_valid(T JHead::*pd) const
Check validity of given data member in JHead.
Definition: JHead.hh:1251
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 1251 of file JHead.hh.

1252  {
1253  return (this->pull(pd) != this->end());
1254  }
const_iterator pull(T JHead::*pd) const
Pull given data member from Head.
Definition: JHead.hh:1281
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 1266 of file JHead.hh.

1267  {
1268  static const T value;
1269 
1270  return (object.less(value) || value.less(object));
1271  }
bool less(const JHead &header) const
Comparison of headers.
Definition: JHead.hh:1401
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 1281 of file JHead.hh.

1282  {
1283  return this->find(JROOT::getDataMember(pd)->GetName());
1284  }
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 1294 of file JHead.hh.

1295  {
1296  return this->find(JROOT::getDataMember(pd)->GetName());
1297  }
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 1306 of file JHead.hh.

1307  {
1308  (*this)[JROOT::getDataMember(pd)->GetName()] = "";
1309  }
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 1318 of file JHead.hh.

1319  {
1320  iterator p = this->pull(pd);
1321 
1322  if (p != this->end()) {
1323 
1324  this->*pd = T();
1325 
1326  static_cast<Head*>(this)->erase(p);
1327  }
1328  }
void erase(T JHead::*pd)
Remove given data member from Head.
Definition: JHead.hh:1318
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:65
const_iterator pull(T JHead::*pd) const
Pull given data member from Head.
Definition: JHead.hh:1281
JHead JAANET::JHead::getMatch ( const JHead header) const
inline

Get matching fields.

Parameters
headerheader
Returns
header with matching fields

Definition at line 1337 of file JHead.hh.

1338  {
1339  JHead buffer(*this);
1340 
1341  buffer.clear();
1342 
1343  buffer.createUUID();
1344 
1345  if (match(*this, header, &JHead::cut_primary)) { buffer.push(&JHead::cut_primary); }
1346  if (match(*this, header, &JHead::cut_seamuon)) { buffer.push(&JHead::cut_seamuon); }
1347  if (match(*this, header, &JHead::cut_in)) { buffer.push(&JHead::cut_in); }
1348  if (match(*this, header, &JHead::cut_nu)) { buffer.push(&JHead::cut_nu); }
1349  if (match(*this, header, &JHead::simul)) { buffer.push(&JHead::simul); }
1350  if (match(*this, header, &JHead::spectrum)) { buffer.push(&JHead::spectrum); }
1351  if (match(*this, header, &JHead::can)) { buffer.push(&JHead::can); }
1352  if (match(*this, header, &JHead::fixedcan)) { buffer.push(&JHead::fixedcan); }
1353  if (match(*this, header, &JHead::genvol)) { buffer.push(&JHead::genvol); }
1354  if (match(*this, header, &JHead::coord_origin)) { buffer.push(&JHead::coord_origin); }
1355  if (match(*this, header, &JHead::norma)) { buffer.push(&JHead::norma); }
1356  if (match(*this, header, &JHead::livetime)) { buffer.push(&JHead::livetime); }
1357  if (match(*this, header, &JHead::seabottom)) { buffer.push(&JHead::seabottom); }
1358  if (match(*this, header, &JHead::depth)) { buffer.push(&JHead::depth); }
1359  if (match(*this, header, &JHead::tgen)) { buffer.push(&JHead::tgen); }
1360  if (match(*this, header, &JHead::time_interval)) { buffer.push(&JHead::time_interval); }
1361  if (match(*this, header, &JHead::primary)) { buffer.push(&JHead::primary); }
1362  if (match(*this, header, &JHead::flux)) { buffer.push(&JHead::flux); }
1363  if (match(*this, header, &JHead::DAQ)) { buffer.push(&JHead::DAQ); }
1364 
1365  return buffer;
1366  }
JAANET::depth depth
Definition: JHead.hh:1517
JAANET::genvol genvol
Definition: JHead.hh:1511
JAANET::norma norma
Definition: JHead.hh:1514
std::vector< JAANET::flux > flux
Definition: JHead.hh:1522
JAANET::cut_primary cut_primary
Definition: JHead.hh:1504
bool match(const JHead &header) const
Test match of headers.
Definition: JHead.hh:1389
std::vector< JAANET::simul > simul
Definition: JHead.hh:1503
JAANET::fixedcan fixedcan
Definition: JHead.hh:1510
JAANET::can can
Definition: JHead.hh:1509
JAANET::cut_seamuon cut_seamuon
Definition: JHead.hh:1505
JAANET::livetime livetime
Definition: JHead.hh:1515
JAANET::seabottom seabottom
Definition: JHead.hh:1516
JAANET::spectrum spectrum
Definition: JHead.hh:1508
JAANET::primary primary
Definition: JHead.hh:1521
Monte Carlo run header.
Definition: JHead.hh:1167
JAANET::time_interval time_interval
Definition: JHead.hh:1520
JAANET::tgen tgen
Definition: JHead.hh:1519
JAANET::cut_in cut_in
Definition: JHead.hh:1506
JAANET::cut_nu cut_nu
Definition: JHead.hh:1507
JAANET::DAQ DAQ
Definition: JHead.hh:1518
Vec coord_origin() const
Get coordinate origin.
Definition: Head.hh:395
size_t JAANET::JHead::getNumberOfMatches ( const JHead header) const
inline

Get number of matching fields.

Parameters
headerheader
Returns
number of matching header fields

Definition at line 1375 of file JHead.hh.

1376  {
1377  const JHead head = getMatch(header);
1378 
1379  return head.size();
1380  }
JHead getMatch(const JHead &header) const
Get matching fields.
Definition: JHead.hh:1337
Monte Carlo run header.
Definition: JHead.hh:1167
bool JAANET::JHead::match ( const JHead header) const
inline

Test match of headers.

Parameters
headersecond header
Returns
true if all header fields match; else false

Definition at line 1389 of file JHead.hh.

1390  {
1391  return getNumberOfMatches(header) == getMaximumNumberOfMatches();
1392  }
static const size_t getMaximumNumberOfMatches()
Get maximum number of matching header fields.
Definition: JHead.hh:1531
size_t getNumberOfMatches(const JHead &header) const
Get number of matching fields.
Definition: JHead.hh:1375
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 1401 of file JHead.hh.

1402  {
1403 #define RETURN_IF_DIFFERENT(A, B) \
1404  if (less(A,B)) { return true; } \
1405  if (less(B,A)) { return false; }
1406 
1407  // compare physics
1408 
1409  RETURN_IF_DIFFERENT(this->physics, header.physics);
1410 
1411  // compare simulation
1412 
1413  RETURN_IF_DIFFERENT(this->simul, header.simul);
1414 
1415  // compare generation data
1416 
1417  RETURN_IF_DIFFERENT(this->primary, header.primary);
1418  RETURN_IF_DIFFERENT(this->flux, header.flux);
1419  RETURN_IF_DIFFERENT(this->spectrum, header.spectrum);
1422  RETURN_IF_DIFFERENT(this->cut_in, header.cut_in);
1423  RETURN_IF_DIFFERENT(this->cut_nu, header.cut_nu);
1424  RETURN_IF_DIFFERENT(this->genvol, header.genvol);
1425 
1426  // compare compatibility
1427 
1428  if (is_valid(this->livetime) == is_valid(header.livetime) &&
1429  is_valid(this->DAQ) == is_valid(header.DAQ)) {
1430  return false;
1431  }
1432 
1433  THROW(JException, "JHead::less() headers do not compare.");
1434 
1435 #undef RETURN_IF_DIFFERENT
1436  }
Phase space of incident neutrino.
Definition: JHead.hh:446
JAANET::genvol genvol
Definition: JHead.hh:1511
Neutrino vertex volume.
Definition: JHead.hh:636
std::vector< JAANET::flux > flux
Definition: JHead.hh:1522
Livetime of DAQ data.
Definition: JHead.hh:995
#define RETURN_IF_DIFFERENT(A, B)
Phase space of incoming particle.
Definition: JHead.hh:436
Generator for simulation.
Definition: JHead.hh:513
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:696
JAANET::cut_primary cut_primary
Definition: JHead.hh:1504
std::vector< JAANET::physics > physics
Definition: JHead.hh:1502
std::vector< JAANET::simul > simul
Definition: JHead.hh:1503
Physics information.
Definition: JHead.hh:503
JAANET::cut_seamuon cut_seamuon
Definition: JHead.hh:1505
JAANET::livetime livetime
Definition: JHead.hh:1515
Neutrino flux.
Definition: JHead.hh:893
JAANET::spectrum spectrum
Definition: JHead.hh:1508
JAANET::primary primary
Definition: JHead.hh:1521
Normalisation of MUPAGE events.
Definition: JHead.hh:822
JAANET::cut_in cut_in
Definition: JHead.hh:1506
Primary particle.
Definition: JHead.hh:1107
JAANET::cut_nu cut_nu
Definition: JHead.hh:1507
Phase space of atmospheric muon generation.
Definition: JHead.hh:426
Phase space of primary particle.
Definition: JHead.hh:416
bool is_valid(T JHead::*pd) const
Check validity of given data member in JHead.
Definition: JHead.hh:1251
JAANET::DAQ DAQ
Definition: JHead.hh:1518
Neutrino energy spectrum.
Definition: JHead.hh:523
JHead& JAANET::JHead::add ( const JHead header)
inline

Addition of headers.

Parameters
headerheader
Returns
this header

Definition at line 1445 of file JHead.hh.

1446  {
1447  if (match(header)) {
1448 
1449  this->createUUID();
1450  this->UUID = JUUID::rndm();
1451 
1452  genvol .add(header.genvol);
1453  norma .add(header.norma);
1454  livetime.add(header.livetime);
1455  DAQ .add(header.DAQ);
1456 
1457  } else {
1458 
1459  THROW(JException, "JHead::add() headers do not match.");
1460  }
1461 
1462  return *this;
1463  }
norma & add(const norma &object)
Addition.
Definition: JHead.hh:805
JAANET::genvol genvol
Definition: JHead.hh:1511
Neutrino vertex volume.
Definition: JHead.hh:636
JAANET::norma norma
Definition: JHead.hh:1514
Livetime of DAQ data.
Definition: JHead.hh:995
livetime & add(const livetime &object)
Addition.
Definition: JHead.hh:860
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:696
Normlisation of CORSIKA events.
Definition: JHead.hh:779
bool match(const JHead &header) const
Test match of headers.
Definition: JHead.hh:1389
void createUUID()
Create UUID if not already set.
Definition: JHead.hh:1233
DAQ & add(const DAQ &object)
Addition.
Definition: JHead.hh:1033
genvol & add(const genvol &object)
Addition.
Definition: JHead.hh:679
static const JUUID & rndm()
Generate random UUID.
Definition: JUUID.hh:67
JUUID UUID
Definition: JHead.hh:1496
JAANET::livetime livetime
Definition: JHead.hh:1515
Normalisation of MUPAGE events.
Definition: JHead.hh:822
JAANET::DAQ DAQ
Definition: JHead.hh:1518
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 1531 of file JHead.hh.

1532  {
1533  static const JHead header;
1534  static const size_t value = header.getNumberOfMatches(header);
1535 
1536  return value;
1537  }
Monte Carlo run header.
Definition: JHead.hh:1167
size_t getNumberOfMatches(const JHead &header) const
Get number of matching fields.
Definition: JHead.hh:1375
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 1549 of file JHead.hh.

1550  {
1551  static JLANG::JEquationParameters parameters(":", "\n", "", "");
1552 
1553  return parameters;
1554  }
*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 1562 of file JHead.hh.

1563  {
1564  getEquationParameters() = equation;
1565  }
static JLANG::JEquationParameters & getEquationParameters()
Get equation parameters corresponding to Monte Carlo ASCII format, i.e:
Definition: JHead.hh:1549
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:1549
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 JAcoustics sh $DETECTOR_ID source JAcousticsToolkit sh CHECK_EXIT_CODE typeset A EMITTERS get_tripods $WORKDIR tripod txt EMITTERS get_transmitters $WORKDIR transmitter txt EMITTERS for EMITTER in
Definition: JCanberra.sh:46
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:1523
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:1549
JAANET::start_run start_run
Definition: JHead.hh:1495
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:1523
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:1549
bool is_valid(T JHead::*pd) const
Check validity of given data member in JHead.
Definition: JHead.hh:1251
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 1606 of file JHead.hh.

1608  {
1609  return first.less(second);
1610  }
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 1621 of file JHead.hh.

1623  {
1624  return first.match(second);
1625  }
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 1637 of file JHead.hh.

1639  {
1640  if (first.size() == second.size()) {
1641 
1642  for (size_t i = 0; i != first.size(); ++i) {
1643  if (less(first[i], second[i])) {
1644  return true;
1645  }
1646  }
1647 
1648  return false;
1649 
1650  } else {
1651 
1652  return first.size() < second.size();
1653  }
1654  }
bool less(const JHead &header) const
Comparison of headers.
Definition: JHead.hh:1401
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 1666 of file JHead.hh.

1668  {
1669  for (size_t i = 0; i != first.size() && i != second.size(); ++i) {
1670  if (!match(first[i], second[i])) {
1671  return false;
1672  }
1673  }
1674 
1675  return first.size() == second.size();
1676  }
bool match(const JHead &header) const
Test match of headers.
Definition: JHead.hh:1389
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 1688 of file JHead.hh.

1691  {
1692  return match(first.*pd, second.*pd);
1693  }
bool match(const JHead &header) const
Test match of headers.
Definition: JHead.hh:1389
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 78 of file Head.hh.

79  {
80  return count( key ) != 0;
81  }
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 90 of file Head.hh.

91  {
92  return this->at(key);
93  }
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 102 of file Head.hh.

103  {
104  return this->at(key);
105  }
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 116 of file Head.hh.

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

156  {
158 
159  for ( auto& key : matching_keys( tag ) ) {
160  r.push_back( get_line( key ) );
161  }
162 
163  return r;
164  }
data_type r[M+1]
Definition: JPolint.hh:758
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:116
const std::string & get_line(std::string key) const
Get data with the given key.
Definition: Head.hh:90
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 177 of file Head.hh.

178  {
179  std::string k = tag;
180 
181  if (ensure_unique)
182  for (int i = 1; find(k) != end() ; i++)
183  {
184  k = tag + "_" + std::to_string(i);
185  }
186 
188  return k;
189  }
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 199 of file Head.hh.

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

240  {
241  int idx = get_index_of_field(key, field);
242 
243  if ( idx == -1 )
244  {
245  THROW(Exception, "Failed to find" << key << " " << field);
246  }
247 
248  return get_field( key, idx );
249  }
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:696
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:221
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:199
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 221 of file Head.hh.

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

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

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

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

Returns
number of events

Definition at line 364 of file Head.hh.

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

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

Get the Monte Carlo live time.

Returns
live time [s]

Definition at line 385 of file Head.hh.

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

Get coordinate origin.

Returns
position

Definition at line 395 of file Head.hh.

396  {
397  return Vec( stod( get_field("coord_origin", "x") ),
398  stod( get_field("coord_origin", "y") ),
399  stod( get_field("coord_origin", "z") ));
400  }
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:199
Vec Head::translate ( ) const
inlineinherited

Get coordinate translation.

Returns
translation

Definition at line 407 of file Head.hh.

408  {
409  return Vec( stod( get_field("translate", "x") ),
410  stod( get_field("translate", "y") ),
411  stod( get_field("translate", "z") ));
412  }
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:199
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 1475 of file JHead.hh.

1477  {
1478  return first.match(second);
1479  }
bool match(const JHead &header) const
Test match of headers.
Definition: JHead.hh:1389
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 1489 of file JHead.hh.

1491  {
1492  return first.less(second);
1493  }
bool less(const JHead &header) const
Comparison of headers.
Definition: JHead.hh:1401

Member Data Documentation

JAANET::start_run JAANET::JHead::start_run

Definition at line 1495 of file JHead.hh.

JUUID JAANET::JHead::UUID

Definition at line 1496 of file JHead.hh.

JAANET::XSecFile JAANET::JHead::XSecFile

Definition at line 1497 of file JHead.hh.

JAANET::drawing JAANET::JHead::drawing

Definition at line 1498 of file JHead.hh.

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

Definition at line 1499 of file JHead.hh.

JAANET::muon_desc_file JAANET::JHead::muon_desc_file

Definition at line 1500 of file JHead.hh.

JAANET::target JAANET::JHead::target

Definition at line 1501 of file JHead.hh.

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

Definition at line 1502 of file JHead.hh.

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

Definition at line 1503 of file JHead.hh.

JAANET::cut_primary JAANET::JHead::cut_primary

Definition at line 1504 of file JHead.hh.

JAANET::cut_seamuon JAANET::JHead::cut_seamuon

Definition at line 1505 of file JHead.hh.

JAANET::cut_in JAANET::JHead::cut_in

Definition at line 1506 of file JHead.hh.

JAANET::cut_nu JAANET::JHead::cut_nu

Definition at line 1507 of file JHead.hh.

JAANET::spectrum JAANET::JHead::spectrum

Definition at line 1508 of file JHead.hh.

JAANET::can JAANET::JHead::can

Definition at line 1509 of file JHead.hh.

JAANET::fixedcan JAANET::JHead::fixedcan

Definition at line 1510 of file JHead.hh.

JAANET::genvol JAANET::JHead::genvol

Definition at line 1511 of file JHead.hh.

JAANET::coord_origin JAANET::JHead::coord_origin

Definition at line 1512 of file JHead.hh.

JAANET::genhencut JAANET::JHead::genhencut

Definition at line 1513 of file JHead.hh.

JAANET::norma JAANET::JHead::norma

Definition at line 1514 of file JHead.hh.

JAANET::livetime JAANET::JHead::livetime

Definition at line 1515 of file JHead.hh.

JAANET::seabottom JAANET::JHead::seabottom

Definition at line 1516 of file JHead.hh.

JAANET::depth JAANET::JHead::depth

Definition at line 1517 of file JHead.hh.

JAANET::DAQ JAANET::JHead::DAQ

Definition at line 1518 of file JHead.hh.

JAANET::tgen JAANET::JHead::tgen

Definition at line 1519 of file JHead.hh.

JAANET::time_interval JAANET::JHead::time_interval

Definition at line 1520 of file JHead.hh.

JAANET::primary JAANET::JHead::primary

Definition at line 1521 of file JHead.hh.

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

Definition at line 1522 of file JHead.hh.

JAANET::end_event JAANET::JHead::end_event

Definition at line 1523 of file JHead.hh.


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