gTrueInfoData.h File Reference

Container for simulation-level observables associated with a single hit. More...

#include <atomic>
#include <map>
#include <ostream>
#include <string>
#include <vector>
#include "gbase.h"
#include "ghit.h"

Include dependency graph for gTrueInfoData.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
class	GTrueInfoData
	Stores simulation-level observables for one hit. More...

Namespaces
namespace	gtrue_data

Functions
GOptions	gtrue_data::defineOptions ()
	Defines the options subtree used by the true-data logger domain.

Variables
constexpr const char *	GTRUEDATA_LOGGER = "true_data"
	Logger domain name used by GTrueInfoData.

Detailed Description

GTrueInfoData stores the true quantities produced at the simulation stage, before any detector electronics or digitization transform them into readout-like values.

Typical examples include:

• deposited energy
• average position and time over the contributing steps
• categorical metadata such as process or volume names

The container is intentionally schema-flexible. Instead of hard-coding a fixed bank layout, observables are stored in keyed maps so that detectors and plugins can evolve their content without requiring ABI changes in this module.

Stored categories:

• doubleObservablesMap : numeric truth quantities
• stringVariablesMap : string-based categorical or provenance metadata

Usage modes:

• Event mode : create one object per hit and fill with includeVariable()
• Run/integrated mode : use one object as an accumulator and update it with accumulateVariable()

Identity model:

• each object stores a copy of the hit identity vector extracted from GHit
• the identity is preserved independently of the originating hit lifetime
• a readable representation is available through getIdentityString()

Threading:

• regular instances do not share mutable state
• the example/test factory create() uses a static atomic counter

Definition in file gTrueInfoData.h.

Variable Documentation

GTRUEDATA_LOGGER

constexpr const char* GTRUEDATA_LOGGER = "true_data"

constexpr

Definition at line 52 of file gTrueInfoData.h.