Added flags to SmearedMCParticle

Author: PetrilloAtWork

CMakeLists.txt

@@ -20,7 +20,7 @@ set(CMAKE_MODULE_PATH $ENV{ART_DIR}/Modules
 include(CetCMakeEnv)
 cet_cmake_env()
 
-cet_set_compiler_flags(DIAGS PARANOID
+cet_set_compiler_flags(DIAGS VIGILANT
   WERROR
   NO_UNDEFINED
   EXTRA_FLAGS -pedantic

boosteddmanalysis/DataObjects/SmearedMCParticle.cxx

@@ -19,14 +19,16 @@ bdm::SmearedMCParticle::SmearedMCParticle(
   double energy,
   double time,
   Position_t startPosition,
-  Position_t endPosition
+  Position_t endPosition,
+  Flags_t flags
   )
   : fEnergy(energy)
   , fMomentum(momentum)
   , fTime(time)
   , fStartingVertex(startPosition)
   , fEndVertex(endPosition)
   , fPDGID(id)
+  , fFlags(flags)
   {}
 
 

boosteddmanalysis/DataObjects/SmearedMCParticle.h

@@ -52,6 +52,12 @@ namespace bdm {
     using Momentum_t = geo::Vector_t; ///< Type to represent momenta.
     using PDGID_t = int; ///< Type of the particle ID.
 
+    using Flags_t = unsigned int; ///< Type of flags mask.
+    
+    /// Flag: is the particle valid at all?
+    static constexpr Flags_t flValid = 1 << 0;
+    
+    
     /// 4-momentum
     using FourMomentum_t
       = ROOT::Math::LorentzVector<ROOT::Math::Cartesian3D<double>>;
@@ -71,13 +77,15 @@ namespace bdm {
       * @param time time of appearance
       * @param startPosition initial position [cm]
       * @param endPosition final position [cm]
+      * @param flags flags (see `flags()`)
       * 
       * The particle is initialized with the specified values.
       */
     SmearedMCParticle(
       PDGID_t id,
       Momentum_t momentum, double energy,
-      double time, Position_t startPosition, Position_t endPosition
+      double time, Position_t startPosition, Position_t endPosition,
+      Flags_t flags = defaultFlags()
       );
 
 
@@ -135,6 +143,32 @@ namespace bdm {
     // --- END access to data --------------------------------------------------
 
 
+    /// @{
+    
+    
+    // --- BEGIN access to flags -----------------------------------------------
+    /// @name Access to flags
+    /// @{
+    
+    /// Returns the full set of flags.
+    Flags_t flags() const { return fFlags; }
+    
+    /// Returns whether this particle is valid at all.
+    bool isValid() const { return flags() & flValid; }
+    
+    /// Returns whether this particle is not valid.
+    bool isInvalid() const { return !isValid(); }
+    
+    /// Returns the default set of flags for a reconstructed particle.
+    static constexpr Flags_t defaultFlags() { return flValid; }
+    
+    /// Returns a flag set for an invalid particle.
+    static constexpr Flags_t invalidParticleFlags() { return 0U; }
+    
+    /// @}
+    // --- END access to flags -------------------------------------------------
+    
+    
     // --- BEGIN printing data -------------------------------------------------
     /// @{
     /// @name Printing data
@@ -186,12 +220,15 @@ namespace bdm {
 
     double     fEnergy = 0.0;   ///< Reconstructed energy of the particle [GeV].
     Momentum_t fMomentum; ///< Reconstructed momentum of the particle [GeV/c].
-    double     fTime = 0.0;           ///< Reconstructed creation time [ns].
+    double     fTime = 0.0; ///< Reconstructed creation time [ns].
     Position_t fStartingVertex; ///< Reconstructed starting position [cm].
     Position_t fEndVertex;      ///< Reconstructed ending position [cm].
 
     PDGID_t fPDGID = InvalidParticleID; ///< Particle ID in PDG standard.
 
+    /// Flags associated to this particle.
+    Flags_t fFlags = invalidParticleFlags();
+    
   }; // class SmearedMCParticle
 
 
@@ -223,11 +260,22 @@ void bdm::SmearedMCParticle::dump(
   if (verbosity >= 1) {
     out << firstIndent
       << "particle: ";
+    if (isInvalid()) {
+      out << "invalid";
+      return;
+    }
     auto const* pPDGinfo = particleInfo();
     if (pPDGinfo) out << pPDGinfo->GetName() << " (ID=" << particleId() << ")";
     else          out << "ID " << particleId();
   }
-  else out << firstIndent << "ID=" << particleId(); // <== verbosity: 0
+  else {
+    out << firstIndent;
+    if (isInvalid()) {
+      out << "invalid";
+      return;
+    }
+    out << "ID=" << particleId(); // <== verbosity: 0
+  }
 
   if (verbosity >= 1) out << " starting";
   if (verbosity >= 3) out << " on " << time() << " ns";
@@ -237,7 +285,9 @@ void bdm::SmearedMCParticle::dump(
   // verbosity: 0
   out << "; E=" << energy() << " GeV, cp=" << momentum() << " GeV/c";
 
-} // lar::example::CheatTrack::dump()
+  // would print flags here, but there is none yet besides the "valid" one
+  
+} // bdm::SmearedMCParticle::dump()
 
 //------------------------------------------------------------------------------
 

boosteddmanalysis/DataObjects/classes.h

@@ -9,6 +9,10 @@
 
 #include "nusimdata/SimulationBase/MCParticle.h"
 
+#include "canvas/Persistency/Common/PtrVector.h"
 #include "canvas/Persistency/Common/Wrapper.h"
+#include "canvas/Persistency/Common/Ptr.h"
 #include "canvas/Persistency/Common/Assns.h"
 
+#include <vector>
+

boosteddmanalysis/DataObjects/classes_def.xml

@@ -11,7 +11,7 @@
 
     <!--   class -->
   <class name="bdm::SmearedMCParticle" ClassVersion="10" >
-   <version ClassVersion="10" checksum="4037081950"/>
+   <version ClassVersion="10" checksum="532383039"/>
   </class>
 
     <!-- art pointers and wrappers -->
@@ -28,6 +28,16 @@
   <class name="std::pair<art::Ptr<simb::MCParticle>, art::Ptr<bdm::SmearedMCParticle>>" />
   <class name="art::Wrapper<art::Assns<simb::MCParticle, bdm::SmearedMCParticle, void>>" />
 
+  
+  <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
+  <!-- vectors of pointers to simb::MCParticle -->
+  <class name="std::vector<art::Ptr<simb::MCParticle>>" />
+  <class name="art::Wrapper<std::vector<art::Ptr<simb::MCParticle>>>" />
+  
+  <class name="art::PtrVector<simb::MCParticle>" />
+  <class name="art::Wrapper<art::PtrVector<simb::MCParticle>>" />
+  
+  
   <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
 
 </lcgdict>

test/DataObjects/SmearedMCParticle_test.cc

@@ -25,13 +25,15 @@ void test_SmearedMCParticle_defaultConstructor() {
   using Momentum_t = bdm::SmearedMCParticle::Momentum_t;
   using Position_t = bdm::SmearedMCParticle::Position_t;
   using PDGID_t    = bdm::SmearedMCParticle::PDGID_t;
+  using Flags_t    = bdm::SmearedMCParticle::Flags_t;
 
   Momentum_t expected_momentum; // default-constructed
   double expected_energy = 0.0;
   Position_t expected_startPosition;
   Position_t expected_endPosition;
   double expected_time = 0.0;
   PDGID_t expected_id = bdm::SmearedMCParticle::InvalidParticleID;
+  Flags_t expected_flags = bdm::SmearedMCParticle::invalidParticleFlags();
   TParticlePDG const* expected_info = nullptr;
 
   bdm::SmearedMCParticle const particle;
@@ -48,6 +50,9 @@ void test_SmearedMCParticle_defaultConstructor() {
   BOOST_CHECK_EQUAL(particle.particleId(),    expected_id);
   BOOST_CHECK_EQUAL(particle.particleInfo(),  expected_info);
   BOOST_CHECK_EQUAL(particle.particleName(),  "<none>");
+  BOOST_CHECK_EQUAL(particle.flags(),         expected_flags);
+  BOOST_CHECK      (!particle.isValid());
+  BOOST_CHECK      (particle.isInvalid());
 
   std::cout << "Default-constructed particle: " << particle << std::endl;
   for (unsigned int verb = 0U; verb <= bdm::SmearedMCParticle::MaxDumpVerbosity;
@@ -68,13 +73,15 @@ void test_SmearedMCParticle_directConstructor() {
   using Momentum_t = bdm::SmearedMCParticle::Momentum_t;
   using Position_t = bdm::SmearedMCParticle::Position_t;
   using PDGID_t    = bdm::SmearedMCParticle::PDGID_t;
+  using Flags_t    = bdm::SmearedMCParticle::Flags_t;
 
   Momentum_t expected_momentum = { 3.0, 4.0, 12.0 }; // default-constructed
   double expected_energy = 13.0;
   Position_t expected_startPosition = { -1.0, -3.0, -2.0 };
   Position_t expected_endPosition = expected_startPosition + expected_momentum;
   double expected_time = 1234.0;
   PDGID_t expected_id = 11; // electron
+  Flags_t expected_flags = bdm::SmearedMCParticle::flValid;
   TParticlePDG const* expected_info
     = TDatabasePDG::Instance()->GetParticle(expected_id);
 
@@ -95,6 +102,9 @@ void test_SmearedMCParticle_directConstructor() {
   BOOST_CHECK_EQUAL(particle.particleId(),    expected_id);
   BOOST_CHECK_EQUAL(particle.particleInfo(),  expected_info);
   BOOST_CHECK_EQUAL(particle.particleName(),  "e-");
+  BOOST_CHECK_EQUAL(particle.flags(),         expected_flags);
+  BOOST_CHECK      (particle.isValid());
+  BOOST_CHECK      (!particle.isInvalid());
 
   std::cout << "Particle: " << particle << std::endl;
   for (unsigned int verb = 0U; verb <= bdm::SmearedMCParticle::MaxDumpVerbosity;