added also_reject_true_info to make sure true and digitized data are both rejected if so requested

Author: maureeungaro

.github/workflows/trigger_c12s_tests.yml

@@ -1,4 +1,4 @@
-name: Trigger clas12-systems tests
+name: Triggers clas12-systems test
 
 # Fires a workflow_dispatch on gemc/clas12-systems' Test workflow whenever the
 # gemc/src Deploy workflow succeeds on a push to main, i.e. after fresh

gemc/actions/event/gEventAction.cc

@@ -9,6 +9,10 @@
 #include "event/gEventDataCollection.h"
 #include "../generator/gPrimaryGeneratorAction.h"
 
+// c++
+#include <algorithm>
+#include <cctype>
+
 namespace {
 GGeneratedParticleBank make_generated_particle_bank(const GParticleRecordEvent& particles) {
 	GGeneratedParticleBank bank;
@@ -31,6 +35,13 @@ GGeneratedParticleBank make_generated_particle_bank(const GParticleRecordEvent&
 
 	return bank;
 }
+
+bool scalar_bool_option_enabled(const std::shared_ptr<GOptions>& goptions, const std::string& name) {
+	std::string value = goptions->getScalarString(name);
+	std::transform(value.begin(), value.end(), value.begin(),
+	               [](unsigned char c) { return static_cast<char>(std::tolower(c)); });
+	return value == "true" || value == "1" || value == "yes" || value == "on";
+}
 }
 
 
@@ -92,6 +103,7 @@ void GEventAction::EndOfEventAction([[maybe_unused]] const G4Event* event) {
 
 	bool has_event_mode_payload = false;
 	bool has_run_mode_payload   = false;
+	const bool also_reject_true_info = scalar_bool_option_enabled(goptions, "also_reject_true_info");
 
 	// Loop over every hit collection produced during this event and dispatch each
 	// collection to the digitization routine registered under its collection name.
@@ -126,6 +138,7 @@ void GEventAction::EndOfEventAction([[maybe_unused]] const G4Event* event) {
 		}
 
 		const auto collection_mode = digitization_routine->collection_mode();
+		size_t accepted_hit_index = 0;
 
 		// Process all hits in the collection. Event-mode digitizers append to the
 		// event container, while run-mode digitizers append to the run container.
@@ -136,18 +149,24 @@ void GEventAction::EndOfEventAction([[maybe_unused]] const G4Event* event) {
 				continue;
 			}
 
-			auto true_data = digitization_routine->collectTrueInformation(this_hit, hitIndex);
 			auto digi_data = digitization_routine->digitizeHit(this_hit, hitIndex);
+			const bool hit_accepted = digi_data != nullptr;
 
 			if (collection_mode == CollectionMode::event) {
-				if (digi_data != nullptr) {
+				if (hit_accepted) {
+					++accepted_hit_index;
+					digi_data->includeVariable("hitn", static_cast<int>(accepted_hit_index));
 					eventDataCollection->addDetectorDigitizedData(hcSDName, std::move(digi_data));
 				}
-				eventDataCollection->addDetectorTrueInfoData(hcSDName, std::move(true_data));
-				has_event_mode_payload = true;
+				if (hit_accepted || !also_reject_true_info) {
+					const size_t output_hit_index = hit_accepted ? accepted_hit_index : hitIndex + 1;
+					auto true_data = digitization_routine->collectTrueInformation(this_hit, output_hit_index);
+					eventDataCollection->addDetectorTrueInfoData(hcSDName, std::move(true_data));
+					has_event_mode_payload = true;
+				}
 			}
 			else if (collection_mode == CollectionMode::run) {
-				if (digi_data != nullptr) {
+				if (hit_accepted) {
 					run_action->collect_event_data_collections(
 						hcSDName,
 						std::move(digi_data));

gemc/actions/generator/gPrimaryGeneratorAction.cc

@@ -12,23 +12,6 @@ thread_local GParticleRecordEvent GPrimaryGeneratorAction::current_generated_par
 thread_local GParticleRecordEvent GPrimaryGeneratorAction::current_generated_tracked_particle_records;
 
 namespace {
-GParticleRecord make_particle_record(const GparticlePtr& particle) {
-	if (particle == nullptr) { return {}; }
-	const auto& vertex = particle->getVertex();
-	return {
-		particle->getName(),
-		particle->getPid(),
-		particle->getGeneratorType(),
-		particle->getMultiplicity(),
-		particle->getMomentum(),
-		particle->getTheta(),
-		particle->getPhi(),
-		vertex.x(),
-		vertex.y(),
-		vertex.z()
-	};
-}
-
 GParticleRecord make_particle_record(const GparticleRuntimeRecord& particle) {
 	return {
 		particle.name,
@@ -50,6 +33,14 @@ void append_runtime_records(GParticleRecordEvent& records, const GparticlePtr& p
 		records.emplace_back(make_particle_record(runtime_record));
 	}
 }
+
+void append_untracked_file_records(GParticleRecordEvent& records, const GParticleRecordEvent& source_records) {
+	for (const auto& record : source_records) {
+		if (record.type != 1) {
+			records.emplace_back(record);
+		}
+	}
+}
 }
 
 // Build the primary-generator action, load the configured particle definitions,
@@ -94,18 +85,14 @@ void GPrimaryGeneratorAction::GeneratePrimaries(G4Event* anEvent) {
 	current_generated_tracked_particle_records.clear();
 
 	current_generated_particles.insert(current_generated_particles.end(), gparticles->begin(), gparticles->end());
-	current_generated_tracked_particles.insert(current_generated_tracked_particles.end(), gparticles->begin(), gparticles->end());
-	current_generated_particle_records.reserve(gparticles->size());
-	for (const auto& gparticle : *gparticles) {
-		current_generated_particle_records.emplace_back(make_particle_record(gparticle));
-	}
+	current_generated_tracked_particles.insert(current_generated_tracked_particles.end(),
+	                                           gparticles->begin(),
+	                                           gparticles->end());
 
 	const auto event_id = anEvent->GetEventID();
 	if (event_id >= 0 && static_cast<size_t>(event_id) < allGparticleFileRecordEvents.size()) {
 		const auto& event_particles = allGparticleFileRecordEvents[static_cast<size_t>(event_id)];
-		current_generated_particle_records.insert(current_generated_particle_records.end(),
-		                                          event_particles.begin(),
-		                                          event_particles.end());
+		append_untracked_file_records(current_generated_particle_records, event_particles);
 	}
 	if (event_id >= 0 && static_cast<size_t>(event_id) < gparticleFileEvents.size()) {
 		const auto& event_particles = gparticleFileEvents[static_cast<size_t>(event_id)];
@@ -117,6 +104,7 @@ void GPrimaryGeneratorAction::GeneratePrimaries(G4Event* anEvent) {
 	for (const auto& gparticle : *gparticles) {
 		if (gparticle != nullptr) {
 			gparticle->shootParticle(gparticleGun.get(), anEvent);
+			append_runtime_records(current_generated_particle_records, gparticle);
 			append_runtime_records(current_generated_tracked_particle_records, gparticle);
 		}
 	}
@@ -129,6 +117,7 @@ void GPrimaryGeneratorAction::GeneratePrimaries(G4Event* anEvent) {
 		for (const auto& gparticle : gparticleFileEvents[static_cast<size_t>(event_id)]) {
 			if (gparticle != nullptr) {
 				gparticle->shootParticle(gparticleGun.get(), anEvent);
+				append_runtime_records(current_generated_particle_records, gparticle);
 				append_runtime_records(current_generated_tracked_particle_records, gparticle);
 			}
 		}

gemc/actions/generator/gPrimaryGeneratorAction.h

@@ -64,9 +64,10 @@ inline GOptions defineOptions() {
  * a default particle so the simulation still has a valid primary source.
  *
  * The class also exposes thread-local generated-particle snapshots for event
- * output. The \c generated snapshot includes inline particles and all parsed
- * file rows. The \c generated_tracked snapshot includes inline particles and
- * only the file rows propagated in Geant4.
+ * output. The \c generated snapshot contains runtime records for particles
+ * propagated in Geant4 plus source-only file rows that are not propagated. The
+ * \c generated_tracked snapshot contains only the runtime records propagated
+ * in Geant4.
  *
  * @ingroup gactions_module
  */
@@ -130,8 +131,9 @@ class GPrimaryGeneratorAction : public GBase<GPrimaryGeneratorAction>, public G4
 	/**
 	 * \brief Returns the current event's full generated-particle records.
 	 *
-	 * This is the source for the \c generated output bank. It includes inline
-	 * particles and every parsed file-backed particle row.
+	 * This is the source for the \c generated output bank. It includes runtime
+	 * records for propagated particles and source-only records for file-backed
+	 * rows not propagated in Geant4.
 	 *
 	 * \return Thread-local generated-particle records for the active event.
 	 */
@@ -141,7 +143,7 @@ class GPrimaryGeneratorAction : public GBase<GPrimaryGeneratorAction>, public G4
 	 * \brief Returns the current event's Geant4-tracked generated-particle records.
 	 *
 	 * This is the source for the \c generated_tracked output bank. It includes
-	 * inline particles and only file-backed particles propagated in Geant4.
+	 * only runtime records for particles propagated in Geant4.
 	 *
 	 * \return Thread-local tracked generated-particle records for the active event.
 	 */

gemc/gdata/event/gEventDataCollection.h

@@ -47,10 +47,10 @@ constexpr const char* GEVENTDATA_LOGGER = "gevent_data";
  * the gparticle module from gdata. It is used by event streamers to publish
  * generated-particle metadata alongside detector hit banks.
  *
- * The \c generated bank contains inline \c -gparticle definitions and every
- * parsed \c -gparticlefile row. The \c generated_tracked bank contains inline
- * \c -gparticle definitions and only the file rows propagated in Geant4,
- * normally rows with \c type == 1.
+ * The \c generated bank contains runtime records for particles propagated in
+ * Geant4 plus source-only file rows that are not propagated. The
+ * \c generated_tracked bank contains only runtime records for particles
+ * propagated in Geant4, normally rows with \c type == 1 for Lund input.
  */
 struct GGeneratedParticleData
 {
@@ -197,16 +197,16 @@ class GEventDataCollection : public GBase<GEventDataCollection>
 	 *
 	 * \return Const reference to the detector map.
 	 */
-	[[nodiscard]] auto getDataCollectionMap() const -> const std::map<std::string, std::unique_ptr<GDataCollection>>& {
+	[[nodiscard]] auto getDataCollectionMap() const
+	    -> const std::map<std::string, std::unique_ptr<GDataCollection>>& {
 		return gdataCollectionMap;
 	}
 
 	/**
 	 * \brief Stores the full generated-particle bank for this event.
 	 *
-	 * The bank named \c generated contains inline \c -gparticle definitions
-	 * plus all parsed \c -gparticlefile rows, including file particles that
-	 * are not propagated in Geant4.
+	 * The bank named \c generated contains runtime records for particles
+	 * propagated in Geant4 plus source-only file rows that are not propagated.
 	 *
 	 * \param particles Generated-particle rows to store.
 	 */
@@ -217,9 +217,8 @@ class GEventDataCollection : public GBase<GEventDataCollection>
 	/**
 	 * \brief Stores the Geant4-tracked generated-particle bank for this event.
 	 *
-	 * The bank named \c generated_tracked contains inline \c -gparticle
-	 * definitions plus only the file particles propagated in Geant4, normally
-	 * those with source \c type == 1.
+	 * The bank named \c generated_tracked contains only runtime records for
+	 * particles propagated in Geant4, normally those with source \c type == 1.
 	 *
 	 * \param particles Generated-particle rows to store.
 	 */
@@ -239,7 +238,9 @@ class GEventDataCollection : public GBase<GEventDataCollection>
 	 *
 	 * \return Rows published as the \c generated_tracked output bank.
 	 */
-	[[nodiscard]] const GGeneratedParticleBank& getGeneratedTrackedParticles() const { return generated_tracked_particles; }
+	[[nodiscard]] const GGeneratedParticleBank& getGeneratedTrackedParticles() const {
+		return generated_tracked_particles;
+	}
 
 	/**
 	 * \brief Returns the event number stored in the owned header.

gemc/gstreamer/gstreamer.h

@@ -616,10 +616,11 @@ namespace gstreamer {
 		for (const auto& gstreamer_def : gstreamer::getGStreamerDefinition(gopts)) {
 			auto        gstreamer_def_thread = GStreamerDefinition(gstreamer_def, thread_id);
 			std::string gstreamer_plugin     = gstreamer_def_thread.gstreamerPluginName();
-			// Key the map by the unique per-output rootname so that multiple same-format
-			// outputs (e.g. two csv files) do not collide; the plugin library is still
-			// loaded by the format-derived plugin name.
-			const std::string& output_key   = gstreamer_def_thread.rootname;
+			// Key the map by the format-derived plugin name combined with the per-output
+			// rootname so that neither multiple same-format outputs (e.g. two csv files)
+			// nor multiple same-rootname outputs of different formats (e.g. dc.csv and
+			// dc.hipo) collide; the plugin library is still loaded by the plugin name.
+			const std::string output_key    = gstreamer_plugin + ":" + gstreamer_def_thread.rootname;
 
 			// Load the plugin object for this configured output. Each call returns a
 			// fresh GStreamer instance, so same-format outputs stay independent.

gemc/gstreamer/gstreamerDoxy.h

@@ -135,11 +135,10 @@
  * \subsection gstreamer_arch_generated Generated-particle banks
  * Event output includes two generated-particle banks when generator metadata is
  * available:
- * - \c generated : inline \c -gparticle definitions plus every parsed
- *   \c -gparticlefile particle, including rows that are not propagated in Geant4.
- * - \c generated_tracked : inline \c -gparticle definitions plus only the
- *   \c -gparticlefile particles that are propagated in Geant4. For Lund input,
- *   this corresponds to rows with \c type == 1.
+ * - \c generated : runtime records for particles propagated in Geant4 plus
+ *   source-only file rows that are not propagated.
+ * - \c generated_tracked : runtime records for particles propagated in Geant4.
+ *   For Lund input, this corresponds to rows with \c type == 1.
  *
  * Both banks publish the same columns: particle name, pid, source type,
  * multiplicity, momentum, theta, phi, and vertex components. The concrete

gemc_options.cc

@@ -38,6 +38,10 @@ namespace gemc {
 
         // switches
         goptions.defineOption(GVariable("nthreads", 0, "sets number of threads."), "Default: 0 (use one thread for each available cores)");
+        goptions.defineOption(
+            GVariable("also_reject_true_info", true, "also reject true information for rejected hits"),
+            "Drops true information for hits rejected by detector digitization. Default: true.\n"
+            "Set to false to keep true information for all Geant4 hits even when no digitized hit is written.");
         // goptions.defineOption(GVariable("event_module_log", 0, "Event Modulo log"), "Logs every <value> events. Default: 0 (log all events)");
         //
         // goptions.defineOption(GVariable("eventTimeSize", "0*ns", "event duration with unit"), "Default: 0*ns");