Evt Struct Reference

The Evt class respresent a Monte Carlo (MC) event as well as an offline event. More...

#include <Evt.hh>

Inheritance diagram for Evt:

Public Member Functions
	Evt ()
void	print (std::ostream &out=std::cout) const
	Print event. More...
void	clear ()
	Reset event. More...
void	clear_hits ()
	Clear the hit vectors and all the references to hits in the tracks. More...
std::vector< const Trk * >	primary_trks () const
	Return a vector with const pointers to the tracks that are 'primary'. More...
std::vector< Trk * >	primary_trks ()
	Return a vector of pointers to tracks that are 'primary'. More...
const Trk *	neutrino () const
	Get a const pointer to the (first) neutrino from the MC track list. More...
Trk *	neutrino ()
	Get a pointer to the (first) neutrino from the MC track list. More...
const Trk *	primary_neutrino () const
	Get a const pointer to primary neutrino from the MC track list. More...
Trk *	primary_neutrino ()
	Get a pointer to primary neutrino from the MC track list. More...
const Trk *	leading_lepton () const
	Get a const pointer to the first leading lepton from the MC track list. More...
Trk *	leading_lepton ()
	Get a pointer to leading lepton from the MC track list. More...
const Trk *	get_parent_of (const Trk &child) const
	Get a const pointer to the (first) parent of the track 'child'. More...
Trk *	get_parent_of (const Trk &child)
	Get a pointer ot the (first) parent of the track 'child'. More...
int	idx (const std::string &key) const
	Get index in user data of the item with given key. More...
bool	haveusr (const std::string &key) const
	Check availability of user data of the item with given key. More...
int	idxusr_checked (const std::string &key) const
	Get index in user data of the item with given key. More...
double	getusr (const std::string &key) const
	Get user data item with given key. More...
void	setusr (const std::string &key, double value)
	Set user data item with given key. More...
bool	delusr (const std::string &key)
	Remove (first) user data item with given key. More...
void	clearusr ()
	Clear user data. More...
void	printusr (std::ostream &out=std::cout)
	Print user data (i.e. More...

Public Attributes
int	id
	offline event identifier More...
int	det_id
	detector identifier from DAQ More...
int	mc_id
	identifier of the MC event (as found in ascii or antcc file). More...
int	run_id
	DAQ run identifier. More...
int	mc_run_id
	MC run identifier. More...
int	frame_index
	from the raw data More...
ULong64_t	trigger_mask
	trigger mask from raw data (i.e. the trigger bits) More...
ULong64_t	trigger_counter
	trigger counter More...
unsigned int	overlays
	number of overlaying triggered events More...
TTimeStamp	t
	UTC time of the timeslice, or the event_time for MC. (default: 01 Jan 1970 00:00:00) More...
std::vector< Hit >	hits
	list of hits More...
std::vector< Trk >	trks
	list of reconstructed tracks (can be several because of prefits,showers, etc). More...
std::vector< double >	w
	MC: Weights w[0]=w1, w[1]=w2, w[2]]=w3 (see e.g. Tag list) More...
std::vector< double >	w2list
	MC: factors that make up w[1]=w2 (see e.g. Tag list) More...
std::vector< double >	w3list
	MC: atmospheric flux information. More...
TTimeStamp	mc_event_time
	MC: true generation time (UTC) of the event, (default: 01 Jan 1970 00:00:00) More...
double	mc_t
	MC: time where the mc-event was put in the timeslice, since start of run (offset+frameidx*timeslice_duration) More...
std::vector< Hit >	mc_hits
	MC: list of MC truth hits. More...
std::vector< Trk >	mc_trks
	MC: list of MC truth tracks. More...
TString	comment
	user can use this as he/she likes More...
int	index
	user can use this as he/she likes More...
int	flags
	user can use this as he/she likes More...
std::vector< double >	usr
	user data More...
std::vector< std::string >	usr_names
	user keys More...
TObject *	any
	Pointer to "any" user data. More...

Detailed Description

The Evt class respresent a Monte Carlo (MC) event as well as an offline event.

Some data from the online (DAQ) event are copied.

Definition at line 19 of file Evt.hh.

Constructor & Destructor Documentation

Evt::Evt ( )

inline

Definition at line 55 of file Evt.hh.

        :
    id(0), det_id(0), mc_id(0), run_id(0), mc_run_id(0), frame_index(0),
    trigger_mask(0), trigger_counter(0),
    overlays(0), t(0), mc_event_time(0), mc_t(0), index(0), flags(0) {}

Member Function Documentation

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

inline

Print event.

Parameters

out	output stream

Definition at line 66 of file Evt.hh.

  {
    out << "Evt: id=" << id <<
        " run_id=" << run_id <<
        " #hits=" << hits.size() <<
        " #mc_hits=" << mc_hits.size() <<
        " #trks=" << trks.size() <<
        " #mc_trks=" << mc_trks.size() << std::endl;
  }

void Evt::clear ( )

inline

Reset event.

Definition at line 80 of file Evt.hh.

  {
    *this = Evt();
  }

void Evt::clear_hits ( )

inline

Clear the hit vectors and all the references to hits in the tracks.

Definition at line 88 of file Evt.hh.

  {
    hits.clear();
    mc_hits.clear();
    for (auto& t : trks )    t.hit_ids.clear();
    for (auto& t : mc_trks ) t.hit_ids.clear();
  }

std::vector<const Trk*> Evt::primary_trks ( ) const

inline

Return a vector with const pointers to the tracks that are 'primary'.

Here, primary means the tracks have no parents.

This method only works if MC parent-child relations are availabe.

Returns

list of pointers to primary tracks

Definition at line 107 of file Evt.hh.

  {
    std::vector<const Trk*> r;
    for (auto& t : mc_trks )
    {
      if ( t.is_primary() ) r.push_back(&t);
    }
    return r;
  }

std::vector<Trk*> Evt::primary_trks ( )

inline

Return a vector of pointers to tracks that are 'primary'.

Here, primary means the tracks have no parents.

Returns

list of pointers to primary tracks

Definition at line 124 of file Evt.hh.

  {
    std::vector<Trk*> r;
    for (auto& t : mc_trks )
    {
      if ( t.is_primary() ) r.push_back(&t);
    }
    return r;
  }

const Trk* Evt::neutrino ( ) const

inline

Get a const pointer to the (first) neutrino from the MC track list.

Returns

pointer to neutrino (nullptr if no neutrino is in the list)

Definition at line 140 of file Evt.hh.

  {
    for (auto& t : mc_trks )
    {
      if ( t.is_neutrino() ) return &t;
    }
    return nullptr;
  }

Trk* Evt::neutrino ( )

inline

Get a pointer to the (first) neutrino from the MC track list.

Returns

const pointer to neutrino (nullptr if no neutrino is in the list)

Definition at line 155 of file Evt.hh.

  {
    // see Effective C++, Scott Meyers, ISBN-13: 9780321334879.
    return const_cast<Trk *>(static_cast<const Evt &>(*this).neutrino() );
  }

const Trk* Evt::primary_neutrino ( ) const

inline

Get a const pointer to primary neutrino from the MC track list.

Only works if MC parent-child relations are availabe.

Returns

const pointer to primary neutrino (may be nullptr)

Definition at line 169 of file Evt.hh.

  {
    for ( auto& t : mc_trks )
    {
      if ( t.is_neutrino() and t.is_primary() ) return &t;
    }
    return nullptr;
  }

Trk* Evt::primary_neutrino ( )

inline

Get a pointer to primary neutrino from the MC track list.

Only works if MC parent-child relations are availabe.

Returns

pointer to primary neutrino

Definition at line 185 of file Evt.hh.

  {
    return const_cast<Trk *>(static_cast<const Evt &>(*this).primary_neutrino() );
  }

const Trk* Evt::leading_lepton ( ) const

inline

Get a const pointer to the first leading lepton from the MC track list.

Here, leading means the lepton that has a neutrino as mother.

Only works if MC parent-child relations are availabe.

Returns

pointer to leadig lepton (may be nullptr in case not found)

Definition at line 199 of file Evt.hh.

  {
    const Trk* nu = primary_neutrino();
    if (!nu) return nullptr;

    for (auto& t : mc_trks )
    {
      if ( t.is_lepton()    &&
      t.mother_id == nu->id &&
      !t.is_orphan() ) return &t;
    }
    return nullptr;
  }

Trk* Evt::leading_lepton ( )

inline

Get a pointer to leading lepton from the MC track list.

Here, leading means the lepton that has a neutrino as mother.

Only works if MC parent-child relations are availabe.

Returns

pointer to leadig lepton (may be nullptr in case not found)

Definition at line 221 of file Evt.hh.

  {
    return const_cast<Trk *>(static_cast<const Evt &>(*this).leading_lepton() );
  }

const Trk* Evt::get_parent_of ( const Trk &  child ) const

inline

Get a const pointer to the (first) parent of the track 'child'.

This method return nullptr if no parent is found.

Parameters

child

child particle

Returns

pointer to parent

Definition at line 233 of file Evt.hh.

  {
    for (auto& t : mc_trks )
    {
      if (child.mother_id == t.id ) return &t;
    }
    return nullptr;
  }

Trk* Evt::get_parent_of ( const Trk &  child )

inline

Get a pointer ot the (first) parent of the track 'child'.

This method return nullptr if no parent is found.

Parameters

child

child particle

Returns

pointer to parent

Definition at line 251 of file Evt.hh.

  {
    return const_cast<Trk *>(static_cast<const Evt &>(*this).get_parent_of(child) );
  }

int AAObject::idx ( const std::string &  key ) const

inlineinherited

Get index in user data of the item with given key.

Parameters

key

key

Returns

index (-1 if key does not exists)

Definition at line 29 of file AAObject.hh.

  {
    auto i = std::find (usr_names.begin(), usr_names.end(), key );
    if (i == usr_names.end()) return -1;
    return i - usr_names.begin();
  }

bool AAObject::haveusr ( const std::string &  key ) const

inlineinherited

Check availability of user data of the item with given key.

Parameters

key

key

Returns

true if available; else false

Definition at line 42 of file AAObject.hh.

  {
    return idx( key ) >= 0;
  }

int AAObject::idxusr_checked ( const std::string &  key ) const

inlineinherited

Get index in user data of the item with given key.

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

Parameters

key

key

Returns

index (-1 if key does not exists)

Definition at line 54 of file AAObject.hh.

  {
    int r = idx( key );
    if (r < 0)
    {
      THROW(Exception, "No user data for key " << key << " in aanet object of type " << this -> ClassName());
    }
    return r;
  }

double AAObject::getusr ( const std::string &  key ) const

inlineinherited

Get user data item with given key.

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

Parameters

key

key

Returns

value

Definition at line 72 of file AAObject.hh.

  {
    const int i = idx( key );

    if ( i  < 0 )
    {
      THROW(Exception, "No user data for key " << key << " in aanet object of type " << this -> ClassName());
    }

    if ( unsigned(i) >= usr.size() )
    {
      THROW(Exception, "Warning: inconsistent user data " << i << " >= " << usr.size());
    }

    return usr[i];
  }

void AAObject::setusr ( const std::string &  key, double  value  )

inlineinherited

Set user data item with given key.

Parameters

key	key
value	value

Definition at line 95 of file AAObject.hh.

  {
    int i = idx( key );
    if (i < 0)
    {
      if ( usr.size() < usr_names.size() )
      {
        // this should not happen, but let's just add empty data
        usr.resize( usr_names.size() );
      }
      else
      {
        // this is possible, add empty ("") names
        usr_names.resize( usr.size() );
      }

      usr_names.push_back( key );
      usr.push_back( value );
    }
    else
    {
      usr[i] = value;
    }
  }

bool AAObject::delusr ( const std::string &  key )

inlineinherited

Remove (first) user data item with given key.

Parameters

key

key

Returns

true if data have been removed; else false

Definition at line 126 of file AAObject.hh.

  {
    int i = idx( key );
    if ( i < 0 ) return false;

    usr.erase ( usr.begin() + i );
    usr_names.erase( usr_names.begin() + i );
    return true;
  }

void AAObject::clearusr ( )

inlineinherited

Clear user data.

Definition at line 139 of file AAObject.hh.

  {
    usr.resize(0);
    usr_names.resize(0);
  }

void AAObject::printusr ( std::ostream &  out = std::cout )

inlineinherited

Print user data (i.e.

list of all pairs of keys and values).

Parameters

out	output stream

Definition at line 150 of file AAObject.hh.

  {
    unsigned n = std::max( usr.size(), usr_names.size() );

    for (unsigned i = 0; i < n ; i++)
    {
      std::string name = "(unnamed)";
      if ( i < usr_names.size() && usr_names[i] != "" ) name = usr_names[i];
      out << i << " \t " << name << " : \t ";
      if ( i < usr.size() ) out << usr[i] << std::endl;
      else                  out << "(none)" << std::endl;
    }
  }

Member Data Documentation

int Evt::id

offline event identifier

Definition at line 21 of file Evt.hh.

int Evt::det_id

detector identifier from DAQ

Definition at line 22 of file Evt.hh.

int Evt::mc_id

identifier of the MC event (as found in ascii or antcc file).

Definition at line 23 of file Evt.hh.

int Evt::run_id

DAQ run identifier.

Definition at line 25 of file Evt.hh.

int Evt::mc_run_id

MC run identifier.

Definition at line 26 of file Evt.hh.

int Evt::frame_index

from the raw data

Definition at line 28 of file Evt.hh.

ULong64_t Evt::trigger_mask

trigger mask from raw data (i.e. the trigger bits)

Definition at line 29 of file Evt.hh.

ULong64_t Evt::trigger_counter

trigger counter

Definition at line 30 of file Evt.hh.

unsigned int Evt::overlays

number of overlaying triggered events

Definition at line 31 of file Evt.hh.

TTimeStamp Evt::t

UTC time of the timeslice, or the event_time for MC. (default: 01 Jan 1970 00:00:00)

Definition at line 32 of file Evt.hh.

std::vector<Hit> Evt::hits

list of hits

Definition at line 35 of file Evt.hh.

std::vector<Trk> Evt::trks

list of reconstructed tracks (can be several because of prefits,showers, etc).

Definition at line 36 of file Evt.hh.

std::vector<double> Evt::w

MC: Weights w[0]=w1, w[1]=w2, w[2]]=w3 (see e.g. Tag list)

Definition at line 39 of file Evt.hh.

std::vector<double> Evt::w2list

MC: factors that make up w[1]=w2 (see e.g. Tag list)

Definition at line 40 of file Evt.hh.

std::vector<double> Evt::w3list

MC: atmospheric flux information.

Definition at line 41 of file Evt.hh.

TTimeStamp Evt::mc_event_time

MC: true generation time (UTC) of the event, (default: 01 Jan 1970 00:00:00)

Definition at line 43 of file Evt.hh.

double Evt::mc_t

MC: time where the mc-event was put in the timeslice, since start of run (offset+frameidx*timeslice_duration)

Definition at line 44 of file Evt.hh.

std::vector<Hit> Evt::mc_hits

MC: list of MC truth hits.

Definition at line 45 of file Evt.hh.

std::vector<Trk> Evt::mc_trks

MC: list of MC truth tracks.

Definition at line 46 of file Evt.hh.

TString Evt::comment

user can use this as he/she likes

Definition at line 49 of file Evt.hh.

int Evt::index

user can use this as he/she likes

Definition at line 50 of file Evt.hh.

int Evt::flags

user can use this as he/she likes

Definition at line 51 of file Evt.hh.

std::vector<double> AAObject::usr

inherited

user data

Definition at line 20 of file AAObject.hh.

std::vector<std::string> AAObject::usr_names

inherited

user keys

Definition at line 21 of file AAObject.hh.

TObject* AAObject::any

inherited

Pointer to "any" user data.

Definition at line 171 of file AAObject.hh.

---

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

• Evt.hh