ghitConventions.h

Go to the documentation of this file.

#pragma once
 
// c++
#include <bitset>
 
// number of bits that defines a ghit.
constexpr size_t NHITBITS = 6;
 
using HitBitSet = std::bitset<NHITBITS>;
 
// -----------------------------------------------------------------------------
// HitBitSet conventions
// -----------------------------------------------------------------------------
//
// Setting a bit enables recording of the corresponding optional information.
// The current implementation fills only a subset of these planned fields.
//
// Bit 0 (mask 000001):
//   - Per-step particle IDs (PDG encoding)
//   - Per-step total energies (Es)
//   - Per-step creator process names (when available)
//
// Bit 1 (mask 000010) [planned]:
//   - Step length
//   - Track information (momentum, total energy, vertex, pid, track id)
//
// Bit 2 (mask 000100) [planned]:
//   - Mother particle track information
//
// Bit 3 (mask 001000) [planned]:
//   - Meta information (e.g. magnetic field sampling, process IDs)
//   - Process ID/name that created the particle
//
// Bit 4 (mask 010000) [planned]:
//   - Optical-photon-specific information (wavelength, momentum, vertex, track id)
//
// Bit 5 (mask 100000) [reserved]:
//   - Reserved for future use; keep stable for backward compatibility.
//