JAANET::getKM3Header Struct Reference

Match header for km3. More...

#include <JHeadToolkit.hh>

Inheritance diagram for JAANET::getKM3Header:

Public Member Functions
	getKM3Header ()
	Default constructor. More...
Vec	coord_origin () const
	Get coordinate origin. More...
const JHead &	getHeader () const
	Get header. More...
JHead &	getHeader ()
	Get header. More...
void	setHeader (const JHead &header)
	Set header. More...
template<class T >
bool	is_valid (T JHead::*pd) const
	Check validity of given data member in Head. 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 bool option=true) const
	Test match of headers. More...
bool	less (const JHead &header) const
	Comparison of headers. More...
JHead &	add (const JHead &header)
	Addition of headers. More...
std::istream &	read (std::istream &in)
	Read header from input. More...
std::ostream &	write (std::ostream &out) const
	Write header to output. More...
std::ostream &	print (std::ostream &out) const
	Print header to output. More...
	ClassDef (JHead, 3)
	ClassDef (Head, 2)
bool	have_line (std::string key) const
	Check availability of data with the given key. More...
const std::string &	get_line (std::string key) const
	Get data with the given key. More...
std::string &	get_line (std::string key)
	Get data with the given key. More...
void	set_line (std::string key, std::string line)
	Set data with the given key. More...
std::string	get_field (std::string key, int idx) const
	Get data with the given key at given index. More...
std::string	get_field (std::string key, std::string field) const
	Get data with the given key at given field. More...
int	get_index_of_field (std::string key, std::string field) const
	Get index of data with the given key at given field. More...
void	set_field (std::string key, std::string field, std::string value)
	Set data with the given key at given field. More...
double	ngen () const
	Get the number of generated events needed for computing event rates. More...
double	daq_livetime () const
	Get the the live time provided by the DAQ sytstem (=number of processed timeslices * frametime). More...
double	mc_livetime () const
	Get the Monte Carlo live time. More...
Vec	translate () const
	Get coordinate translation. More...

Static Public Member Functions
static JLANG::JEquationParameters &	getEquationParameters ()
	Get equation parameters corresponding to Monte Carlo ASCII format, i.e: More...
static void	setEquationParameters (const JLANG::JEquationParameters &equation)
	Set equation parameters. More...
static 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
JAANET::detector	detector
JAANET::muon_desc_file	muon_desc_file
JAANET::target	target
std::vector< JAANET::physics >	physics
std::vector< JAANET::simul >	simul
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::DAQ	DAQ
JAANET::tgen	tgen
JAANET::primary	primary
JAANET::end_event	end_event

Static Public Attributes
static const std::string	GENHEN = "GENHEN"
	Generators. More...
static const std::string	GENIE = "GENIE"
static const std::string	GSEAGEN = "gSeaGen"
static const std::string	MUPAGE = "HEMAS-DPM"
static const std::string	JSIRENE = "JSirene"
static const std::string	KM3 = "KM3"
static const std::string	KM3SIM = "KM3Sim"

Detailed Description

Match header for km3.

Definition at line 118 of file JHeadToolkit.hh.

Constructor & Destructor Documentation

JAANET::getKM3Header::getKM3Header ( )

inline

Default constructor.

Definition at line 124 of file JHeadToolkit.hh.

    {
      this->simul.resize(1);
      this->simul[0].program = JHead::KM3;

      this->push(&JHead::simul);
    }

Member Function Documentation

Vec Head::coord_origin ( ) const

inlineinherited

Get coordinate origin.

Returns

position

Definition at line 319 of file Head.hh.

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

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

inlineinherited

Get header.

Returns

header

Definition at line 881 of file JHead.hh.

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

JHead& JAANET::JHead::getHeader ( )

inlineinherited

Get header.

Returns

header

Definition at line 892 of file JHead.hh.

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

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

inlineinherited

Set header.

Parameters

header

header

Definition at line 903 of file JHead.hh.

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

template<class T >

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

inlineinherited

Check validity of given data member in Head.

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

Parameters

pd	pointer to data member

Returns

true if valid; else false

Definition at line 918 of file JHead.hh.

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

template<class T >

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

inlineinherited

Pull given data member from Head.

Parameters

pd	pointer to data member

Returns

iterator of Head

Definition at line 931 of file JHead.hh.

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

template<class T >

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

inlineinherited

Pull given data member from Head.

Parameters

pd	pointer to data member

Returns

iterator of Head

Definition at line 944 of file JHead.hh.

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

template<class T >

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

inlineinherited

Push given data member to Head.

Parameters

pd	pointer to data member

Definition at line 956 of file JHead.hh.

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

template<class T >

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

inlineinherited

Remove given data member from Head.

Parameters

pd	pointer to data member

Definition at line 968 of file JHead.hh.

    {
      iterator p = this->pull(pd);

      if (p != this->end()) {

        this->*pd = T();

        static_cast<Head*>(this)->erase(p);
      }
    }

bool JAANET::JHead::match ( const JHead &  header, const bool  option = true  ) const

inlineinherited

Test match of headers.

Note that if option is set to false, the match applies only to data which have a corresponding entry in the underlying map of the given header.

Parameters

header	second header
option	option

Returns

true if matches; else false

Definition at line 991 of file JHead.hh.

    {
      return (match(*this, header, option, &JHead::cut_primary)       &&
              match(*this, header, option, &JHead::cut_seamuon)       &&
              match(*this, header, option, &JHead::cut_in)            &&
              match(*this, header, option, &JHead::cut_nu)            &&
              match(*this, header, option, &JHead::physics)           &&
              match(*this, header, option, &JHead::simul)             &&
              match(*this, header, option, &JHead::spectrum)          &&
              match(*this, header, option, &JHead::can)               &&
              match(*this, header, option, &JHead::fixedcan)          &&
              match(*this, header, option, &JHead::genvol)            &&
              match(*this, header, option, &JHead::coord_origin)      &&
              match(*this, header, option, &JHead::norma)             &&
              match(*this, header, option, &JHead::livetime)          &&
              match(*this, header, option, &JHead::seabottom)         &&
              match(*this, header, option, &JHead::primary)           &&
              match(*this, header, option, &JHead::DAQ));
    }

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

inlineinherited

Comparison of headers.

Parameters

header

header

Returns

true if this header less than given header; else false

Definition at line 1018 of file JHead.hh.

    {
      if      (primary.less(header.primary))
        return true;
      else if (header.primary.less(primary))
        return false;
      else
        return cut_primary.less(header.cut_primary);
    }

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

inlineinherited

Addition of headers.

Parameters

header

header

Returns

this header

Definition at line 1035 of file JHead.hh.

    {
      if (match(header)) {

        genvol  .add(header.genvol);
        norma   .add(header.norma);
        livetime.add(header.livetime);
        DAQ     .add(header.DAQ);

      } else {

        THROW(JException, "JHead::add() headers do not match.");
      }

      return *this;
    }

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

inlinestaticinherited

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

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

Returns

equation parameters

Definition at line 1119 of file JHead.hh.

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

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

inlinestaticinherited

Set equation parameters.

Parameters

equation

equation parameters

Definition at line 1132 of file JHead.hh.

    {
      getEquationParameters() = equation;
    }

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

inherited

Read header from input.

Parameters

in	input stream

Returns

input stream

Definition at line 42 of file JHead.cc.

  {
    using namespace std;
    using namespace JPP;

    JStringStream is(in);

    if (getFileStatus(is.str().c_str())) {
      is.load();
    }

    JRootReader reader(is, JHead::getEquationParameters(), JAAnetDictionary::getInstance());

    JRootReadableClass cls(*this);
    
    for (JEquation equation; reader >> equation && equation.getKey() != end_event::Class_Name(); ) {

      JRedirectString redirect(reader, equation.getValue());

      const JRootReadableClass abc = cls.find(equation.getKey().c_str());

      if (abc.is_valid()) {
        reader.getObject(abc);
      }

      (*this)[equation.getKey()] = equation.getValue();
    }

    return in;
  }

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

inherited

Write header to output.

Parameters

out	output stream

Returns

output stream

Definition at line 80 of file JHead.cc.

  {
    using namespace std;
    using namespace JPP;

    JRootWriter writer(out, JHead::getEquationParameters(), JAAnetDictionary::getInstance());

    JRootWritableClass cls(*this);

    TIterator* i = cls.getClass()->GetListOfDataMembers()->MakeIterator();

    for (const TDataMember* p; (p = (const TDataMember*) i->Next()) != NULL; ) {
      if (!JRootClass::is_static(*p)) {
        if (this->find(p->GetName()) != this->end()                    ||
            cls.get(*p)              == JRootClass(&JHead::start_run)  ||
            cls.get(*p)              == JRootClass(&JHead::end_event)) {
          writer.put(p->GetName(), cls.get(*p), true);
        }
      }
    }

    return out << flush;
  }

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

inherited

Print header to output.

Parameters

out	output stream

Returns

output stream

Definition at line 111 of file JHead.cc.

  {
    using namespace std;
    using namespace JPP;

    const JEquationParameters& parameters = JHead::getEquationParameters();

    JRootWriter writer(out, parameters, JAAnetDictionary::getInstance());

    JRootWritableClass cls(*this);

    TIterator* i = cls.getClass()->GetListOfDataMembers()->MakeIterator();

    pair<string, JRootWritableClass> end_event("", this->end_event);

    for (const TDataMember* p; (p = (const TDataMember*) i->Next()) != NULL; ) {
      if (!JRootClass::is_static(*p)) {
        if (cls.get(*p) != JRootClass(&JHead::end_event)) 
          writer.put(p->GetName(), cls.get(*p), true);
        else
          end_event = make_pair(p->GetName(), cls.get(*p));
      }
    }

    for (JHead::const_iterator i = this->begin(); i != this->end(); ++i) {
      if (!cls.find(i->first.c_str()).is_valid()) {
        out << i->first << parameters.getDefaultSeparator() << parameters.getDefaultWhiteSpace() << i->second << parameters.getDefaultEndOfLine();
      }
    }

    writer.put(end_event.first, end_event.second, true);

    return out << flush;
  }

JAANET::JHead::ClassDef ( JHead  , 3    )

inherited

Head::ClassDef ( Head  , 2    )

inherited

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

inlineinherited

Check availability of data with the given key.

Parameters

key

key

Returns

true if data are available; else false

Definition at line 75 of file Head.hh.

  {
    return count( key ) != 0;
  }

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

inlineinherited

Get data with the given key.

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

Parameters

key

key

Returns

data

Definition at line 87 of file Head.hh.

  {
    return this->at(key);
  }

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

inlineinherited

Get data with the given key.

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

Parameters

key

key

Returns

data

Definition at line 99 of file Head.hh.

  {
    return this->at(key);
  }

void Head::set_line ( std::string  key, std::string  line  )

inlineinherited

Set data with the given key.

Parameters

key	key
line	data

Definition at line 110 of file Head.hh.

  {
    std::map<std::string, std::string>::operator[]( key ) = line;
  }

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

inlineinherited

Get data with the given key at given index.

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

Parameters

key	key
idx	index

Returns

data

Definition at line 123 of file Head.hh.

  {
    using namespace std;

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

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

inlineinherited

Get data with the given key at given field.

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

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

Parameters

key	key
field	field

Returns

data

Definition at line 163 of file Head.hh.

  {  
    int idx = get_index_of_field(key, field);

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

    return get_field( key, idx );
  }

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

inlineinherited

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

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

Parameters

key	key
field	field

Returns

index (-1 if not present)

Definition at line 145 of file Head.hh.

  {
    auto v = _hdr_dict()[key];
    auto i = std::find (v.begin(), v.end(), field );
    if (i== v.end()) return -1;
    return i - v.begin();
  }

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

inlineinherited

Set data with the given key at given field.

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

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

Parameters

key	key
field	field
value	vakue

Definition at line 186 of file Head.hh.

  {
    using namespace std;

    if ( field == "" ) get_line( key ) = value;

    int idx = get_index_of_field( key, field );

    if ( idx < 0 ) 
      {
             THROW(Exception, "GFailed to find field in header line: " << key << " " << field);
      }

    vector<string> vals = splitstring( get_line( key ) );

    // if the fields before do not exist, add padding
    while ( int( vals.size() ) <= idx ) vals.push_back("0");

    vals[idx] = value;
    ostringstream ss;

    for (unsigned i =0; i< vals.size() ;i++ )
      {
              ss << vals[i];
        if ( i!=vals.size()-1) ss << " ";
      }
    set_line( key, ss.str() );

  }

static 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 238 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"
      "norma:primaryFlux numberOfPrimaries\n"
      "livetime:numberOfSeconds errorOfSeconds\n"
      "flux:type key file_1 file_2\n"
      "spectrum:alpha\n"
      "fixedcan:xcenter ycenter zmin zmax radius\n"
      "start_run:run_id";

    for( auto line: splitstring(desc,'\n') )
      {
        auto v = splitstring( line, ':');

        vector< string > fields = splitstring( v[1] );
        for( auto key : splitstring( v[0] ) )
          {
            r[key] = fields;
          }
      }
    return r;
  }

double Head::ngen ( ) const

inlineinherited

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

Returns

number of events

Definition at line 288 of file Head.hh.

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

double Head::daq_livetime ( ) const

inlineinherited

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

Returns

live time [s]

Definition at line 298 of file Head.hh.

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

double Head::mc_livetime ( ) const

inlineinherited

Get the Monte Carlo live time.

Returns

live time [s]

Definition at line 309 of file Head.hh.

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

Vec Head::translate ( ) const

inlineinherited

Get coordinate translation.

Returns

translation

Definition at line 331 of file Head.hh.

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

Member Data Documentation

const std::string JAANET::JHead::GENHEN = "GENHEN"

staticinherited

Generators.

Applications.

Definition at line 842 of file JHead.hh.

const std::string JAANET::JHead::GENIE = "GENIE"

staticinherited

Definition at line 843 of file JHead.hh.

const std::string JAANET::JHead::GSEAGEN = "gSeaGen"

staticinherited

Definition at line 844 of file JHead.hh.

const std::string JAANET::JHead::MUPAGE = "HEMAS-DPM"

staticinherited

Definition at line 845 of file JHead.hh.

const std::string JAANET::JHead::JSIRENE = "JSirene"

staticinherited

Definition at line 846 of file JHead.hh.

const std::string JAANET::JHead::KM3 = "KM3"

staticinherited

Definition at line 847 of file JHead.hh.

const std::string JAANET::JHead::KM3SIM = "KM3Sim"

staticinherited

Definition at line 848 of file JHead.hh.

JAANET::start_run JAANET::JHead::start_run

inherited

Definition at line 1083 of file JHead.hh.

JAANET::XSecFile JAANET::JHead::XSecFile

inherited

Definition at line 1084 of file JHead.hh.

JAANET::drawing JAANET::JHead::drawing

inherited

Definition at line 1085 of file JHead.hh.

JAANET::detector JAANET::JHead::detector

inherited

Definition at line 1086 of file JHead.hh.

JAANET::muon_desc_file JAANET::JHead::muon_desc_file

inherited

Definition at line 1087 of file JHead.hh.

JAANET::target JAANET::JHead::target

inherited

Definition at line 1088 of file JHead.hh.

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

inherited

Definition at line 1089 of file JHead.hh.

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

inherited

Definition at line 1090 of file JHead.hh.

JAANET::cut_primary JAANET::JHead::cut_primary

inherited

Definition at line 1091 of file JHead.hh.

JAANET::cut_seamuon JAANET::JHead::cut_seamuon

inherited

Definition at line 1092 of file JHead.hh.

JAANET::cut_in JAANET::JHead::cut_in

inherited

Definition at line 1093 of file JHead.hh.

JAANET::cut_nu JAANET::JHead::cut_nu

inherited

Definition at line 1094 of file JHead.hh.

JAANET::spectrum JAANET::JHead::spectrum

inherited

Definition at line 1095 of file JHead.hh.

JAANET::can JAANET::JHead::can

inherited

Definition at line 1096 of file JHead.hh.

JAANET::fixedcan JAANET::JHead::fixedcan

inherited

Definition at line 1097 of file JHead.hh.

JAANET::genvol JAANET::JHead::genvol

inherited

Definition at line 1098 of file JHead.hh.

JAANET::coord_origin JAANET::JHead::coord_origin

inherited

Definition at line 1099 of file JHead.hh.

JAANET::genhencut JAANET::JHead::genhencut

inherited

Definition at line 1100 of file JHead.hh.

JAANET::norma JAANET::JHead::norma

inherited

Definition at line 1101 of file JHead.hh.

JAANET::livetime JAANET::JHead::livetime

inherited

Definition at line 1102 of file JHead.hh.

JAANET::seabottom JAANET::JHead::seabottom

inherited

Definition at line 1103 of file JHead.hh.

JAANET::DAQ JAANET::JHead::DAQ

inherited

Definition at line 1104 of file JHead.hh.

JAANET::tgen JAANET::JHead::tgen

inherited

Definition at line 1105 of file JHead.hh.

JAANET::primary JAANET::JHead::primary

inherited

Definition at line 1106 of file JHead.hh.

JAANET::end_event JAANET::JHead::end_event

inherited

Definition at line 1107 of file JHead.hh.

---

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

• JHeadToolkit.hh