adding automatic inclusing of identity variables in gstreamers

Author: maureeungaro

gdata/examples/event_example.cc

@@ -42,9 +42,6 @@
  *   - \ref GEventDataCollection::addDetectorDigitizedData "addDetectorDigitizedData()"
  * - inspecting stored data:
  *   - per-detector hit counts
- *   - identity strings from
- *     \ref GTrueInfoData::getIdentityString "getIdentityString()" and
- *     \ref GDigitizedData::getIdentityString "getIdentityString()"
  *   - truth and digitized observable maps
  * - demonstrating filtering of streaming-readout keys for digitized data with:
  *   - \ref GDigitizedData::getIntObservablesMap "getIntObservablesMap()"
@@ -164,7 +161,9 @@ static void dump_event(const std::shared_ptr<GEventDataCollection>& edc, const s
 			const auto doubles = th->getDoubleVariablesMap();
 			const auto strings = th->getStringVariablesMap();
 
-			log->info(0, "  [truth hit ", i, "] id={", th->getIdentityString(), "}");
+			auto idString = getIdentityString(th->getIdentity());
+
+			log->info(0, "  [truth hit ", i, "] id={",idString, "}");
 			log->info(0, "    doubles: ", map_to_string(doubles));
 
 			// Strings are often empty in this toy factory, but the code shows how to inspect them.
@@ -186,7 +185,9 @@ static void dump_event(const std::shared_ptr<GEventDataCollection>& edc, const s
 			const auto dbls_non_sro  = dh->getDblObservablesMap(0);
 			const auto dbls_sro_only = dh->getDblObservablesMap(1);
 
-			log->info(0, "  [digi  hit ", i, "] id={", dh->getIdentityString(), "}");
+			auto idString = getIdentityString(dh->getIdentity());
+
+			log->info(0, "  [digi  hit ", i, "] id={",idString, "}");
 			log->info(0, "    int  non-SRO: ", map_to_string(ints_non_sro));
 			log->info(0, "    int  SRO:     ", map_to_string(ints_sro));
 			log->info(0, "    dbl  non-SRO: ", map_to_string(dbls_non_sro));

gdata/gDigitizedData.cc

@@ -127,18 +127,12 @@ double GDigitizedData::getDblObservable(const std::string& varName) {
 	return doubleObservablesMap[varName];
 }
 
-std::string GDigitizedData::getIdentityString() const {
-	// Build a compact label from the stored identifier vector.
-	std::string identifierString;
-	for (size_t i = 0; i < gidentity.size() - 1; i++) {
-		identifierString += gidentity[i].getName() + "->" + std::to_string(gidentity[i].getValue()) + ", ";
-	}
-	identifierString += gidentity.back().getName() + "->" + std::to_string(gidentity.back().getValue());
-	return identifierString;
-}
 
 std::ostream& operator<<(std::ostream& os, const GDigitizedData& data) {
-	os << "GDigitizedData{identity=\"" << data.getIdentityString() << "\"";
+
+	auto idString = getIdentityString(data.gidentity);
+
+	os << "GDigitizedData{identity=\"" << idString  << "\"";
 
 	if (!data.intObservablesMap.empty()) {
 		os << ", intObservables={";

gdata/gDigitizedData.h

@@ -23,8 +23,6 @@
  * Identity:
  * - the object copies the hit identity from the source GHit
  * - the identity is preserved independently of the originating hit lifetime
- * - a readable representation is available through
- *   \ref GDigitizedData::getIdentityString "getIdentityString()"
  *
  * Event and integration semantics:
  * - \ref GDigitizedData::includeVariable "includeVariable()" stores or overwrites per-hit values
@@ -132,19 +130,6 @@ class GDigitizedData : public GBase<GDigitizedData>
 	 */
 	GDigitizedData(const std::shared_ptr<GOptions>& gopts, const GHit* ghit);
 
-	/**
-	 * \brief Builds a readable identity string from the stored hit identifiers.
-	 *
-	 * \details
-	 * The generated format is:
-	 * \code
-	 * name1->value1, name2->value2, ...
-	 * \endcode
-	 *
-	 * \return Identity string assembled from the stored \c gidentity vector.
-	 */
-	[[nodiscard]] std::string getIdentityString() const;
-
 	/**
 	 * \brief Stores or overwrites one integer observable for this hit.
 	 *
@@ -289,6 +274,14 @@ class GDigitizedData : public GBase<GDigitizedData>
 		return arrayDoubleObservablesMap;
 	}
 
+	/**
+	 *
+	 * \brief Returns the identifier vectory
+	 *
+	 * @return gidentity
+	 */
+	[[nodiscard]] inline const std::vector<GIdentifier>& getIdentity() const { return gidentity; }
+
 	/**
 	 * \brief Creates deterministic example data for tests and examples.
 	 *

gdata/gTrueInfoData.cc

@@ -48,18 +48,11 @@ void GTrueInfoData::accumulateVariable(const std::string& vname, double value) {
 	}
 }
 
-std::string GTrueInfoData::getIdentityString() const {
-	// Build a compact label from the stored identifier vector.
-	std::string identifierString;
-	for (size_t i = 0; i < gidentity.size() - 1; i++) {
-		identifierString += gidentity[i].getName() + "->" + std::to_string(gidentity[i].getValue()) + ", ";
-	}
-	identifierString += gidentity.back().getName() + "->" + std::to_string(gidentity.back().getValue());
-	return identifierString;
-}
 
 std::ostream& operator<<(std::ostream& os, const GTrueInfoData& data) {
-	os << "GTrueInfoData{identity=\"" << data.getIdentityString() << "\"";
+	auto idString = getIdentityString(data.gidentity);
+
+	os << "GTrueInfoData{identity=\"" << idString << "\"";
 
 	if (!data.doubleObservablesMap.empty()) {
 		os << ", doubleObservables={";

gdata/gTrueInfoData.h

@@ -30,8 +30,6 @@
  * 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
- *   \ref GTrueInfoData::getIdentityString "getIdentityString()"
  *
  * Threading:
  * - regular instances do not share mutable state
@@ -122,24 +120,6 @@ class GTrueInfoData : public GBase<GTrueInfoData>
 	 */
 	GTrueInfoData(const std::shared_ptr<GOptions>& gopts, const GHit* ghit);
 
-	/**
-	 * \brief Builds a readable identity string from the stored hit identifiers.
-	 *
-	 * \details
-	 * The generated format is:
-	 * \code
-	 * name1->value1, name2->value2, ...
-	 * \endcode
-	 *
-	 * This string is intended for:
-	 * - logs
-	 * - debugging output
-	 * - human-readable summaries
-	 *
-	 * \return Identity string assembled from the stored \c gidentity vector.
-	 */
-	[[nodiscard]] std::string getIdentityString() const;
-
 	/**
 	 * \brief Stores or overwrites one numeric truth observable.
 	 *
@@ -249,6 +229,14 @@ class GTrueInfoData : public GBase<GTrueInfoData>
 		return true_info_data;
 	}
 
+	/**
+	 *
+	 * \brief Returns the identifier vectory
+	 *
+	 * @return gidentity
+	 */
+	[[nodiscard]] inline const std::vector<GIdentifier>& getIdentity() const { return gidentity; }
+
 private:
 	/**
 	 * \brief Numeric truth observables.

gdynamicDigitization/gDosimeterDigitization.cc

@@ -28,12 +28,13 @@ bool GDosimeterDigitization::defineReadoutSpecsImpl() {
 
 // See header for API docs.
 std::unique_ptr<GDigitizedData> GDosimeterDigitization::digitizeHitImpl(GHit* ghit, [[maybe_unused]] size_t hitn) {
+
+	auto gdata = std::make_unique<GDigitizedData>(gopts, ghit);
+
 	auto etot = ghit->getTotalEnergyDeposited();
 	auto mass = ghit->getMass();
 	auto dose = etot / mass;
 
-	auto gdata = std::make_unique<GDigitizedData>(gopts, ghit);
-
 	// Store the detector identity and the total deposited energy.
 	gdata->includeVariable("etot", etot / MeV);
 	gdata->includeVariable("dose", dose / gemc_units::picogray);

gdynamicDigitization/gFluxDigitization.cc

@@ -18,7 +18,6 @@ std::unique_ptr<GDigitizedData> GFluxDigitization::digitizeHitImpl(GHit* ghit, s
 
 	auto gdata = std::make_unique<GDigitizedData>(gopts, ghit);
 
-	gdata->includeVariable(identity.getName(), identity.getValue());
 	gdata->includeVariable("hitn", static_cast<int>(hitn));
 	gdata->includeVariable("totEdep", ghit->getTotalEnergyDeposited());
 	gdata->includeVariable("time", ghit->getAverageTime());

ghit/ghit.h

@@ -56,7 +56,7 @@ class GHit : public G4VHit
 	 *                a simple hard-coded scheme but keeps this field for future expansion.
 	 */
 	GHit(std::shared_ptr<GTouchable> gt, HitBitSet hbs, const G4Step* thisStep = nullptr,
-	     const std::string&          cScheme                                   = "default");
+		 const std::string&          cScheme                                   = "default");
 
 	/**
 	 * \brief Destructor.
@@ -484,3 +484,21 @@ inline void GHit::operator delete(void* hit) {
 
 	GHitAllocator->FreeSingle((GHit*)hit);
 }
+
+[[nodiscard]] inline std::string getIdentityString(std::vector<GIdentifier> gidentity) {
+	// Build a compact label from the stored identifier vector.
+	std::string identifierString;
+	for (size_t i = 0; i < gidentity.size() - 1; i++) {
+		identifierString += gidentity[i].getName() + "->" + std::to_string(gidentity[i].getValue()) + ", ";
+	}
+	identifierString += gidentity.back().getName() + "->" + std::to_string(gidentity.back().getValue());
+	return identifierString;
+}
+
+[[nodiscard]] inline std::map<std::string, int> getIdentityMap(std::vector<GIdentifier> gidentity) {
+	std::map<std::string, int> identityMap;
+	for (auto& id : gidentity) {
+		identityMap[id.getName()] = id.getValue();
+	}
+	return identityMap;
+}

gstreamer/factories/ASCII/event/publishDigitized.cc

@@ -13,7 +13,7 @@ bool GstreamerTextFactory::publishEventDigitizedDataImpl(const std::string&
 	ofile << GTAB << "Detector <" << detectorName << "> Digitized Bank {\n";
 
 	for (auto dgtzHit : digitizedData) {
-		std::string identifierString = dgtzHit->getIdentityString();
+		auto identifierString = getIdentityString(dgtzHit->getIdentity());
 
 		ofile << GTABTAB << "Hit address: " << identifierString << " {\n";
 

gstreamer/factories/ASCII/event/publishTrueInfo.cc

@@ -13,7 +13,7 @@ bool GstreamerTextFactory::publishEventTrueInfoDataImpl(const std::string&
 	ofile << GTAB << "Detector <" << detectorName << "> True Info Bank {\n";
 
 	for (auto trueInfoHit : trueInfoData) {
-		std::string identifierString = trueInfoHit->getIdentityString();
+		auto identifierString = getIdentityString(trueInfoHit->getIdentity());
 
 		ofile << GTABTAB << "Hit address: " << identifierString << " {\n";