JAANET Namespace Reference

Extensions to AAnet data format. More...

Classes
struct	JEvtEvaluator
	Auxiliary class to determine value of Evt objects. More...
struct	start_run
	Start of run record. More...
struct	String
	General purpose string class. More...
struct	detector
	Detector file. More...
struct	muon_desc_file
	Muon descriptor file. More...
struct	target
	Target. More...
struct	XSecFile
	Neutrino cross section file. More...
struct	drawing
	Drawing. More...
struct	cut
	General purpose class of phase space generation. More...
struct	cut_primary
	Phase space of primary particle. More...
struct	cut_seamuon
	Phase space of atmospheric muon generation. More...
struct	cut_in
	Phase space of incoming particle. More...
struct	cut_nu
	Phase space of incident neutrino. More...
struct	generator
	Description of Monte Carlo event generation applications. More...
struct	physics
	Generator for neutrino interaction. More...
struct	simul
	Generator for simulation. More...
struct	spectrum
	Neutrino energy spectrum. More...
struct	can
	The cylinder used for photon tracking. More...
struct	fixedcan
	The fixe cylinder used for photon tracking. More...
struct	genvol
	Neutrino vertex volume. More...
struct	coord_origin
	Coordinate origin. More...
struct	genhencut
	Phase space for incident neutrino. More...
struct	norma
	Normlisation of CORSIKA events. More...
struct	livetime
	Normalisation of MUPAGE events. More...
struct	flux
	Neutrino flux. More...
struct	seabottom
	The bottom of the sea. More...
struct	DAQ
	Livetime of DAQ data. More...
struct	tgen
	Scaling time of neutrino interaction generators. More...
struct	primary
	Primary particle. More...
struct	end_event
	End of event record. More...
struct	JHead
	Monte Carlo run header. More...
struct	getMUPAGEHeader
	Match header for MUPAGE. More...
struct	getGenhenHeader
	Match header for genhen. More...
struct	getGenieHeader
	Match header for genie. More...
struct	getGSeaGenHeader
	Match header for gseagen. More...
struct	getSireneHeader
	Match header for JSirene.cc. More...
struct	getKM3Header
	Match header for km3. More...
struct	getKM3SimHeader
	Match header for km3. More...
struct	getCorsikaHeader
	Match header for Corsika. More...
struct	getDAQHeader
	Match header for DAQ. More...
struct	JHit_t
	Auxiliary class to set-up Hit. More...
struct	JHits_t
	Auxiliary data structure for list of hits with hit merging capability. More...
struct	JParticle
	Auxiliary class to handle particle name, codes and mass. More...
struct	JPDB
	Collection of particles. More...
struct	JTrk_t
	Auxiliary class to set-up Trk. More...
struct	JWeightMupage
	Implementation of event weighing for MUPAGE data. More...
struct	JWeightEvent
	Low-level interface for event weighing. More...
struct	JWeightEventHelper
	Helper class for event weighing. More...
struct	JWeightFileScanner
	Template file scanner with event weight. More...

Enumerations
enum	JHitType_t {   HIT_TYPE_MUON_DIRECT = +5, HIT_TYPE_MUON_SCATTERED = -5, HIT_TYPE_DELTARAYS_DIRECT = +4, HIT_TYPE_DELTARAYS_SCATTERED = -4,   HIT_TYPE_BREMSSTRAHLUNG_DIRECT = +3, HIT_TYPE_BREMSSTRAHLUNG_SCATTERED = -3, HIT_TYPE_SHOWER_DIRECT = +99, HIT_TYPE_SHOWER_SCATTERED = -99,   HIT_TYPE_NOISE = -1, HIT_TYPE_UNKNOWN = 0 }
	Enumeration of hit types based on km3 codes. More...
enum	JGeant4Type_t {   GEANT4_TYPE_PHOTON = 1, GEANT4_TYPE_ANTIELECTRON = 2, GEANT4_TYPE_ELECTRON = 3, GEANT4_TYPE_NEUTRINO = 4,   GEANT4_TYPE_ANTIMUON = 5, GEANT4_TYPE_MUON = 6, GEANT4_TYPE_NEUTRAL_PION = 7, GEANT4_TYPE_PION_PLUS = 8,   GEANT4_TYPE_PION_MINUS = 9, GEANT4_TYPE_KAON_LONG = 10, GEANT4_TYPE_KAON_PLUS = 11, GEANT4_TYPE_KAON_MINUS = 12,   GEANT4_TYPE_NEUTRON = 13, GEANT4_TYPE_PROTON = 14, GEANT4_TYPE_ANTIPROTON = 15, GEANT4_TYPE_KAON_SHORT = 16,   GEANT4_TYPE_ETA = 17, GEANT4_TYPE_LAMBDA = 18, GEANT4_TYPE_SIGMA_PLUS = 19, GEANT4_TYPE_NEUTRAL_SIGMA = 20,   GEANT4_TYPE_SIGMA_MINUS = 21, GEANT4_TYPE_NEUTRAL_XI = 22, GEANT4_TYPE_XI_MINUS = 23, GEANT4_TYPE_OMEGA_MINUS = 24,   GEANT4_TYPE_ANTINEUTRON = 25, GEANT4_TYPE_ANTILAMBDA = 26, GEANT4_TYPE_ANTISIGMA_MINUS = 27, GEANT4_TYPE_NEUTRAL_ANTISIGMA = 28,   GEANT4_TYPE_ANTISIGMA_PLUS = 29, GEANT4_TYPE_NEUTRAL_ANTIXI = 30, GEANT4_TYPE_ANTIXI_PLUS = 31, GEANT4_TYPE_ANTIOMEGA_PLUS = 32,   GEANT4_TYPE_DEUTERON = 45, GEANT4_TYPE_TRITON = 46, GEANT4_TYPE_ALPHA = 47, GEANT4_TYPE_GEANTINO = 48,   GEANT4_TYPE_HE3 = 49, GEANT4_TYPE_ANTITAU = 33, GEANT4_TYPE_TAU = 34 }
	Enumeration of hit types based on Geant4 codes, for compatbility with KM3Sim. More...
enum	JTrackType_t {   TRACK_TYPE_ELECTRON = 11, TRACK_TYPE_NUE = 12, TRACK_TYPE_MUON = 13, TRACK_TYPE_NUMU = 14,   TRACK_TYPE_TAU = 15, TRACK_TYPE_NUTAU = 16, TRACK_TYPE_PHOTON = 22, TRACK_TYPE_NEUTRAL_PION = 111,   TRACK_TYPE_CHARGED_PION_PLUS = 211, TRACK_TYPE_PION_PLUS = 211, TRACK_TYPE_K_LONG = 130, TRACK_TYPE_K_SHORT = 310,   TRACK_TYPE_K_PLUS = 321, TRACK_TYPE_PROTON = 2212, TRACK_TYPE_NEUTRON = 2112, TRACK_TYPE_LAMBDA = 3122,   TRACK_TYPE_SIGMA_PLUS = 3222, TRACK_TYPE_NEUTRAL_SIGMA = 3212, TRACK_TYPE_SIGMA_MINUS = 3112, TRACK_TYPE_NEUTRAL_XI = 3322,   TRACK_TYPE_XI_MINUS = 3312, TRACK_TYPE_OMEGA_MINUS = 3334, TRACK_TYPE_ANTIELECTRON = -11, TRACK_TYPE_ANTINUE = -12,   TRACK_TYPE_ANTIMUON = -13, TRACK_TYPE_ANTINUMU = -14, TRACK_TYPE_ANTITAU = -15, TRACK_TYPE_ANTINUTAU = -16,   TRACK_TYPE_NEUTRAL_ANTIPION = -111, TRACK_TYPE_CHARGED_PION_MINUS = -211, TRACK_TYPE_PION_MINUS = -211, TRACK_TYPE_ANTIK_LONG = -130,   TRACK_TYPE_ANTIK_SHORT = -310, TRACK_TYPE_K_MINUS = -321, TRACK_TYPE_ANTIPROTON = -2212, TRACK_TYPE_ANTINEUTRON = -2112,   TRACK_TYPE_ANTILAMBDA = -3122, TRACK_TYPE_ANTISIGMA_PLUS = -3222, TRACK_TYPE_ANTINEUTRAL_SIGMA = -3212, TRACK_TYPE_ANTISIGMA_MINUS = -3112,   TRACK_TYPE_ANTINEUTRAL_XI = -3322, TRACK_TYPE_ANTIXI_MINUS = -3312, TRACK_TYPE_ANTIOMEGA_MINUS = -3334 }
	Enumeration of track types based on PDG codes. More...

Functions
double	getTime (const Hit &hit)
	Get true time of hit. More...
double	getNPE (const Hit &hit)
	Get true charge of hit. More...
bool	is_noise (const Hit &hit)
	Verify hit origin. More...
JTimeRange	getTimeRange (const Evt &event)
	Get time range (i.e. time between earliest and latest hit) of Monte Carlo event. More...
JTimeRange	getTimeRange (const Evt &event, const JTimeRange &T_ns)
	Get time range (i.e. time between earliest and latest hit) of Monte Carlo event. More...
JPosition3D	getPosition (const Vec &v)
	Get position. More...
JPosition3D	getPosition (const Trk &track)
	Get position. More...
JDirection3D	getDirection (const Vec &v)
	Get direction. More...
JDirection3D	getDirection (const Trk &track)
	Get direction. More...
JAxis3D	getAxis (const Trk &track)
	Get axis. More...
JTrack3E	getTrack (const Trk &track)
	Get track. More...
JVertex3D	getVertex (const Trk &track)
	Get vertex. More...
JTransformation3D	getTransformation (const Trk &track)
	Get transformation. More...
JHitL0	getHit (const Hit &hit)
	Get transformation. More...
JHitL0	getHit (const Hit &hit, const JModuleRouter &router)
	Get transformation. More...
JHitL0	getHit (const Hit &hit, const JPMTRouter &router)
	Get transformation. More...
bool	is_photon (const Trk &track)
	Test whether given track is a photon or neutral pion. More...
bool	is_neutrino (const Trk &track)
	Test whether given track is a neutrino. More...
bool	is_electron (const Trk &track)
	Test whether given track is a (anti-)electron. More...
bool	is_muon (const Trk &track)
	Test whether given track is a (anti-)muon. More...
bool	is_tau (const Trk &track)
	Test whether given track is a (anti-)tau. More...
bool	is_pion (const Trk &track)
	Test whether given track is a charged pion. More...
bool	is_proton (const Trk &track)
	Test whether given track is a (anti-)proton. More...
bool	is_neutron (const Trk &track)
	Test whether given track is a (anti-)neutron. More...
bool	is_hadron (const Trk &track)
	Test whether given track is a hadron. More...
bool	has_particleID (const Trk &track, const int type)
	Test whether given track corresponds to given particle type. More...
bool	has_neutrino (const Evt &evt)
	Test whether given event has an incoming neutrino. More...
const Trk &	get_neutrino (const Evt &evt)
	Get incoming neutrino. More...
int	count_electrons (const Evt &evt)
	Count the number of electrons in a given event. More...
bool	has_electron (const Evt &evt)
	Test whether given event has an electron. More...
const Trk &	get_electron (const Evt &evt)
	Get first electron from the event tracklist. More...
bool	from_electron (const Hit &hit)
	Test whether given hit was produced by an electron. More...
int	count_muons (const Evt &evt)
	Count the number of muons in a given event. More...
bool	has_muon (const Evt &evt)
	Test whether given event has a muon. More...
const Trk &	get_muon (const Evt &evt)
	Get first muon from the event tracklist. More...
bool	from_muon (const Hit &hit)
	Test whether given hit was produced by a muon. More...
int	count_taus (const Evt &evt)
	Count the number of taus in a given event. More...
bool	has_tau (const Evt &evt)
	Test whether given event has a tau. More...
const Trk &	get_tau (const Evt &evt)
	Get first tau from the event tracklist. More...
bool	from_tau (const Hit &hit)
	Test whether given hit was produced by a tau. More...
int	count_hadrons (const Evt &evt)
	Count the number of hadrons in a given event (not including neutral pions) More...
bool	from_hadron (const Hit &hit)
	Test whether given hit was produced by a hadronic shower. More...
Trk	get_hadronic_cascade (const Evt &evt)
	Auxiliary function to get average direction and total energy of a hadronic cascade. More...
void	add_time_offset (Evt &evt, const double tOff)
	Add time offset to mc event; according to current definition, the absolute time of the event is defined by the track "t" attribute; this could change in the future if the global attribute mc_t is assigned to this purpose. More...
void	copy (const Head &from, JHead &to)
	Copy header from from to to. More...
void	copy (const JHead &from, Head &to)
	Copy header from from to to. More...
std::string	getTag (const std::string &tag)
	Get tag without aanet extension "_<counter>" for identical tags. More...
bool	operator== (const Head &first, const Head &second)
	Equal operator. More...
bool	operator< (const Head &first, const Head &second)
	Less than operator. More...
bool	is_mupage (const JHead &header)
	Check for generator. More...
bool	is_genhen (const JHead &header)
	Check for generator. More...
bool	is_genie (const JHead &header)
	Check for generator. More...
bool	is_sirene (const JHead &header)
	Check for detector simulation. More...
bool	is_km3 (const JHead &header)
	Check for detector simulation. More...
bool	is_km3sim (const JHead &header)
	Check for detector simulation. More...
bool	is_daq (const JHead &header)
	Check for real data. More...
template<class T >
T	get (const JHead &header)
	Get object from header. More...
template<>
Vec	get (const JHead &header)
	Get position offset of detector due to generator. More...
template<>
JPosition3D	get (const JHead &header)
	Get position offset of detector due to generator. More...
template<>
JCylinder3D	get (const JHead &header)
	Get cylinder corresponding to can. More...

Variables
static const int	AASHOWER_RECONSTRUCTION_TYPE = 101
	AAshower reconstruction type for AAnet. More...
static const JEvtEvaluator	getEvtValue
	Function object for evaluation of DAQ objects. More...
static const char	AANET_TAG_SEPARATOR = '_'
	Separator for AAnet tag extension for multiple tags ("_<counter>"). More...

Detailed Description

Extensions to AAnet data format.

Author

mlincetto

mdejong

Enumeration Type Documentation

enum JAANET::JHitType_t

Enumeration of hit types based on km3 codes.

Enumerator
HIT_TYPE_MUON_DIRECT	Direct light from muon.
HIT_TYPE_MUON_SCATTERED	Scattered light from muon.
HIT_TYPE_DELTARAYS_DIRECT	Direct light from delta-rays.
HIT_TYPE_DELTARAYS_SCATTERED	Scattered light from delta-rays.
HIT_TYPE_BREMSSTRAHLUNG_DIRECT	Direct light from Bremsstrahlung.
HIT_TYPE_BREMSSTRAHLUNG_SCATTERED	Scattered light from Bremsstrahlung.
HIT_TYPE_SHOWER_DIRECT	Direct light from primary shower.
HIT_TYPE_SHOWER_SCATTERED	Scattered light from primary shower.
HIT_TYPE_NOISE	Random noise.
HIT_TYPE_UNKNOWN	Unknown source.

Definition at line 68 of file JAAnetToolkit.hh.

                  {
    HIT_TYPE_MUON_DIRECT              =   +5,    //!< Direct    light from muon
    HIT_TYPE_MUON_SCATTERED           =   -5,    //!< Scattered light from muon
    HIT_TYPE_DELTARAYS_DIRECT         =   +4,    //!< Direct    light from delta-rays
    HIT_TYPE_DELTARAYS_SCATTERED      =   -4,    //!< Scattered light from delta-rays
    HIT_TYPE_BREMSSTRAHLUNG_DIRECT    =   +3,    //!< Direct    light from Bremsstrahlung
    HIT_TYPE_BREMSSTRAHLUNG_SCATTERED =   -3,    //!< Scattered light from Bremsstrahlung
    HIT_TYPE_SHOWER_DIRECT            =  +99,    //!< Direct    light from primary shower
    HIT_TYPE_SHOWER_SCATTERED         =  -99,    //!< Scattered light from primary shower
    HIT_TYPE_NOISE                    =   -1,    //!< Random noise
    HIT_TYPE_UNKNOWN                  =    0     //!< Unknown source
  };

enum JAANET::JGeant4Type_t

Enumeration of hit types based on Geant4 codes, for compatbility with KM3Sim.

Enumerator
GEANT4_TYPE_PHOTON
GEANT4_TYPE_ANTIELECTRON
GEANT4_TYPE_ELECTRON
GEANT4_TYPE_NEUTRINO
GEANT4_TYPE_ANTIMUON
GEANT4_TYPE_MUON
GEANT4_TYPE_NEUTRAL_PION
GEANT4_TYPE_PION_PLUS
GEANT4_TYPE_PION_MINUS
GEANT4_TYPE_KAON_LONG
GEANT4_TYPE_KAON_PLUS
GEANT4_TYPE_KAON_MINUS
GEANT4_TYPE_NEUTRON
GEANT4_TYPE_PROTON
GEANT4_TYPE_ANTIPROTON
GEANT4_TYPE_KAON_SHORT
GEANT4_TYPE_ETA
GEANT4_TYPE_LAMBDA
GEANT4_TYPE_SIGMA_PLUS
GEANT4_TYPE_NEUTRAL_SIGMA
GEANT4_TYPE_SIGMA_MINUS
GEANT4_TYPE_NEUTRAL_XI
GEANT4_TYPE_XI_MINUS
GEANT4_TYPE_OMEGA_MINUS
GEANT4_TYPE_ANTINEUTRON
GEANT4_TYPE_ANTILAMBDA
GEANT4_TYPE_ANTISIGMA_MINUS
GEANT4_TYPE_NEUTRAL_ANTISIGMA
GEANT4_TYPE_ANTISIGMA_PLUS
GEANT4_TYPE_NEUTRAL_ANTIXI
GEANT4_TYPE_ANTIXI_PLUS
GEANT4_TYPE_ANTIOMEGA_PLUS
GEANT4_TYPE_DEUTERON
GEANT4_TYPE_TRITON
GEANT4_TYPE_ALPHA
GEANT4_TYPE_GEANTINO
GEANT4_TYPE_HE3
GEANT4_TYPE_ANTITAU
GEANT4_TYPE_TAU

Definition at line 18 of file JParticleTypes.hh.

                     { GEANT4_TYPE_PHOTON            =   1,
                       GEANT4_TYPE_ANTIELECTRON      =   2,
                       GEANT4_TYPE_ELECTRON          =   3,
                       GEANT4_TYPE_NEUTRINO          =   4,
                       GEANT4_TYPE_ANTIMUON          =   5,
                       GEANT4_TYPE_MUON              =   6,
                       GEANT4_TYPE_NEUTRAL_PION      =   7,
                       GEANT4_TYPE_PION_PLUS         =   8,
                       GEANT4_TYPE_PION_MINUS        =   9,
                       GEANT4_TYPE_KAON_LONG         =  10,
                       GEANT4_TYPE_KAON_PLUS         =  11,
                       GEANT4_TYPE_KAON_MINUS        =  12,
                       GEANT4_TYPE_NEUTRON           =  13,
                       GEANT4_TYPE_PROTON            =  14,
                       GEANT4_TYPE_ANTIPROTON        =  15,
                       GEANT4_TYPE_KAON_SHORT        =  16,
                       GEANT4_TYPE_ETA               =  17,
                       GEANT4_TYPE_LAMBDA            =  18,
                       GEANT4_TYPE_SIGMA_PLUS        =  19,
                       GEANT4_TYPE_NEUTRAL_SIGMA     =  20,
                       GEANT4_TYPE_SIGMA_MINUS       =  21,
                       GEANT4_TYPE_NEUTRAL_XI        =  22,
                       GEANT4_TYPE_XI_MINUS          =  23,
                       GEANT4_TYPE_OMEGA_MINUS       =  24,
                       GEANT4_TYPE_ANTINEUTRON       =  25,
                       GEANT4_TYPE_ANTILAMBDA        =  26,
                       GEANT4_TYPE_ANTISIGMA_MINUS   =  27,
                       GEANT4_TYPE_NEUTRAL_ANTISIGMA =  28,
                       GEANT4_TYPE_ANTISIGMA_PLUS    =  29,
                       GEANT4_TYPE_NEUTRAL_ANTIXI    =  30,
                       GEANT4_TYPE_ANTIXI_PLUS       =  31,
                       GEANT4_TYPE_ANTIOMEGA_PLUS    =  32,
                       GEANT4_TYPE_DEUTERON          =  45,
                       GEANT4_TYPE_TRITON            =  46,
                       GEANT4_TYPE_ALPHA             =  47,
                       GEANT4_TYPE_GEANTINO          =  48,
                       GEANT4_TYPE_HE3               =  49,                   
                       //
                       // KM3NeT specific codes
                       //
                       GEANT4_TYPE_ANTITAU           =  33,
                       GEANT4_TYPE_TAU               =  34 };

enum JAANET::JTrackType_t

Enumeration of track types based on PDG codes.

Enumerator
TRACK_TYPE_ELECTRON
TRACK_TYPE_NUE
TRACK_TYPE_MUON
TRACK_TYPE_NUMU
TRACK_TYPE_TAU
TRACK_TYPE_NUTAU
TRACK_TYPE_PHOTON
TRACK_TYPE_NEUTRAL_PION
TRACK_TYPE_CHARGED_PION_PLUS
TRACK_TYPE_PION_PLUS
TRACK_TYPE_K_LONG
TRACK_TYPE_K_SHORT
TRACK_TYPE_K_PLUS
TRACK_TYPE_PROTON
TRACK_TYPE_NEUTRON
TRACK_TYPE_LAMBDA
TRACK_TYPE_SIGMA_PLUS
TRACK_TYPE_NEUTRAL_SIGMA
TRACK_TYPE_SIGMA_MINUS
TRACK_TYPE_NEUTRAL_XI
TRACK_TYPE_XI_MINUS
TRACK_TYPE_OMEGA_MINUS
TRACK_TYPE_ANTIELECTRON
TRACK_TYPE_ANTINUE
TRACK_TYPE_ANTIMUON
TRACK_TYPE_ANTINUMU
TRACK_TYPE_ANTITAU
TRACK_TYPE_ANTINUTAU
TRACK_TYPE_NEUTRAL_ANTIPION
TRACK_TYPE_CHARGED_PION_MINUS
TRACK_TYPE_PION_MINUS
TRACK_TYPE_ANTIK_LONG
TRACK_TYPE_ANTIK_SHORT
TRACK_TYPE_K_MINUS
TRACK_TYPE_ANTIPROTON
TRACK_TYPE_ANTINEUTRON
TRACK_TYPE_ANTILAMBDA
TRACK_TYPE_ANTISIGMA_PLUS
TRACK_TYPE_ANTINEUTRAL_SIGMA
TRACK_TYPE_ANTISIGMA_MINUS
TRACK_TYPE_ANTINEUTRAL_XI
TRACK_TYPE_ANTIXI_MINUS
TRACK_TYPE_ANTIOMEGA_MINUS

Definition at line 64 of file JParticleTypes.hh.

                    { TRACK_TYPE_ELECTRON           =  11,
                      TRACK_TYPE_NUE                =  12,
                      TRACK_TYPE_MUON               =  13,
                      TRACK_TYPE_NUMU               =  14,
                      TRACK_TYPE_TAU                =  15,
                      TRACK_TYPE_NUTAU              =  16,
                      TRACK_TYPE_PHOTON             =  22,
                      TRACK_TYPE_NEUTRAL_PION       =  111,
                      TRACK_TYPE_CHARGED_PION_PLUS  =  211,
                      TRACK_TYPE_PION_PLUS          =  211,
                      TRACK_TYPE_K_LONG             =  130,
                      TRACK_TYPE_K_SHORT            =  310,
                      TRACK_TYPE_K_PLUS             =  321,
                      TRACK_TYPE_PROTON             =  2212,
                      TRACK_TYPE_NEUTRON            =  2112,
                      TRACK_TYPE_LAMBDA             =  3122,
                      TRACK_TYPE_SIGMA_PLUS         =  3222,
                      TRACK_TYPE_NEUTRAL_SIGMA      =  3212,
                      TRACK_TYPE_SIGMA_MINUS        =  3112,
                      TRACK_TYPE_NEUTRAL_XI         =  3322,
                      TRACK_TYPE_XI_MINUS           =  3312,
                      TRACK_TYPE_OMEGA_MINUS        =  3334,

                      TRACK_TYPE_ANTIELECTRON       = -11,
                      TRACK_TYPE_ANTINUE            = -12,
                      TRACK_TYPE_ANTIMUON           = -13,
                      TRACK_TYPE_ANTINUMU           = -14,
                      TRACK_TYPE_ANTITAU            = -15,
                      TRACK_TYPE_ANTINUTAU          = -16,
                      TRACK_TYPE_NEUTRAL_ANTIPION   = -111,
                      TRACK_TYPE_CHARGED_PION_MINUS = -211,
                      TRACK_TYPE_PION_MINUS         = -211,
                      TRACK_TYPE_ANTIK_LONG         = -130,
                      TRACK_TYPE_ANTIK_SHORT        = -310,
                      TRACK_TYPE_K_MINUS            = -321,
                      TRACK_TYPE_ANTIPROTON         = -2212,
                      TRACK_TYPE_ANTINEUTRON        = -2112,
                      TRACK_TYPE_ANTILAMBDA         = -3122,
                      TRACK_TYPE_ANTISIGMA_PLUS     = -3222,
                      TRACK_TYPE_ANTINEUTRAL_SIGMA  = -3212,
                      TRACK_TYPE_ANTISIGMA_MINUS    = -3112,
                      TRACK_TYPE_ANTINEUTRAL_XI     = -3322,
                      TRACK_TYPE_ANTIXI_MINUS       = -3312,
                      TRACK_TYPE_ANTIOMEGA_MINUS    = -3334 };

Function Documentation

double JAANET::getTime ( const Hit &  hit )

inline

Get true time of hit.

Parameters

hit

hit

Returns

true time of hit

Definition at line 88 of file JAAnetToolkit.hh.

  {
    // if IGAIN = 0 in km3 program, then pure_xx values are not set.
    
    if (hit.pure_a == 0.0)
      return hit.t;
    else
      return hit.pure_t;
  }

double JAANET::getNPE ( const Hit &  hit )

inline

Get true charge of hit.

Parameters

hit

hit

Returns

true charge of hit

Definition at line 105 of file JAAnetToolkit.hh.

  {
    // if IGAIN = 0 in km3 program, then pure_xx values are not set.
    
    if (hit.pure_a == 0.0)
      return hit.a;
    else
      return hit.pure_a;
  }

bool JAANET::is_noise ( const Hit &  hit )

inline

Verify hit origin.

Parameters

hit

hit

Returns

true if noise; else false

Definition at line 122 of file JAAnetToolkit.hh.

  {
    return hit.type == HIT_TYPE_NOISE;
  }

JTimeRange JAANET::getTimeRange ( const Evt &  event )

inline

Get time range (i.e. time between earliest and latest hit) of Monte Carlo event.

Note that the global event time in not taken into account.

Parameters

event

event

Returns

time range

Definition at line 135 of file JAAnetToolkit.hh.

  {
    JTimeRange time_range(JTimeRange::DEFAULT_RANGE);

    for (std::vector<Hit>::const_iterator hit = event.mc_hits.begin(); hit != event.mc_hits.end(); ++hit) {
      if (!is_noise(*hit)) {
        time_range.include(getTime(*hit));
      }
    }

    return time_range;
  }

JTimeRange JAANET::getTimeRange ( const Evt &  event, const JTimeRange &  T_ns  )

inline

Get time range (i.e. time between earliest and latest hit) of Monte Carlo event.

The resulting time range is larger than or equal to the given time window.
Note that the global event time in not taken into account.

Parameters

event	event
T_ns	time window [ns]

Returns

time range

Definition at line 158 of file JAAnetToolkit.hh.

  {
    JTimeRange time_range = getTimeRange(event);

    if (time_range.getLength() < T_ns.getLength()) {
      time_range.setLength(T_ns.getLength());
    }

    return time_range;
  }

JPosition3D JAANET::getPosition ( const Vec &  v )

inline

Get position.

Parameters

v

vector

Returns

position

Definition at line 176 of file JAAnetToolkit.hh.

  {
    return JPosition3D(v.x, v.y, v.z);
  }

JPosition3D JAANET::getPosition ( const Trk &  track )

inline

Get position.

Parameters

track

track

Returns

position

Definition at line 188 of file JAAnetToolkit.hh.

  {
    return getPosition(track.pos);
  }

JDirection3D JAANET::getDirection ( const Vec &  v )

inline

Get direction.

Parameters

v

vector

Returns

direction

Definition at line 200 of file JAAnetToolkit.hh.

  {
    return JDirection3D(v.x, v.y, v.z);
  }

JDirection3D JAANET::getDirection ( const Trk &  track )

inline

Get direction.

Parameters

track

track

Returns

direction

Definition at line 211 of file JAAnetToolkit.hh.

  {
    return getDirection(track.dir);
  }

JAxis3D JAANET::getAxis ( const Trk &  track )

inline

Get axis.

Parameters

track

track

Returns

axis

Definition at line 223 of file JAAnetToolkit.hh.

  {
    return JAxis3D(getPosition(track), getDirection(track));
  }

JTrack3E JAANET::getTrack ( const Trk &  track )

inline

Get track.

Parameters

track

track

Returns

track

Definition at line 235 of file JAAnetToolkit.hh.

  {
    return JTrack3E(JTrack3D(getAxis(track), track.t), track.E);
  }

JVertex3D JAANET::getVertex ( const Trk &  track )

inline

Get vertex.

Parameters

track

track

Returns

vertex

Definition at line 247 of file JAAnetToolkit.hh.

  {
    return JVertex3D(getPosition(track), track.t);
  }

JTransformation3D JAANET::getTransformation ( const Trk &  track )

inline

Get transformation.

Parameters

track

track

Returns

transformation

Definition at line 259 of file JAAnetToolkit.hh.

  {
    return JTransformation3D(getPosition(track), getDirection(track));
  }

JHitL0 JAANET::getHit ( const Hit &  hit )

inline

Get transformation.

Parameters

hit

hit

Returns

hit

Definition at line 271 of file JAAnetToolkit.hh.

  {
    using namespace JPP;

    return JHitL0(JDAQPMTIdentifier(hit.dom_id, hit.channel_id), JAxis3D(getPosition(hit.pos), getDirection(hit.dir)), JHit(hit.t, hit.tot) );
  }

JHitL0 JAANET::getHit ( const Hit &  hit, const JModuleRouter &  router  )

inline

Get transformation.

Parameters

hit	hit
router	module router

Returns

hit

Definition at line 286 of file JAAnetToolkit.hh.

  {
    using namespace JPP;

    const JPMT& pmt = router.getModule(hit.dom_id).getPMT(hit.channel_id);

    return JHitL0(JDAQPMTIdentifier(hit.dom_id, hit.channel_id), pmt.getAxis(), JHit(getTime(hit.tdc, pmt.getCalibration()), getToT(hit.tot, pmt.getCalibration())));
  }

JHitL0 JAANET::getHit ( const Hit &  hit, const JPMTRouter &  router  )

inline

Get transformation.

Parameters

hit	hit
router	pmt router

Returns

hit

Definition at line 303 of file JAAnetToolkit.hh.

  {
    using namespace JPP;

    const JPMT& pmt = router.getPMT(hit.pmt_id);

    return JHitL0(JDAQPMTIdentifier(hit.dom_id, hit.channel_id), pmt.getAxis(), JHit(getTime(hit.tdc, pmt.getCalibration()), getToT(hit.tot, pmt.getCalibration())));
  }

bool JAANET::is_photon ( const Trk &  track )

inline

Test whether given track is a photon or neutral pion.

Parameters

track

track

Returns

true if photon or neutral pion; else false

Definition at line 319 of file JAAnetToolkit.hh.

                                            { return (    track.type  ==  TRACK_TYPE_PHOTON || 
                                                      abs(track.type) ==  TRACK_TYPE_NEUTRAL_PION); }

bool JAANET::is_neutrino ( const Trk &  track )

inline

Test whether given track is a neutrino.

Parameters

track

track

Returns

true if neutrino; else false

Definition at line 328 of file JAAnetToolkit.hh.

                                            { return (abs(track.type) == TRACK_TYPE_NUE  ||
                                                      abs(track.type) == TRACK_TYPE_NUMU ||
                                                      abs(track.type) == TRACK_TYPE_NUTAU); }

bool JAANET::is_electron ( const Trk &  track )

inline

Test whether given track is a (anti-)electron.

Parameters

track

track

Returns

true if (anti-)electron; else false

Definition at line 338 of file JAAnetToolkit.hh.

{ return (abs(track.type) == TRACK_TYPE_ELECTRON); }

bool JAANET::is_muon ( const Trk &  track )

inline

Test whether given track is a (anti-)muon.

Parameters

track

track

Returns

true if (anti-)muon; else false

Definition at line 346 of file JAAnetToolkit.hh.

{ return (abs(track.type) == TRACK_TYPE_MUON); }

bool JAANET::is_tau ( const Trk &  track )

inline

Test whether given track is a (anti-)tau.

Parameters

track

track

Returns

true if (anti-)tau; else false

Definition at line 354 of file JAAnetToolkit.hh.

{ return (abs(track.type) == TRACK_TYPE_TAU); }

bool JAANET::is_pion ( const Trk &  track )

inline

Test whether given track is a charged pion.

Parameters

track

track

Returns

true if charged pion; else false

Definition at line 362 of file JAAnetToolkit.hh.

{ return (abs(track.type) == TRACK_TYPE_CHARGED_PION_PLUS); }

bool JAANET::is_proton ( const Trk &  track )

inline

Test whether given track is a (anti-)proton.

Parameters

track

track

Returns

true if (anti-)proton; else false

Definition at line 370 of file JAAnetToolkit.hh.

{ return (abs(track.type) == TRACK_TYPE_PROTON); }

bool JAANET::is_neutron ( const Trk &  track )

inline

Test whether given track is a (anti-)neutron.

Parameters

track

track

Returns

true if (anti-)neutron; else false

Definition at line 378 of file JAAnetToolkit.hh.

{ return (abs(track.type) == TRACK_TYPE_NEUTRON); }

bool JAANET::is_hadron ( const Trk &  track )

inline

Test whether given track is a hadron.

Parameters

track

track

Returns

true if hadron; else fails

Definition at line 386 of file JAAnetToolkit.hh.

                                            { return (!is_neutrino(track) &&
                                                      !is_electron(track) &&
                                                      !is_muon    (track) &&
                                                      !is_tau     (track)); }

bool JAANET::has_particleID ( const Trk &  track, const int  type  )

inline

Test whether given track corresponds to given particle type.

Parameters

track	track
type	particle type

Returns

true if matches the corresponding particle; else false

Definition at line 398 of file JAAnetToolkit.hh.

{ return (track.type == type); }

bool JAANET::has_neutrino ( const Evt &  evt )

inline

Test whether given event has an incoming neutrino.

Parameters

evt

event

Returns

true if neutrino; else false

Definition at line 406 of file JAAnetToolkit.hh.

  { 
    return !evt.mc_trks.empty() && is_neutrino(evt.mc_trks[0]);
  }

const Trk& JAANET::get_neutrino ( const Evt &  evt )

inline

Get incoming neutrino.

Parameters

evt

event

Returns

neutrino

Definition at line 417 of file JAAnetToolkit.hh.

  {
    if (has_neutrino(evt))
      return evt.mc_trks[0];
    else
      THROW(JIndexOutOfRange, "This event has no neutrino.");
  }

int JAANET::count_electrons ( const Evt &  evt )

inline

Count the number of electrons in a given event.

Parameters

evt

event

Returns

number of electrons

Definition at line 431 of file JAAnetToolkit.hh.

  {
    return std::count_if(evt.mc_trks.begin(), evt.mc_trks.end(), is_electron);
  }

bool JAANET::has_electron ( const Evt &  evt )

inline

Test whether given event has an electron.

Parameters

evt

event

Returns

true if event has electron; else false

Definition at line 442 of file JAAnetToolkit.hh.

  {
    return count_electrons(evt) != 0;
  }

const Trk& JAANET::get_electron ( const Evt &  evt )

inline

Get first electron from the event tracklist.

Parameters

evt

event

Returns

electron

Definition at line 453 of file JAAnetToolkit.hh.

  {
    if (count_electrons(evt) > 0)
      return *std::find_if(evt.mc_trks.begin(), evt.mc_trks.end(), is_electron);
    else
      THROW(JIndexOutOfRange, "This event has no electron.");
  }

bool JAANET::from_electron ( const Hit &  hit )

inline

Test whether given hit was produced by an electron.

Warning: This method will only work with the output of KM3Sim. For JSirene or KM3, you should check if track.id == hit.origin instead.

Parameters

hit

hit

Returns

true if hit was produced by an electron; else false

Definition at line 470 of file JAAnetToolkit.hh.

  {
    return hit.type == GEANT4_TYPE_ELECTRON || hit.type == GEANT4_TYPE_ANTIELECTRON;
  }

int JAANET::count_muons ( const Evt &  evt )

inline

Count the number of muons in a given event.

Parameters

evt

event

Returns

number of muons

Definition at line 481 of file JAAnetToolkit.hh.

  {
    return std::count_if(evt.mc_trks.begin(), evt.mc_trks.end(), is_muon);
  }

bool JAANET::has_muon ( const Evt &  evt )

inline

Test whether given event has a muon.

Parameters

evt

event

Returns

true if event has muon; else false

Definition at line 492 of file JAAnetToolkit.hh.

  {
    return count_muons(evt) != 0;
  }

const Trk& JAANET::get_muon ( const Evt &  evt )

inline

Get first muon from the event tracklist.

Parameters

evt

event

Returns

muon

Definition at line 503 of file JAAnetToolkit.hh.

  {
    if (count_muons(evt) > 0)
      return *std::find_if(evt.mc_trks.begin(), evt.mc_trks.end(), is_muon);
    else
      THROW(JIndexOutOfRange, "This event has no muon.");
  }

bool JAANET::from_muon ( const Hit &  hit )

inline

Test whether given hit was produced by a muon.

Warning: This method will only work with the output of KM3Sim. For JSirene or KM3, you should check if track.id == hit.origin instead.

Parameters

hit

hit

Returns

true if hit was produced by a muon; else false

Definition at line 520 of file JAAnetToolkit.hh.

  {
    return hit.type == GEANT4_TYPE_MUON || hit.type == GEANT4_TYPE_ANTIMUON;
  }

int JAANET::count_taus ( const Evt &  evt )

inline

Count the number of taus in a given event.

Parameters

evt

event

Returns

number of taus

Definition at line 531 of file JAAnetToolkit.hh.

  {
    return std::count_if(evt.mc_trks.begin(), evt.mc_trks.end(), is_tau);
  }

bool JAANET::has_tau ( const Evt &  evt )

inline

Test whether given event has a tau.

Parameters

evt

event

Returns

true if event has tau; else false

Definition at line 542 of file JAAnetToolkit.hh.

  {
    return count_taus(evt) != 0;
  }

const Trk& JAANET::get_tau ( const Evt &  evt )

inline

Get first tau from the event tracklist.

Parameters

evt

event

Returns

tau

Definition at line 553 of file JAAnetToolkit.hh.

  {
    if (count_taus(evt) > 0)
      return *std::find_if(evt.mc_trks.begin(), evt.mc_trks.end(), is_tau);
    else
      THROW(JIndexOutOfRange, "This event has no tau.");
  }

bool JAANET::from_tau ( const Hit &  hit )

inline

Test whether given hit was produced by a tau.

Warning: This method will only work with the output of KM3Sim. For JSirene or KM3, you should check if track.id == hit.origin instead.

Parameters

hit

hit

Returns

true if hit was produced by a tau; else false

Definition at line 570 of file JAAnetToolkit.hh.

  {
    return hit.type == GEANT4_TYPE_TAU || hit.type == GEANT4_TYPE_ANTITAU;
  }

int JAANET::count_hadrons ( const Evt &  evt )

inline

Count the number of hadrons in a given event (not including neutral pions)

Parameters

evt

event

Returns

number of hadrons

Definition at line 581 of file JAAnetToolkit.hh.

  {
    return std::count_if(evt.mc_trks.begin(), evt.mc_trks.end(), is_hadron);
  }

bool JAANET::from_hadron ( const Hit &  hit )

inline

Test whether given hit was produced by a hadronic shower.

Warning: This method will only work with the output of KM3Sim. For JSirene or KM3, you should check if track.id == hit.origin instead.

Parameters

hit

hit

Returns

true if hit was produced by a hadron; else false

Definition at line 595 of file JAAnetToolkit.hh.

  {
    return (!from_electron(hit) && !from_muon(hit) && !from_tau(hit));
  }

Trk JAANET::get_hadronic_cascade ( const Evt &  evt )

inline

Auxiliary function to get average direction and total energy of a hadronic cascade.

Parameters

evt

event

Returns

cascade (default if there are no hadrons)

Definition at line 606 of file JAAnetToolkit.hh.

  {
    Trk cascade;
    
    for (std::vector<Trk>::const_iterator track = evt.mc_trks.begin(); track != evt.mc_trks.end(); ++track) {
      if (is_hadron(*track)) {
        cascade.E   += track->E;
        cascade.dir += track->dir * track->E;
        cascade.t    = track->t;
        cascade.pos  = track->pos;
      }
    }

    cascade.dir.normalize();

    return cascade;
  }

void JAANET::add_time_offset ( Evt &  evt, const double  tOff  )

inline

Add time offset to mc event; according to current definition, the absolute time of the event is defined by the track "t" attribute; this could change in the future if the global attribute mc_t is assigned to this purpose.

Parameters

evt	event
tOff	time offset [ns]

Definition at line 632 of file JAAnetToolkit.hh.

  {
    for (std::vector<Trk>::iterator p = evt.mc_trks.begin(); p != evt.mc_trks.end(); p++) {
      p->t += tOff;
    }
  }

void JAANET::copy	(	const Head &	from,
		JHead &	to
	)

Copy header from from to to.

Parameters

from	header
to	header

Definition at line 153 of file JHead.cc.

  {
    using namespace std;
    using namespace JPP;

    JRootReader        reader(null, JHead::getEquationParameters(), JAAnetDictionary::getInstance());
    JRootReadableClass cls(to);

    for (Head::const_iterator i = from.begin(); i != from.end(); ++i) {

      const JRootReadableClass& abc = cls.find(getTag(i->first).c_str());

      const string buffer = trim(i->second);

      if (abc.is_valid() && buffer != "") {

        JRedirectString redirect(reader, buffer);

        reader.getObject(abc);

        if (i->first == getTag(i->first)) {
          to.insert(*i);                                     // keep track of parsed tags
        }

      } else {

        //to.insert(*i);                                       // store data of unknown tags
      }
    }
  }

void JAANET::copy	(	const JHead &	from,
		Head &	to
	)

Copy header from from to to.

Parameters

from	header
to	header

Definition at line 191 of file JHead.cc.

  {
    using namespace std;

    to = Head();

    stringstream io;

    from.write(io);

    read(to, io);
    
    // copy pending data

    for (JHead::const_iterator i = from.begin(); i != from.end(); ++i) {
      if (to.find(i->first) == to.end()) {
        to.insert(*i);
      }
    }
  }

std::string JAANET::getTag ( const std::string &  tag )

inline

Get tag without aanet extension "_<counter>" for identical tags.

Parameters

tag

tag

Returns

tag

Definition at line 61 of file JHead.hh.

  {
    using namespace std;
    
    const string::size_type pos = tag.find(AANET_TAG_SEPARATOR);
    
    if (pos != string::npos) {
      
      for (string::size_type i = pos + 1; i != tag.size(); ++i) {
        if (!isdigit(tag[i])) {
          return tag;
        }
      }
      
      return tag.substr(0, pos);
    }
    
    return tag;
  }

bool JAANET::operator== ( const Head &  first, const Head &  second  )

inline

Equal operator.

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

Parameters

first	first header
second	second header

Returns

true if two headers are equal; else false

Definition at line 1249 of file JHead.hh.

  {
    return JHead(first).match(JHead(second));
  }

bool JAANET::operator< ( const Head &  first, const Head &  second  )

inline

Less than operator.

Parameters

first	first header
second	second header

Returns

true if first header is less than second header; else false

Definition at line 1263 of file JHead.hh.

  {
    return JHead(first).less(JHead(second));
  }

bool JAANET::is_mupage ( const JHead &  header )

inline

Check for generator.

Parameters

header

header

Returns

true if this Monte Carlo is produced by mupage; else false

Definition at line 199 of file JHeadToolkit.hh.

  {
    return header.match(getMUPAGEHeader(), false);
  }

bool JAANET::is_genhen ( const JHead &  header )

inline

Check for generator.

Parameters

header

header

Returns

true if this Monte Carlo is produced by genhen; else false

Definition at line 211 of file JHeadToolkit.hh.

  {
    return header.match(getGenhenHeader(), false);
  }

bool JAANET::is_genie ( const JHead &  header )

inline

Check for generator.

Parameters

header

header

Returns

true if this Monte Carlo is produced by genie; else false

Definition at line 223 of file JHeadToolkit.hh.

  {
    return (header.match(getGenieHeader(),   false) ||
            header.match(getGSeaGenHeader(), false));
  }

bool JAANET::is_sirene ( const JHead &  header )

inline

Check for detector simulation.

Parameters

header

header

Returns

true if this Monte Carlo is processed with JSirene; else false

Definition at line 236 of file JHeadToolkit.hh.

  {
    return header.match(getSireneHeader(), false);
  }

bool JAANET::is_km3 ( const JHead &  header )

inline

Check for detector simulation.

Parameters

header

header

Returns

true if this Monte Carlo is processed with km3; else false

Definition at line 248 of file JHeadToolkit.hh.

  {
    return header.match(getKM3Header(), false);
  }

bool JAANET::is_km3sim ( const JHead &  header )

inline

Check for detector simulation.

Parameters

header

header

Returns

true if this Monte Carlo is processed with KM3Sim; else false

Definition at line 260 of file JHeadToolkit.hh.

  {
    return header.match(getKM3SimHeader(), false);
  }

bool JAANET::is_daq ( const JHead &  header )

inline

Check for real data.

Parameters

header

header

Returns

true if this header corresponds to real data; else false

Definition at line 272 of file JHeadToolkit.hh.

  {
    return header.match(getDAQHeader(), false);
  }

template<class T >

T JAANET::get ( const JHead &  header )

inline

Get object from header.

Parameters

header

header

Returns

object

Get object from header.

Parameters

header

header

Returns

position

Get object from header.

Parameters

header

header

Returns

cylinder

Definition at line 295 of file JHeadToolkit.hh.

  {
    if (is_sirene(header) || is_km3(header)) {

      return header.coord_origin;

    } else {

      if      (header.is_valid(&JHead::can))
        return Vec(0.0, 0.0, -header.can.zmin);
      else if (header.is_valid(&JHead::coord_origin))
        return header.coord_origin;
      else
        return Vec(0.0, 0.0, 0.0);
    }
  }

template<>

Vec JAANET::get ( const JHead &  header )

inline

Get position offset of detector due to generator.

Get object from header.

Parameters

header

header

Returns

position

Definition at line 295 of file JHeadToolkit.hh.

  {
    if (is_sirene(header) || is_km3(header)) {

      return header.coord_origin;

    } else {

      if      (header.is_valid(&JHead::can))
        return Vec(0.0, 0.0, -header.can.zmin);
      else if (header.is_valid(&JHead::coord_origin))
        return header.coord_origin;
      else
        return Vec(0.0, 0.0, 0.0);
    }
  }

template<>

JPosition3D JAANET::get ( const JHead &  header )

inline

Get position offset of detector due to generator.

Get object from header.

Parameters

header

header

Returns

position

Definition at line 320 of file JHeadToolkit.hh.

  {
    const Vec pos = get<Vec>(header);

    return JPosition3D(pos.x, pos.y, pos.z);
  }

template<>

JCylinder3D JAANET::get ( const JHead &  header )

inline

Get cylinder corresponding to can.

Get object from header.

Parameters

header

header

Returns

cylinder

Definition at line 335 of file JHeadToolkit.hh.

  {
    using namespace JGEOMETRY2D;

    return JCylinder3D(JCircle2D(JVector2D(), header.can.r),
                       header.can.zmin,
                       header.can.zmax);
  }

Variable Documentation

const int JAANET::AASHOWER_RECONSTRUCTION_TYPE = 101

static

AAshower reconstruction type for AAnet.

Definition at line 63 of file JAAnetToolkit.hh.

const JEvtEvaluator JAANET::getEvtValue

static

Function object for evaluation of DAQ objects.

Definition at line 48 of file JEvtEvaluator.hh.

const char JAANET::AANET_TAG_SEPARATOR = '_'

static

Separator for AAnet tag extension for multiple tags ("_<counter>").

Definition at line 32 of file JHead.hh.