JAANET Namespace Reference

Extensions to Evt data format. More...

Classes
struct	JAtmosphericNeutrinoFlux
	Implementation of atmospheric neutrino flux using official KM3NeT atmospheric flux function. More...
struct	JDiffuseFlux
	Low-level interface for diffuse fluxes. More...
struct	JEvtEvaluator
	Auxiliary class to determine value of Evt objects. More...
struct	JEvtWeight
	Abstract base class for event weighing. More...
struct	JEvtWeightCorsika
	Implementation of event weighting for Corsika data. More...
struct	JEvtWeightDAQ
	Implementation of event weighing for DAQ data. More...
struct	JEvtWeightFactor
	Low-level interface for retrieving a specifiable multiplication factor corresponding to a given event. More...
struct	JEvtWeightFactorFunction
	Implementation of event-weight factor interface. More...
struct	JEvtWeightFactorFunction< JDiffuseFluxFunction_t, JDiffuseFlux >
	Implementation of event-weight factor interface for diffuse flux objects. More...
struct	JEvtWeightFactorFunction< pEvtWeightFactor, JEvtWeightFactor_t >
	Implementation of C-style event-weight factor. More...
struct	JEvtWeightFactorFunction< pDiffuseFlux, JDiffuseFlux >
	Implementation of C-style diffuse flux event-weight factor. More...
struct	JEvtWeightFactorGSeaGen
	Implementation of reweighting factor for simulated neutrino interactions according to a specifiable ROOT TFormula. More...
struct	JEvtWeightFactorHelper
	Helper class for event-weight factor. More...
struct	JEvtWeightFactorHelper< JDiffuseFlux >
	Explicit emplate specialization of event-weight factor helper for diffuse flux objects. More...
struct	JEvtWeightFactorMultiParticle
	Implementation of event-weight factor for multiple particle types. More...
struct	JEvtWeightFactorMupage
	Implementation of reweighting factor for mupage events according to a specifiable ROOT TFormula. More...
struct	JEvtWeightGenhen
	Implementation of event weighting for Genhen data. More...
struct	JEvtWeightGSeaGen
	Implementation of event weighting for GSeaGen data. More...
struct	JEvtWeightHelper
	Helper class for event weighing. More...
struct	JEvtWeightInterface
	Low-level interface for event weighing. More...
struct	JEvtWeightKM3BUU
	Implementation of event weighting for KM3BUU data. More...
struct	JEvtWeightMiscellaneous
	Implementation of event weighing for miscellaneous data such as a merged offline file containing neutrinos and atmospheric muons. More...
struct	JEvtWeightMupage
	Implementation of event weighing for MUPAGE data. More...
struct	JEvtWeightNormalisation
	Auxiliary data structure for storing pairs of header UUIDs and event-weight normalisations. More...
struct	JEvtWeighter
	Look-up table for event weighters. More...
struct	JNeutrinoTypeCollection
	Auxiliary class for parsing a vector of neutrino PDG identifiers. More...
struct	JFluxMap
	Auxiliary class for parsing multiparticle fluxes. More...
struct	JFlatFlux
	Function object for constant fluxes. More...
struct	JFlux
	Low-level interface for retrieving the flux corresponding to a given event. More...
struct	JRange_t
	Type definition of range. 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	calibration
	Calibration. 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
	Physics information. 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 fixed 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	depth
	Depth. More...
struct	DAQ
	Livetime of DAQ data. More...
struct	K40
	Livetime of noise data. More...
struct	tgen
	Time duration of event generation. More...
struct	time_interval
	UTC time interval for event generation. More...
struct	primary
	Primary particle. More...
struct	end_event
	End of event record. More...
class	JHead
	Monte Carlo run header. More...
struct	JHeadHelper
	Auxiliary map of application to check method. More...
struct	JHeadWriter
	Implementation for Head output of JHead objects with ROOT dictionary. More...
struct	JLorentzBoost
	Auxiliary class for performing Lorentz boosts. More...
struct	JMultiHead
	Auxiliary data structure to store multiple headers and bookkeep event-weight normalisations. More...
struct	JOscFlux
	Implementation of oscillated neutrino flux. More...
struct	JParticle
	Auxiliary class to handle particle name, codes and mass. More...
struct	JPDB
	Collection of particles. More...
struct	JPowerLawFlux
	Example function object for computing power-law flux. More...
struct	JVolume
	Auxiliary class for histogramming of effective volume. More...
struct	JEventSelector
	Event selector. More...

Typedefs
typedef double(*	pEvtWeightFactor )(const Evt &)
	Type definition of event-weight factor pointer. More...
using	pFlux = pEvtWeightFactor
	Type definition of flux function pointer. More...
typedef double(*	pDiffuseFlux )(int, double, double)
	Type definition of pointer to diffuse flux function. More...
typedef JEvtWeightFactorHelper < JFlux >	JFluxHelper
	Type definition of event-weight factor helper for flux functions. More...
typedef JEvtWeightFactorHelper < JDiffuseFlux >	JDiffuseFluxHelper
	Type definition of event-weight factor helper for diffuse flux objects. More...
typedef JEvtWeightFactorMultiParticle < JFlux >	JFluxMultiParticle
	Type-definition of multi-particle event-weight factor for fluxes. More...
typedef bool(*	is_head )(const JHead &)
	Type definition of test function of header. More...

Enumerations
enum	JInteractionType_t { UNKNOWN = 0, ELECTROMAGNETIC = 1, WEAK_CHARGED_CURRENT = 2, WEAK_NEUTRAL_CURRENT = 3 }
	Enumeration of interaction types based on GENIE codes. More...
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_D_PLUS = 35, GEANT4_TYPE_D_MINUS = 36, GEANT4_TYPE_D_ZERO = 37, GEANT4_TYPE_ANTID_ZERO = 38,   GEANT4_TYPE_D_PLUS_S = 39, GEANT4_TYPE_D_MINUS_S = 40, GEANT4_TYPE_LAMBDA_PLUS_C = 41, 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, GEANT4_TYPE_XI_PLUS_C = 0, GEANT4_TYPE_XI_MINUS_C = 0,   GEANT4_TYPE_XI_ZERO_C = 0, GEANT4_TYPE_ANTIXI_ZERO_C = 0, GEANT4_TYPE_OMEGA_PLUS_B = 0, GEANT4_TYPE_ANTIOMEGA_ZERO_C = 0,   GEANT4_TYPE_OMEGA_MINUS_B = 0, GEANT4_TYPE_OMEGA_ZERO_C = 0, GEANT4_TYPE_B_PLUS = 0, GEANT4_TYPE_B_MINUS = 0,   GEANT4_TYPE_XI_MINUS_B = 0, GEANT4_TYPE_XI_PLUS_B = 0, GEANT4_TYPE_B_ZERO = 0, GEANT4_TYPE_ANTIB_ZERO = 0,   GEANT4_TYPE_B_ZERO_S = 0, GEANT4_TYPE_ANTIB_ZERO_S = 0, GEANT4_TYPE_XI_ZERO_B = 0, GEANT4_TYPE_ANTIXI_ZERO_B = 0,   GEANT4_TYPE_LAMBDA_B = 0, GEANT4_TYPE_ANTILAMBDA_B = 0, GEANT4_TYPE_B_PLUS_C = 0, GEANT4_TYPE_B_MINUS_C = 0 }
	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_D_PLUS = 411, TRACK_TYPE_D_ZERO = 421, TRACK_TYPE_D_PLUS_S = 431,   TRACK_TYPE_B_ZERO = 511, TRACK_TYPE_B_PLUS = 521, TRACK_TYPE_B_ZERO_S = 531, TRACK_TYPE_B_PLUS_C = 541,   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_LAMBDA_PLUS_C = 4122, TRACK_TYPE_XI_ZERO_C = 4132, TRACK_TYPE_XI_PLUS_C = 4232,   TRACK_TYPE_OMEGA_ZERO_C = 4332, TRACK_TYPE_LAMBDA_B = 5122, TRACK_TYPE_XI_MINUS_B = 5132, TRACK_TYPE_XI_ZERO_B = 5232,   TRACK_TYPE_OMEGA_MINUS_B = 5332, 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_D_MINUS = -411, TRACK_TYPE_D_MINUS_S = -431, TRACK_TYPE_ANTID_ZERO = -421,   TRACK_TYPE_ANTIB_ZERO = -511, TRACK_TYPE_B_MINUS = -521, TRACK_TYPE_ANTIB_ZERO_S = -531, TRACK_TYPE_B_MINUS_C = -541,   TRACK_TYPE_ANTIPROTON = -2212, TRACK_TYPE_ANTINEUTRON = -2112, TRACK_TYPE_ANTILAMBDA = -3122, TRACK_TYPE_ANTISIGMA_PLUS = -3222,   TRACK_TYPE_NEUTRAL_ANTISIGMA = -3212, TRACK_TYPE_ANTISIGMA_MINUS = -3112, TRACK_TYPE_NEUTRAL_ANTIXI = -3322, TRACK_TYPE_ANTIXI_MINUS = -3312,   TRACK_TYPE_ANTIOMEGA_MINUS = -3334, TRACK_TYPE_ANTIXI_ZERO_C = -4132, TRACK_TYPE_XI_MINUS_C = -4232, TRACK_TYPE_ANTIOMEGA_ZERO_C = -4332,   TRACK_TYPE_ANTILAMBDA_B = -5122, TRACK_TYPE_XI_PLUS_B = -5132, TRACK_TYPE_ANTIXI_ZERO_B = -5232, TRACK_TYPE_OMEGA_PLUS_B = -5332 }
	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 &pos)
	Get position. More...
Vec	getPosition (const JPosition3D &pos)
	Get position. More...
JPosition3D	getPosition (const Trk &track)
	Get position. More...
JDirection3D	getDirection (const Vec &dir)
	Get direction. More...
Vec	getDirection (const JDirection3D &dir)
	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...
JTransformation3D	getTransformation (const Trk &track)
	Get transformation. More...
double	getW (const Trk &track, const size_t index, const double value)
	Get track information. 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_lepton (const Trk &track)
	Test whether given track is a lepton. More...
bool	is_charged_lepton (const Trk &track)
	Test whether given track is a charged lepton. More...
bool	is_hadron (const Trk &track)
	Test whether given track is a hadron. More...
bool	is_meson (const Trk &track)
	Test whether given track is a meson (is hadron and third digit of PDG code is zero) More...
bool	is_baryon (const Trk &track)
	Test whether given track is a baryon (is hadron and third digit of PDG code is not zero) More...
bool	has_particleID (const Trk &track, const int type)
	Test whether given track corresponds to given particle type. More...
bool	is_initialstate (const Trk &track)
	Test whether given track corresponds to an initial state particle. More...
bool	is_finalstate (const Trk &track)
	Test whether given track corresponds to a final state particle. 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...
const Trk &	get_primary (const Evt &evt)
	Get primary. More...
JVertex3D	getVertex (const Trk &track)
	Get vertex. More...
JVertex3D	getVertex (const Evt &event)
	Get event vertex. 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	has_muonic_taudecay (const Evt &event)
	Test whether given event contains a tau-lepton decay into a muon. More...
bool	has_leptonic_taudecay (const Evt &event)
	Test whether given event contains a leptonic tau-decay. More...
bool	has_hadronic_taudecay (const Evt &event)
	Test whether given event contains a hadronic tau-decay. More...
int	count_taudecay_prongs (const Evt &event)
	Count the number of tau-lepton decay prongs in a given event. 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...
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...
double	getKineticEnergy (const Trk &trk)
	Get track kinetic energy. More...
double	getE0 (const Evt &evt)
	Get initial state energy of a neutrino interaction. More...
double	getE1 (const Evt &evt)
	Get final state energy of a neutrino interaction. More...
Vec	getP0 (const Evt &evt)
	Get momentum vector of the initial state of a neutrino interaction. More...
Vec	getP1 (const Evt &evt)
	Get momentum vector of the final state of a neutrino interaction. More...
double	getInvariantMass (const Evt &event)
	Get final state invariant mass. More...
template<class JOscProbInterpolator_t = JOscProbInterpolator<>>
JEvtWeightFactorFunction < JAtmosphericNeutrinoFlux, JFlux >	make_atmosphericNeutrinoFluxFunction (const std::string &oscProbTableFile, const JOscParametersInterface< double > &oscParameters)
	Auxiliary method for creating an interface to an atmospheric neutrino flux function using an oscillation probability interpolation table. More...
template<class JFunction_t , class JEvtWeightFactor_t = JEvtWeightFactor>
JEvtWeightFactorFunction < JFunction_t, JEvtWeightFactor_t >	make_weightFactor (const JFunction_t &function)
	Auxiliary method for creating an interface to an event-weight factor. More...
template<class JEvtWeightFactor_t = JEvtWeightFactor>
JEvtWeightFactorFunction < pEvtWeightFactor, JEvtWeightFactor_t >	make_weightFactor (pEvtWeightFactor function)
	Auxiliary method for creating an interface to an event-weight factor. More...
template<class JFunction_t >
JEvtWeightFactorFunction < JFunction_t, JFlux >	make_fluxFunction (const JFunction_t &flux)
	Auxiliary method for creating an interface to a flux function. More...
JEvtWeightFactorFunction < pFlux, JFlux >	make_fluxFunction (pFlux flux)
	Auxiliary method for creating an interface to a flux function. More...
template<class JFunction_t >
JEvtWeightFactorFunction < JFunction_t, JDiffuseFlux >	make_diffuseFluxFunction (const JFunction_t &flux)
	Auxiliary method for creating an interface to a diffuse flux function. More...
JEvtWeightFactorFunction < pDiffuseFlux, JDiffuseFlux >	make_diffuseFluxFunction (pDiffuseFlux flux)
	Auxiliary method for creating an interface to a diffuse flux function. More...
double	getVolume (const JType< JEvtWeightGSeaGen > &type, const Evt &evt)
	Get volume of given event according given weighter. More...
double	getVolume (const JType< JEvtWeightKM3BUU > &type, const Evt &evt)
	Get volume of given event according given weighter. More...
double	getVolume (const JType< JEvtWeightGenhen > &type, const Evt &evt)
	Get volume of given event according given weighter. More...
double	getVolume (const JEvtWeight &weighter, const Evt &evt)
	Get volume of given event according given weighter. More...
JEvtWeightFactorFunction < JFlatFlux, JFlux >	make_flatFluxFunction (const double flux)
	Auxiliary method for creating an interface to a flat flux function. 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...
std::string	getTag (const std::string &tag, const int counter)
	Get tag with 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_genhen (const JHead &header)
	Check for generator. More...
bool	is_gseagen (const JHead &header)
	Check for generator. More...
bool	is_mupage (const JHead &header)
	Check for generator. More...
bool	is_corsika (const JHead &header)
	Check for generator. More...
bool	is_km3buu (const JHead &header)
	Check for generator. 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_sirene (const JHead &header)
	Check for detector simulation. More...
bool	is_pure_noise (const JHead &header)
	Check for generator. More...
bool	is_daq (const JHead &header)
	Check for real data. More...
Vec	getOffset (const JHead &header)
	Get offset. More...
Vec	getOrigin (const JHead &header)
	Get origin. More...
JCylinder3D	getCylinder (const JHead &header)
	Get cylinder corresponding to the positions of generated tracks (i.e. More...
JLorentzBoost	getBoostToCOM (const Evt &event)
	Get Lorentz boost to the Center of Mass (COM) frame for a given neutrino interaction. More...
void	boostToCOM (Evt &event)
	Boost event to the Center of Mass (COM) frame. More...
JEvtWeightFactorFunction < JPowerLawFlux, JFlux >	make_powerLawFluxFunction (const double normalisation, const double spectralIndex)
	Auxiliary method for creating an interface to a power-law flux function. More...
bool	select (const Trk &trk, const Evt &evt)
	Event selection. More...
bool	hasW (const Trk &trk, const int i)
	Check availability of value. More...
double	getW (const Trk &trk, const int i)
	Get associated value. More...
double	getW (const Trk &trk, const int i, const double value)
	Get associated value. More...
void	setW (Trk &trk, const int i, const double value)
	Set associated value. More...

Variables
static const int	AASHOWER_RECONSTRUCTION_TYPE = 101
	AAnet shower fit reconstruction type. More...
static const JEvtEvaluator	getEvtValue
	Function object for evaluation of DAQ objects. More...
JEvtWeighter	getEventWeighter
	Function object for mapping header to event weighter. More...
static const char	AANET_TAG_SEPARATOR = '_'
	Separator for tag extension of multiple tags in Head ("_<counter>"). More...
static JHeadHelper	get_is_head
	Function object to get check method for given application. More...

Detailed Description

Extensions to Evt data format.

Author

bjung

mlincetto

mdejong, bjjung

mdejong

bjjung

bjung, mdejong

Typedef Documentation

typedef double(* JAANET::pEvtWeightFactor)(const Evt &)

Type definition of event-weight factor pointer.

Definition at line 108 of file JEvtWeightFactorFunction.hh.

using JAANET::pFlux = typedef pEvtWeightFactor

Type definition of flux function pointer.

Definition at line 112 of file JEvtWeightFactorFunction.hh.

typedef double(* JAANET::pDiffuseFlux)(int, double, double)

Type definition of pointer to diffuse flux function.

Definition at line 153 of file JEvtWeightFactorFunction.hh.

typedef JEvtWeightFactorHelper<JFlux> JAANET::JFluxHelper

Type definition of event-weight factor helper for flux functions.

Definition at line 204 of file JEvtWeightFactorHelper.hh.

typedef JEvtWeightFactorHelper<JDiffuseFlux> JAANET::JDiffuseFluxHelper

Type definition of event-weight factor helper for diffuse flux objects.

Definition at line 207 of file JEvtWeightFactorHelper.hh.

typedef JEvtWeightFactorMultiParticle<JFlux> JAANET::JFluxMultiParticle

Type-definition of multi-particle event-weight factor for fluxes.

Definition at line 169 of file JEvtWeightFactorMultiParticle.hh.

typedef bool(* JAANET::is_head)(const JHead &)

Type definition of test function of header.

Definition at line 28 of file JHeadToolkit.hh.

Enumeration Type Documentation

enum JAANET::JInteractionType_t

Enumeration of interaction types based on GENIE codes.

Enumerator
UNKNOWN
ELECTROMAGNETIC
WEAK_CHARGED_CURRENT
WEAK_NEUTRAL_CURRENT

Definition at line 76 of file JAAnetToolkit.hh.

                          {
    UNKNOWN              = 0,
    ELECTROMAGNETIC      = 1,
    WEAK_CHARGED_CURRENT = 2,
    WEAK_NEUTRAL_CURRENT = 3
  };

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 87 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_D_PLUS
GEANT4_TYPE_D_MINUS
GEANT4_TYPE_D_ZERO
GEANT4_TYPE_ANTID_ZERO
GEANT4_TYPE_D_PLUS_S
GEANT4_TYPE_D_MINUS_S
GEANT4_TYPE_LAMBDA_PLUS_C
GEANT4_TYPE_DEUTERON
GEANT4_TYPE_TRITON
GEANT4_TYPE_ALPHA
GEANT4_TYPE_GEANTINO
GEANT4_TYPE_HE3
GEANT4_TYPE_ANTITAU
GEANT4_TYPE_TAU
GEANT4_TYPE_XI_PLUS_C
GEANT4_TYPE_XI_MINUS_C
GEANT4_TYPE_XI_ZERO_C
GEANT4_TYPE_ANTIXI_ZERO_C
GEANT4_TYPE_OMEGA_PLUS_B
GEANT4_TYPE_ANTIOMEGA_ZERO_C
GEANT4_TYPE_OMEGA_MINUS_B
GEANT4_TYPE_OMEGA_ZERO_C
GEANT4_TYPE_B_PLUS
GEANT4_TYPE_B_MINUS
GEANT4_TYPE_XI_MINUS_B
GEANT4_TYPE_XI_PLUS_B
GEANT4_TYPE_B_ZERO
GEANT4_TYPE_ANTIB_ZERO
GEANT4_TYPE_B_ZERO_S
GEANT4_TYPE_ANTIB_ZERO_S
GEANT4_TYPE_XI_ZERO_B
GEANT4_TYPE_ANTIXI_ZERO_B
GEANT4_TYPE_LAMBDA_B
GEANT4_TYPE_ANTILAMBDA_B
GEANT4_TYPE_B_PLUS_C
GEANT4_TYPE_B_MINUS_C

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_D_PLUS            =  35,
                       GEANT4_TYPE_D_MINUS           =  36,
                       GEANT4_TYPE_D_ZERO            =  37,
                       GEANT4_TYPE_ANTID_ZERO        =  38,
                       GEANT4_TYPE_D_PLUS_S          =  39,
                       GEANT4_TYPE_D_MINUS_S         =  40,
                       GEANT4_TYPE_LAMBDA_PLUS_C     =  41,
                       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, 
                       //
                       // %Particles with PDG code but not GEANT
                       //
                       GEANT4_TYPE_XI_PLUS_C         =   0,
                       GEANT4_TYPE_XI_MINUS_C        =   0,
                       GEANT4_TYPE_XI_ZERO_C         =   0,
                       GEANT4_TYPE_ANTIXI_ZERO_C     =   0,
                       GEANT4_TYPE_OMEGA_PLUS_B      =   0,
                       GEANT4_TYPE_ANTIOMEGA_ZERO_C  =   0,
                       GEANT4_TYPE_OMEGA_MINUS_B     =   0,
                       GEANT4_TYPE_OMEGA_ZERO_C      =   0,
                       GEANT4_TYPE_B_PLUS            =   0,
                       GEANT4_TYPE_B_MINUS           =   0,
                       GEANT4_TYPE_XI_MINUS_B        =   0,
                       GEANT4_TYPE_XI_PLUS_B         =   0,
                       GEANT4_TYPE_B_ZERO            =   0,
                       GEANT4_TYPE_ANTIB_ZERO        =   0,
                       GEANT4_TYPE_B_ZERO_S          =   0,
                       GEANT4_TYPE_ANTIB_ZERO_S      =   0,
                       GEANT4_TYPE_XI_ZERO_B         =   0,
                       GEANT4_TYPE_ANTIXI_ZERO_B     =   0,
                       GEANT4_TYPE_LAMBDA_B          =   0,
                       GEANT4_TYPE_ANTILAMBDA_B      =   0,
                       GEANT4_TYPE_B_PLUS_C          =   0,
                       GEANT4_TYPE_B_MINUS_C         =   0 };

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_D_PLUS
TRACK_TYPE_D_ZERO
TRACK_TYPE_D_PLUS_S
TRACK_TYPE_B_ZERO
TRACK_TYPE_B_PLUS
TRACK_TYPE_B_ZERO_S
TRACK_TYPE_B_PLUS_C
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_LAMBDA_PLUS_C
TRACK_TYPE_XI_ZERO_C
TRACK_TYPE_XI_PLUS_C
TRACK_TYPE_OMEGA_ZERO_C
TRACK_TYPE_LAMBDA_B
TRACK_TYPE_XI_MINUS_B
TRACK_TYPE_XI_ZERO_B
TRACK_TYPE_OMEGA_MINUS_B
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_D_MINUS
TRACK_TYPE_D_MINUS_S
TRACK_TYPE_ANTID_ZERO
TRACK_TYPE_ANTIB_ZERO
TRACK_TYPE_B_MINUS
TRACK_TYPE_ANTIB_ZERO_S
TRACK_TYPE_B_MINUS_C
TRACK_TYPE_ANTIPROTON
TRACK_TYPE_ANTINEUTRON
TRACK_TYPE_ANTILAMBDA
TRACK_TYPE_ANTISIGMA_PLUS
TRACK_TYPE_NEUTRAL_ANTISIGMA
TRACK_TYPE_ANTISIGMA_MINUS
TRACK_TYPE_NEUTRAL_ANTIXI
TRACK_TYPE_ANTIXI_MINUS
TRACK_TYPE_ANTIOMEGA_MINUS
TRACK_TYPE_ANTIXI_ZERO_C
TRACK_TYPE_XI_MINUS_C
TRACK_TYPE_ANTIOMEGA_ZERO_C
TRACK_TYPE_ANTILAMBDA_B
TRACK_TYPE_XI_PLUS_B
TRACK_TYPE_ANTIXI_ZERO_B
TRACK_TYPE_OMEGA_PLUS_B

Definition at line 96 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_D_PLUS             =  411,
                      TRACK_TYPE_D_ZERO             =  421,
                      TRACK_TYPE_D_PLUS_S           =  431,
                      TRACK_TYPE_B_ZERO             =  511,
                      TRACK_TYPE_B_PLUS             =  521,
                      TRACK_TYPE_B_ZERO_S           =  531,
                      TRACK_TYPE_B_PLUS_C           =  541,
                      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_LAMBDA_PLUS_C      =  4122,
                      TRACK_TYPE_XI_ZERO_C          =  4132,
                      TRACK_TYPE_XI_PLUS_C          =  4232,
                      TRACK_TYPE_OMEGA_ZERO_C       =  4332,
                      TRACK_TYPE_LAMBDA_B           =  5122,
                      TRACK_TYPE_XI_MINUS_B         =  5132,
                      TRACK_TYPE_XI_ZERO_B          =  5232,
                      TRACK_TYPE_OMEGA_MINUS_B      =  5332,

                      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_D_MINUS            = -411,
                      TRACK_TYPE_D_MINUS_S          = -431,
                      TRACK_TYPE_ANTID_ZERO         = -421,
                      TRACK_TYPE_ANTIB_ZERO         = -511,
                      TRACK_TYPE_B_MINUS            = -521,
                      TRACK_TYPE_ANTIB_ZERO_S       = -531,
                      TRACK_TYPE_B_MINUS_C          = -541,
                      TRACK_TYPE_ANTIPROTON         = -2212,
                      TRACK_TYPE_ANTINEUTRON        = -2112,
                      TRACK_TYPE_ANTILAMBDA         = -3122,
                      TRACK_TYPE_ANTISIGMA_PLUS     = -3222,
                      TRACK_TYPE_NEUTRAL_ANTISIGMA  = -3212,
                      TRACK_TYPE_ANTISIGMA_MINUS    = -3112,
                      TRACK_TYPE_NEUTRAL_ANTIXI     = -3322,
                      TRACK_TYPE_ANTIXI_MINUS       = -3312,
                      TRACK_TYPE_ANTIOMEGA_MINUS    = -3334,
                      TRACK_TYPE_ANTIXI_ZERO_C      = -4132,
                      TRACK_TYPE_XI_MINUS_C         = -4232,
                      TRACK_TYPE_ANTIOMEGA_ZERO_C   = -4332,
                      TRACK_TYPE_ANTILAMBDA_B       = -5122,
                      TRACK_TYPE_XI_PLUS_B          = -5132,
                      TRACK_TYPE_ANTIXI_ZERO_B      = -5232,
                      TRACK_TYPE_OMEGA_PLUS_B       = -5332 };

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 107 of file JAAnetToolkit.hh.

  {
    return hit.t;
  }

double JAANET::getNPE ( const Hit &  hit )

inline

Get true charge of hit.

Parameters

hit

hit

Returns

true charge of hit

Definition at line 119 of file JAAnetToolkit.hh.

  {
    return hit.a;
  }

bool JAANET::is_noise ( const Hit &  hit )

inline

Verify hit origin.

Parameters

hit

hit

Returns

true if noise; else false

Definition at line 131 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 144 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 167 of file JAAnetToolkit.hh.

  {
    JTimeRange time_range = getTimeRange(event);

    if (!time_range.is_valid()) {
      time_range = T_ns;
    } 

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

    return time_range;
  }

JPosition3D JAANET::getPosition ( const Vec &  pos )

inline

Get position.

Parameters

pos

position

Returns

position

Definition at line 189 of file JAAnetToolkit.hh.

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

Vec JAANET::getPosition ( const JPosition3D &  pos )

inline

Get position.

Parameters

pos

position

Returns

position

Definition at line 201 of file JAAnetToolkit.hh.

  {
    return Vec(pos.getX(), pos.getY(), pos.getZ());
  }

JPosition3D JAANET::getPosition ( const Trk &  track )

inline

Get position.

Parameters

track

track

Returns

position

Definition at line 213 of file JAAnetToolkit.hh.

  {
    return getPosition(track.pos);
  }

JDirection3D JAANET::getDirection ( const Vec &  dir )

inline

Get direction.

Parameters

dir

direction

Returns

direction

Definition at line 225 of file JAAnetToolkit.hh.

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

Vec JAANET::getDirection ( const JDirection3D &  dir )

inline

Get direction.

Parameters

dir

direction

Returns

direction

Definition at line 237 of file JAAnetToolkit.hh.

  {
    return Vec(dir.getDX(), dir.getDY(), dir.getDZ());
  }

JDirection3D JAANET::getDirection ( const Trk &  track )

inline

Get direction.

Parameters

track

track

Returns

direction

Definition at line 249 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 261 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 273 of file JAAnetToolkit.hh.

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

JTransformation3D JAANET::getTransformation ( const Trk &  track )

inline

Get transformation.

Parameters

track

track

Returns

transformation

Definition at line 285 of file JAAnetToolkit.hh.

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

double JAANET::getW ( const Trk &  track, const size_t  index, const double  value  )

inline

Get track information.

Parameters

track	track
index	index
value	default value

Returns

actual value

Definition at line 299 of file JAAnetToolkit.hh.

  {
    if (index < track.fitinf.size())
      return track.fitinf[index];
    else
      return value;
  }

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 314 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 323 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 333 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 341 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 349 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 357 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 365 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 373 of file JAAnetToolkit.hh.

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

bool JAANET::is_lepton ( const Trk &  track )

inline

Test whether given track is a lepton.

Parameters

track

track

Returns

true if lepton; else fails

Definition at line 381 of file JAAnetToolkit.hh.

                                            { return (is_neutrino(track) ||
                                                      is_electron(track) ||
                                                      is_muon    (track) ||
                                                      is_tau     (track)); }

bool JAANET::is_charged_lepton ( const Trk &  track )

inline

Test whether given track is a charged lepton.

Parameters

track

track

Returns

true if lepton; else fails

Definition at line 392 of file JAAnetToolkit.hh.

                                                    { return (is_electron(track) ||
                                                              is_muon    (track) ||
                                                              is_tau     (track)); }

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 402 of file JAAnetToolkit.hh.

                                            { return (abs(track.type) != TRACK_TYPE_PHOTON &&
                                                      !is_lepton(track)); }

bool JAANET::is_meson ( const Trk &  track )

inline

Test whether given track is a meson (is hadron and third digit of PDG code is zero)

Parameters

track

track

Returns

true if hadron; else fails

Definition at line 411 of file JAAnetToolkit.hh.

                                            { return (is_hadron(track) &&
                                                      ((int)(track.type / 1000)) % 10 == 0); }

bool JAANET::is_baryon ( const Trk &  track )

inline

Test whether given track is a baryon (is hadron and third digit of PDG code is not zero)

Parameters

track

track

Returns

true if hadron; else fails

Definition at line 420 of file JAAnetToolkit.hh.

                                            { return (is_hadron(track) &&
                                                      ((int)(track.type / 1000)) % 10 != 0); }

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 430 of file JAAnetToolkit.hh.

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

bool JAANET::is_initialstate ( const Trk &  track )

inline

Test whether given track corresponds to an initial state particle.

Parameters

track

track

Returns

true if track corresponds to an initial state particle; else false

Definition at line 438 of file JAAnetToolkit.hh.

  {
    if        (Evt::ROOT_IO_VERSION >= 14) {
      
      return (track.status == TRK_ST_PRIMARYNEUTRINO ||
              track.status == TRK_ST_PRIMARYCOSMIC   ||
              track.status == TRK_ST_MUONBUNDLE      ||
              track.status == TRK_ST_ININUCLEI);
      
    } else if (Evt::ROOT_IO_VERSION >= 11) {

      return (track.mother_id == TRK_MOTHER_UNDEFINED ||
              track.mother_id == TRK_MOTHER_NONE);

    } else {
      
      return is_neutrino(track) && track.id == 0;
    }
  }

bool JAANET::is_finalstate ( const Trk &  track )

inline

Test whether given track corresponds to a final state particle.

Parameters

track

track

Returns

true if track corresponds to a final state particle; else false

Definition at line 464 of file JAAnetToolkit.hh.

  {
    if (Evt::ROOT_IO_VERSION >= 15) {
      return  track.status == TRK_ST_FINALSTATE;
    } else {
      return !is_initialstate(track);
    }
  }

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 479 of file JAAnetToolkit.hh.

  {
    if (Evt::ROOT_IO_VERSION >= 14) {

      std::vector<Trk>::const_iterator i = find_if(evt.mc_trks.cbegin(), evt.mc_trks.cend(),
                                                   make_predicate(&Trk::status, TRK_ST_PRIMARYNEUTRINO));
      return i != evt.mc_trks.cend();
      
    } else {
      
      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 499 of file JAAnetToolkit.hh.

  {
    if (Evt::ROOT_IO_VERSION >= 14) {
      
      std::vector<Trk>::const_iterator i = find_if(evt.mc_trks.cbegin(), evt.mc_trks.cend(),
                                                   make_predicate(&Trk::status, TRK_ST_PRIMARYNEUTRINO));

      if (i != evt.mc_trks.cend()) { return *i; }
      
    } else if (!evt.mc_trks.empty() && is_neutrino(evt.mc_trks[0])) {
      
      return evt.mc_trks[0];
    }
      
    THROW(JIndexOutOfRange, "JAANET::get_neutrino(): Event " << evt.id << " has no neutrino."); 
  }

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

inline

Get primary.

Parameters

evt

event

Returns

primary track

Definition at line 522 of file JAAnetToolkit.hh.

  {
    using namespace std;
    using namespace JPP;

    for (vector<Trk>::const_iterator i = evt.mc_trks.cbegin(); i != evt.mc_trks.cend(); ++i) {
      if (is_initialstate(*i) && i->status != TRK_ST_ININUCLEI) {
        return *i;
      }
    }

    THROW(JIndexOutOfRange, "JAANET::get_primary(): Cannot retrieve primary track for event " << evt.id << ".");
  }

JVertex3D JAANET::getVertex ( const Trk &  track )

inline

Get vertex.

Parameters

track

track

Returns

vertex

Definition at line 543 of file JAAnetToolkit.hh.

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

JVertex3D JAANET::getVertex ( const Evt &  event )

inline

Get event vertex.

Parameters

event

event

Returns

event vertex

Definition at line 554 of file JAAnetToolkit.hh.

  {
    using namespace std;
    using namespace JPP;
    
    if (has_neutrino(event)) {

      const Trk& neutrino = get_neutrino(event);

      return getVertex(neutrino);
      
    } else if (!event.mc_trks.empty()) {

      vector<Trk>::const_iterator i = find_if(event.mc_trks.begin(), event.mc_trks.end(), &is_initialstate);

      if (i != event.mc_trks.end()) {
        return getVertex(*i);
      } else {
        THROW(JValueOutOfRange, "getVertex(): No initial state track found.");
      }
      
    } else if (!event.trks.empty()) { // For reconstructed DAQ events
      
      const Trk& track = get_best_reconstructed_track<JPP_RECONSTRUCTION_TYPE>(event);

      return getVertex(track);
      
    } else {

      THROW(JValueOutOfRange, "getVertex(): Could not find a valid event vertex.");
    }
  }

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 593 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 604 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 615 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 632 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 643 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 654 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 665 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 682 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 693 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 704 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 715 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::has_muonic_taudecay ( const Evt &  event )

inline

Test whether given event contains a tau-lepton decay into a muon.

Parameters

event

event

Returns

true if event contains a muonic tau-lepton decay; else false

Definition at line 730 of file JAAnetToolkit.hh.

  {
    using namespace std;
    
    if (has_tau(event)) {
      
      const Trk& tau = get_tau(event);

      for (vector<Trk>::const_iterator i = event.mc_trks.cbegin(); i != event.mc_trks.cend(); ++i) {
        if (is_muon(*i) && i->mother_id == tau.id) {
          return true;
        }
      }
    }

    return false;
  }

bool JAANET::has_leptonic_taudecay ( const Evt &  event )

inline

Test whether given event contains a leptonic tau-decay.

Parameters

event

event

Returns

true if event contains a leptonic tau-decay; else false

Definition at line 754 of file JAAnetToolkit.hh.

  {
    using namespace std;
    
    if (has_tau(event)) {
      
      const Trk& tau = get_tau(event);

      for (vector<Trk>::const_iterator i = event.mc_trks.cbegin(); i != event.mc_trks.cend(); ++i) {
        if ((is_electron(*i) || is_muon(*i)) && i->mother_id == tau.id) {
          return true;
        }
      }
    }

    return false;
  }

bool JAANET::has_hadronic_taudecay ( const Evt &  event )

inline

Test whether given event contains a hadronic tau-decay.

Parameters

event

event

Returns

true if event contains a hadronic tau-decay; else false

Definition at line 778 of file JAAnetToolkit.hh.

  {
    return has_tau(event) && !has_leptonic_taudecay(event);
  }

int JAANET::count_taudecay_prongs ( const Evt &  event )

inline

Count the number of tau-lepton decay prongs in a given event.

The number of prongs is defined as the number of charged tau-lepton decay products.

Parameters

event

event

Returns

number of tau-lepton decay prongs

Definition at line 790 of file JAAnetToolkit.hh.

  {
    using namespace std;
    
    int n = 0;

    if (has_tau(event)) {

      const Trk& tau = get_tau(event);

      for (vector<Trk>::const_iterator i = event.mc_trks.cbegin(); i != event.mc_trks.cend(); ++i) {
        if (i->mother_id == tau.id && JPDB::getInstance().getPDG(i->type).charge != 0) {
          ++n;
        }
      }
    }

    return n;
  }

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 819 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 830 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 844 of file JAAnetToolkit.hh.

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

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 858 of file JAAnetToolkit.hh.

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

double JAANET::getKineticEnergy ( const Trk &  trk )

inline

Get track kinetic energy.

Parameters

trk

track

Returns

kinetic energy [GeV]

Definition at line 872 of file JAAnetToolkit.hh.

  {
    const double energy = trk.E;
    const double mass   = JPDB::getInstance().getPDG(trk.type).mass;

    return getKineticEnergy(energy, mass);
  }

double JAANET::getE0 ( const Evt &  evt )

inline

Get initial state energy of a neutrino interaction.

This method includes baryon number conservation.

Parameters

evt

event

Returns

energy [GeV]

Definition at line 888 of file JAAnetToolkit.hh.

  {
    using namespace std;
    
    const Trk& neutrino = get_neutrino(evt);
    
    double E0 = neutrino.E;
    
    for (vector<Trk>::const_iterator track = evt.mc_trks.cbegin(); track != evt.mc_trks.end(); ++track) {
      
      if (!is_finalstate(*track)) { continue; }
      
      if        (track->type == TRACK_TYPE_NEUTRON     ||
                 track->type == TRACK_TYPE_SIGMA_MINUS ||
                 track->type == TRACK_TYPE_NEUTRAL_SIGMA) {
          
        E0 += MASS_NEUTRON;
          
      } else if (track->type == TRACK_TYPE_PROTON     ||
                 track->type == TRACK_TYPE_LAMBDA     ||
                 track->type == TRACK_TYPE_SIGMA_PLUS) {
        
        E0 += MASS_PROTON;
        
      } else if (track->type == TRACK_TYPE_ANTINEUTRON) {
        
        E0 -= MASS_NEUTRON;
        
      } else if (track->type == TRACK_TYPE_ANTIPROTON ||
                 track->type == TRACK_TYPE_ANTILAMBDA) {
          
        E0 -= MASS_PROTON;
      }
    }

    return E0;
  }

double JAANET::getE1 ( const Evt &  evt )

inline

Get final state energy of a neutrino interaction.

This method includes muon energy loss.

Parameters

evt

event

Returns

energy [GeV]

Definition at line 934 of file JAAnetToolkit.hh.

  {
    using namespace std;
    using namespace JPP;
    
    double E1 = 0.0;
    
    const Trk& neutrino = get_neutrino(evt);

    for (vector<Trk>::const_iterator track = evt.mc_trks.cbegin(); track != evt.mc_trks.cend(); ++track) {

      if (!is_finalstate(*track)) { continue; }      
        
      if (is_muon(*track)) {

        const Trk& mother = ( track->mother_id > TRK_MOTHER_UNDEFINED ?
                              evt.mc_trks[track->mother_id] : neutrino );

        const double distance = (track->pos - mother.pos).len();

        E1 += gWater(track->E, -distance);
          
      } else {

        E1 += track->E;
      }
    }

    return E1;
  }

Vec JAANET::getP0 ( const Evt &  evt )

inline

Get momentum vector of the initial state of a neutrino interaction.

This method assumes neutrino DIS on a stationary nucleus

Parameters

evt

event

Returns

energy [GeV]

Definition at line 973 of file JAAnetToolkit.hh.

  {
    const Trk& neutrino = get_neutrino(evt);

    return neutrino.E * neutrino.dir;
  }

Vec JAANET::getP1 ( const Evt &  evt )

inline

Get momentum vector of the final state of a neutrino interaction.

This method includes muon energy losses.

Parameters

evt

event

Returns

final state momentum vector [GeV]

Definition at line 988 of file JAAnetToolkit.hh.

  {
    using namespace std;
    using namespace JPP;
    
    Vec P1(0,0,0);

    const Trk& neutrino = get_neutrino(evt);

    for (vector<Trk>::const_iterator track = evt.mc_trks.cbegin(); track != evt.mc_trks.cend(); ++track) {

      if (!is_finalstate(*track)) { continue; }
      
      double kineticEnergy = 0.0;

      if (is_muon(*track)) {

        const Trk& mother = ( track->mother_id > TRK_MOTHER_UNDEFINED ?
                              evt.mc_trks[track->mother_id] : neutrino );

        const double distance = (track->pos - mother.pos).len();
        const double energy   = gWater(track->E, -distance);

        kineticEnergy = getKineticEnergy(energy, MASS_MUON);
          
      } else {

        kineticEnergy = getKineticEnergy(*track);
      }

      P1 += kineticEnergy * track->dir;
    }
    
    return P1;
  }

double JAANET::getInvariantMass ( const Evt &  event )

inline

Get final state invariant mass.

Parameters

event

event

Returns

invariant mass [GeV]

Definition at line 1031 of file JAAnetToolkit.hh.

  {
    using namespace std;
    using namespace JPP;

    double Minv = 0.0;

    for (vector<Trk>::const_iterator track = event.mc_trks.cbegin(); track != event.mc_trks.cend(); ++track) {

      if (!is_finalstate(*track)) { continue; }

      const double mass = JPDB::getInstance().getPDG(track->type).mass;

      Minv += mass;
    }

    return Minv;
  }

template<class JOscProbInterpolator_t = JOscProbInterpolator<>>

JEvtWeightFactorFunction<JAtmosphericNeutrinoFlux, JFlux> JAANET::make_atmosphericNeutrinoFluxFunction ( const std::string &  oscProbTableFile, const JOscParametersInterface< double > &  oscParameters  )

inline

Auxiliary method for creating an interface to an atmospheric neutrino flux function
using an oscillation probability interpolation table.

Parameters

oscProbTableFile	oscillation probability interpolation table
oscParameters	oscillation parameters

Definition at line 90 of file JAtmosphericNeutrinoFlux.hh.

                                                                                                                                                              {

    const JOscProbInterpolator_t interpolator(oscProbTableFile.c_str(), oscParameters);

    const JAtmosphericNeutrinoFlux flux(interpolator);
    
    return make_fluxFunction(flux);
  }

template<class JFunction_t , class JEvtWeightFactor_t = JEvtWeightFactor>

JEvtWeightFactorFunction<JFunction_t, JEvtWeightFactor_t> JAANET::make_weightFactor ( const JFunction_t &  function )

inline

Auxiliary method for creating an interface to an event-weight factor.

Parameters

function

function object

Returns

event-weight factor interface

Definition at line 202 of file JEvtWeightFactorFunction.hh.

                                                                                                                  {
    return JEvtWeightFactorFunction<JFunction_t, JEvtWeightFactor_t>(function);
  }  

template<class JEvtWeightFactor_t = JEvtWeightFactor>

JEvtWeightFactorFunction<pEvtWeightFactor, JEvtWeightFactor_t> JAANET::make_weightFactor ( pEvtWeightFactor  function )

inline

Auxiliary method for creating an interface to an event-weight factor.

Parameters

function

function pointer

Returns

event-weight factor interface

Definition at line 214 of file JEvtWeightFactorFunction.hh.

                                                                                                                     {
    return JEvtWeightFactorFunction<pEvtWeightFactor, JEvtWeightFactor_t>(function);
  }

template<class JFunction_t >

JEvtWeightFactorFunction<JFunction_t, JFlux> JAANET::make_fluxFunction ( const JFunction_t &  flux )

inline

Auxiliary method for creating an interface to a flux function.

Parameters

flux	flux function object

Returns

flux function interface

Definition at line 226 of file JEvtWeightFactorFunction.hh.

                                                                                                 {
    return JEvtWeightFactorFunction<JFunction_t, JFlux>(flux);
  }

JEvtWeightFactorFunction<pFlux, JFlux> JAANET::make_fluxFunction ( pFlux  flux )

inline

Auxiliary method for creating an interface to a flux function.

Parameters

flux	flux function pointer

Returns

flux function interface

Definition at line 237 of file JEvtWeightFactorFunction.hh.

                                                                              {
    return JEvtWeightFactorFunction<pFlux, JFlux>(flux);
  }

template<class JFunction_t >

JEvtWeightFactorFunction<JFunction_t, JDiffuseFlux> JAANET::make_diffuseFluxFunction ( const JFunction_t &  flux )

inline

Auxiliary method for creating an interface to a diffuse flux function.

Parameters

flux	diffuse flux function object

Returns

diffuse flux function interface

Definition at line 249 of file JEvtWeightFactorFunction.hh.

                                                                                                               {
    return JEvtWeightFactorFunction<JFunction_t, JDiffuseFlux>(flux);
  }

JEvtWeightFactorFunction<pDiffuseFlux, JDiffuseFlux> JAANET::make_diffuseFluxFunction ( pDiffuseFlux  flux )

inline

Auxiliary method for creating an interface to a diffuse flux function.

Parameters

flux	diffuse flux function pointer

Returns

diffuse flux function interface

Definition at line 260 of file JEvtWeightFactorFunction.hh.

                                                                                                          {
    return JEvtWeightFactorFunction<pDiffuseFlux, JDiffuseFlux>(flux);
  }

double JAANET::getVolume ( const JType< JEvtWeightGSeaGen > &  type, const Evt &  evt  )

inline

Get volume of given event according given weighter.

Parameters

type	type
evt	event

Returns

volume [m^3 Gev sr]

Definition at line 328 of file JEvtWeightToolkit.hh.

  {
    return (evt.w[WEIGHTLIST_DIFFERENTIAL_EVENT_RATE] *
            evt.w2list[W2LIST_GSEAGEN_WATER_INT_LEN]  /
            evt.w2list[W2LIST_GSEAGEN_P_EARTH]);
  }

double JAANET::getVolume ( const JType< JEvtWeightKM3BUU > &  type, const Evt &  evt  )

inline

Get volume of given event according given weighter.

Parameters

type	type
evt	event

Returns

volume [m^3 Gev sr]

Definition at line 343 of file JEvtWeightToolkit.hh.

  {
    return (evt.w[WEIGHTLIST_DIFFERENTIAL_EVENT_RATE] *
            evt.w2list[W2LIST_KM3BUU_WATER_INT_LEN]   /
            evt.w2list[W2LIST_KM3BUU_P_EARTH]);
  }

double JAANET::getVolume ( const JType< JEvtWeightGenhen > &  type, const Evt &  evt  )

inline

Get volume of given event according given weighter.

Parameters

type	type
evt	event

Returns

volume [m^3 Gev sr]

Definition at line 358 of file JEvtWeightToolkit.hh.

  {
    using namespace JPHYSICS;

    const double l_int = 1.0e-6 * NUCLEON_MOLAR_MASS / (evt.w2list[W2LIST_GENHEN_SIG] * DENSITY_SEA_WATER * AVOGADRO);
    const double year  = 60*60*24*365;       // [s]

    return (evt.w[WEIGHTLIST_DIFFERENTIAL_EVENT_RATE] *
            l_int                                     /
            year                                      /
            evt.w2list[W2LIST_GENHEN_P_EARTH]);
  }

double JAANET::getVolume ( const JEvtWeight &  weighter, const Evt &  evt  )

inline

Get volume of given event according given weighter.

The return value should be normalised to

• number of generated events;
• solid angle covered by the generation; and
• bin width of the histogram.

Parameters

weighter	weighter
evt	event

Returns

volume [m^3 GeV sr]

Definition at line 384 of file JEvtWeightToolkit.hh.

  {
    if (dynamic_cast<const JEvtWeightGSeaGen*>(&weighter) != NULL) { return getVolume(JType<JEvtWeightGSeaGen>(), evt); }
    if (dynamic_cast<const JEvtWeightGenhen*> (&weighter) != NULL) { return getVolume(JType<JEvtWeightGenhen> (), evt); }
    if (dynamic_cast<const JEvtWeightKM3BUU*> (&weighter) != NULL) { return getVolume(JType<JEvtWeightKM3BUU> (), evt); }

    THROW(JCastException, "No valid weighter.");
  }

JEvtWeightFactorFunction<JFlatFlux, JFlux> JAANET::make_flatFluxFunction ( const double  flux )

inline

Auxiliary method for creating an interface to a flat flux function.

Parameters

flux	flux [GeV * m^-2 * sr^-1 * s^-1]

Definition at line 107 of file JFlatFlux.hh.

                                                                                             {

    const JFlatFlux flatFlux(flux);
    
    return make_fluxFunction(flatFlux);
  }

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

Copy header from from to to.

Parameters

from	header
to	header

Definition at line 162 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 201 of file JHead.cc.

  {
    using namespace std;
    using namespace JPP;

    to = Head();

    JHeadWriter writer(to, JHead::getEquationParameters(), JAAnetDictionary::getInstance());

    JRootWritableClass cls(from);

    unique_ptr<TIterator> i(cls.getClass()->GetListOfDataMembers()->MakeIterator());

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

    // 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 94 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;
  }

std::string JAANET::getTag ( const std::string &  tag, const int  counter  )

inline

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

Parameters

tag	tag
counter	counter

Returns

tag

Definition at line 122 of file JHead.hh.

  {
    std::ostringstream os;

    os << tag << AANET_TAG_SEPARATOR << counter;

    return os.str();
  }

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

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

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

inline

Less than operator.

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

Parameters

first	first header
second	second header

Returns

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

Definition at line 1817 of file JHead.hh.

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

bool JAANET::is_genhen ( const JHead &  header )

inline

Check for generator.

Parameters

header

header

Returns

true if this header is produced by genhen; else false

Definition at line 37 of file JHeadToolkit.hh.

  {
    for (const auto& i : header.simul) {
      if (i.program == APPLICATION_GENHEN) {
        return true;
      }
    }

    for (const auto& i : header.physics) { // legacy
      if (i.buffer.find(APPLICATION_GENHEN) != std::string::npos) {
        return true;
      }
    }

    return false;
  }

bool JAANET::is_gseagen ( const JHead &  header )

inline

Check for generator.

Parameters

header

header

Returns

true if this header is produced by gSeaGen; else false

Definition at line 61 of file JHeadToolkit.hh.

  {
    for (const auto& i : header.simul) {
      if (i.program == APPLICATION_GSEAGEN) {
        return true;
      }
    }

    for (const auto& i : header.physics) { // legacy
      if (i.buffer.find(APPLICATION_GSEAGEN) != std::string::npos) {
        return true;
      }
    }

    return false;
  }

bool JAANET::is_mupage ( const JHead &  header )

inline

Check for generator.

Parameters

header

header

Returns

true if this header is produced by MUPAGE; else false

Definition at line 85 of file JHeadToolkit.hh.

  {
    for (const auto& i : header.simul) {
      if (i.program == APPLICATION_MUPAGE) {
        return true;
      }
    }

    return false;
  }

bool JAANET::is_corsika ( const JHead &  header )

inline

Check for generator.

Parameters

header

header

Returns

true if this header is produced by Corsika; else false

Definition at line 103 of file JHeadToolkit.hh.

  {
    for (const auto& i : header.simul) {
      if (i.program == APPLICATION_CORSIKA) {
        return true;
      }
    }

    return false;
  }

bool JAANET::is_km3buu ( const JHead &  header )

inline

Check for generator.

Parameters

header

header

Returns

true if this header is produced by km3buu; else false

Definition at line 121 of file JHeadToolkit.hh.

  {
    for (const auto& i : header.simul) {
      if (i.program == APPLICATION_KM3BUU) {
        return true;
      }
    }

    return false;
  }

bool JAANET::is_km3 ( const JHead &  header )

inline

Check for detector simulation.

Parameters

header

header

Returns

true if this header is processed with km3; else false

Definition at line 139 of file JHeadToolkit.hh.

  {
    for (const auto& i : header.simul) {
      if (i.program == APPLICATION_KM3) {
        return true;
      }
    }

    return false;
  }

bool JAANET::is_km3sim ( const JHead &  header )

inline

Check for detector simulation.

Parameters

header

header

Returns

true if this header is processed with KM3Sim; else false

Definition at line 157 of file JHeadToolkit.hh.

  {
    for (const auto& i : header.simul) {
      if (i.program == APPLICATION_KM3SIM) {
        return true;
      }
    }

    return false;
  }

bool JAANET::is_sirene ( const JHead &  header )

inline

Check for detector simulation.

Parameters

header

header

Returns

true if this header is processed with JSirene; else false

Definition at line 175 of file JHeadToolkit.hh.

  {
    for (const auto& i : header.simul) {
      if (i.program == APPLICATION_JSIRENE) {
        return true;
      }
    }

    return false;
  }

bool JAANET::is_pure_noise ( const JHead &  header )

inline

Check for generator.

Parameters

header

header

Returns

true if this header is produced by pure noise; else false

Definition at line 193 of file JHeadToolkit.hh.

  {
    return header.K40.livetime_s > 0.0;
  }

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 205 of file JHeadToolkit.hh.

  {
    return header.DAQ.livetime_s > 0.0;
  }

Vec JAANET::getOffset ( const JHead &  header )

inline

Get offset.

For consistency with the position of the detector, a pending offset should be added to the positions of generated tracks (i.e. Evt::mc_trks).

The main logic can be summarised as follows.

1. if JHead::fixedcan is defined, the values correspond to an offset that has already been applied, (0,0,0) is returned;
2. else if JHead::can is defined, the values correspond to a z-range that has already been applied, (0,0,-zmin) is returned;
3. else if JHead::coord_origin is defined, the values correspond to an offset that has not yet been applied, (x,y,z) is returned;
4. else (0,0,0) is returned;

Parameters

header

header

Returns

position

Definition at line 275 of file JHeadToolkit.hh.

  {
    if      (header.is_valid(&JHead::fixedcan))
      return Vec(0.0, 0.0, 0.0);
    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);
  }

Vec JAANET::getOrigin ( const JHead &  header )

inline

Get origin.

The origin corresponds to the offset that has already been applied to the positions of generated tracks (i.e. Evt::mc_trks).

The main logic can be summarised as follows.

1. if JHead::fixedcan is defined, the values correspond to the offset that has already been applied, (x,y,0) is returned;
2. else if JHead::can is defined, the values correspond to a z-range that has already been applied, (0,0,zmin) is returned;
3. else if JHead::coord_origin is defined, the values correspond to the offset that has not yet been applied, (0,0,0) is returned;
4. else (0,0,0) is returned;

Parameters

header

header

Returns

position

Definition at line 309 of file JHeadToolkit.hh.

  {
    if      (header.is_valid(&JHead::fixedcan))
      return Vec(header.fixedcan.xcenter, header.fixedcan.ycenter, 0.0);
    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 Vec(0.0, 0.0, 0.0);
    else
      return Vec(0.0, 0.0, 0.0);
  }

JCylinder3D JAANET::getCylinder ( const JHead &  header )

inline

Get cylinder corresponding to the positions of generated tracks (i.e.

Evt::mc_trks).

For consistency with the position of the detector, the pending offset (see method JAANET::getOffset) should be added to the position of cylinder.

Parameters

header

header

Returns

cylinder

Definition at line 331 of file JHeadToolkit.hh.

  {
    using namespace JPP;

    if        (header.is_valid(&JHead::fixedcan)) {

      return JCylinder3D(JCircle2D(JVector2D(header.fixedcan.xcenter,
                                             header.fixedcan.ycenter), 
                                   header.fixedcan.radius),
                         header.fixedcan.zmin,
                         header.fixedcan.zmax);

    } else if (header.is_valid(&JHead::can)) {

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

      return JCylinder3D();
    }
  }

JLorentzBoost JAANET::getBoostToCOM

(

const Evt &

event

)

Get Lorentz boost to the Center of Mass (COM) frame for a given neutrino interaction.

Parameters

event

event

Definition at line 248 of file JLorentzBoost.hh.

  {
    using namespace JPP;
    
    if (has_neutrino(event)) {

      const Trk& nu = get_neutrino(event);

      const Vec beta = -nu.E / getE0(event) * nu.dir;

      return Boost(beta.x, beta.y, beta.z);
      
    } else {
      THROW(JValueOutOfRange, "getBoostToCOM(): Given event does not correspond to a neutrino interaction.");
    }
  }

void JAANET::boostToCOM

(

Evt &

event

)

Boost event to the Center of Mass (COM) frame.

Parameters

event

event

Definition at line 271 of file JLorentzBoost.hh.

  {
    const JLorentzBoost boost = getBoostToCOM(event);
    boost(event);
  }

JEvtWeightFactorFunction<JPowerLawFlux, JFlux> JAANET::make_powerLawFluxFunction ( const double  normalisation, const double  spectralIndex  )

inline

Auxiliary method for creating an interface to a power-law flux function.

Parameters

normalisation	normalisation [GeV * m^-2 * sr^-1 * s^-1]
spectralIndex	spectral index

Definition at line 128 of file JPowerLawFlux.hh.

                                                                                                              {

    const JPowerLawFlux flux(normalisation, spectralIndex);
    
    return make_fluxFunction(flux);
  }

bool JAANET::select	(	const Trk &	trk,
		const Evt &	evt
	)

Event selection.

Parameters

trk	track
evt	event

Returns

true if selected; else false

Definition at line 16 of file JAAnet/event_selector.cc.

  {
    using namespace std;
    using namespace JPP;
    /*
    if (has_muon(evt)) {

      Trk muon;

      for (const auto& t1 : evt.mc_trks) {
        if (is_muon(t1)) {
          if (t1.E > muon.E) {
            muon = t1;
          }
        }
      }

      return (is_muon(muon) && getAngle(getDirection(trk), getDirection(muon)) > 5.0);
    }
    */
    return true;
  }

bool JAANET::hasW ( const Trk &  trk, const int  i  )

inline

Check availability of value.

Parameters

trk	track
i	index

Returns

true if available; else false

Definition at line 102 of file JAAnet/JEvD.cc.

  {
    return (i >= 0 && i < (int) trk.fitinf.size());
  }

double JAANET::getW ( const Trk &  trk, const int  i  )

inline

Get associated value.

Parameters

trk	track
i	index

Returns

value

Definition at line 115 of file JAAnet/JEvD.cc.

  {
    return trk.fitinf.at(i);
  }

double JAANET::getW ( const Trk &  trk, const int  i, const double  value  )

inline

Get associated value.

Parameters

trk	track
i	index
value	default value

Returns

value

Definition at line 129 of file JAAnet/JEvD.cc.

  {
    if (hasW(trk,i))
      return trk.fitinf.at(i);
    else
      return value;
  }

void JAANET::setW	(	Trk &	trk,
		const int	i,
		const double	value
	)

Set associated value.

Parameters

trk	track
i	index
value	value

Definition at line 145 of file JAAnet/JEvD.cc.

  {
    if (i >= (int) trk.fitinf.size()) {
      trk.fitinf.resize(i + 1, 0.0);
    }

    trk.fitinf[i] = value;
  }

Variable Documentation

const int JAANET::AASHOWER_RECONSTRUCTION_TYPE = 101

static

AAnet shower fit reconstruction type.

Definition at line 70 of file JAAnetToolkit.hh.

const JEvtEvaluator JAANET::getEvtValue

static

Function object for evaluation of DAQ objects.

Definition at line 54 of file JEvtEvaluator.hh.

JEvtWeighter JAANET::getEventWeighter

Function object for mapping header to event weighter.

Definition at line 12 of file JEvtWeightToolkit.cc.

const char JAANET::AANET_TAG_SEPARATOR = '_'

static

Separator for tag extension of multiple tags in Head ("_<counter>").

Definition at line 65 of file JHead.hh.

JHeadHelper JAANET::get_is_head

static

Function object to get check method for given application.

Definition at line 250 of file JHeadToolkit.hh.