Public Member Functions | Private Attributes | List of all members
cvn::GCNGraphMaker Class Reference
Inheritance diagram for cvn::GCNGraphMaker:
art::EDProducer art::detail::Producer art::detail::LegacyModule art::Modifier art::ModuleBase art::ProductRegistryHelper

Public Member Functions

 GCNGraphMaker (fhicl::ParameterSet const &pset)
 
 ~GCNGraphMaker ()
 
void produce (art::Event &evt)
 
void beginJob ()
 
void endJob ()
 
- Public Member Functions inherited from art::EDProducer
 EDProducer (fhicl::ParameterSet const &pset)
 
template<typename Config >
 EDProducer (Table< Config > const &config)
 
std::string workerType () const
 
- Public Member Functions inherited from art::detail::Producer
virtual ~Producer () noexcept
 
 Producer (fhicl::ParameterSet const &)
 
 Producer (Producer const &)=delete
 
 Producer (Producer &&)=delete
 
Producer & operator= (Producer const &)=delete
 
Producer & operator= (Producer &&)=delete
 
void doBeginJob (SharedResources const &resources)
 
void doEndJob ()
 
void doRespondToOpenInputFile (FileBlock const &fb)
 
void doRespondToCloseInputFile (FileBlock const &fb)
 
void doRespondToOpenOutputFiles (FileBlock const &fb)
 
void doRespondToCloseOutputFiles (FileBlock const &fb)
 
bool doBeginRun (RunPrincipal &rp, ModuleContext const &mc)
 
bool doEndRun (RunPrincipal &rp, ModuleContext const &mc)
 
bool doBeginSubRun (SubRunPrincipal &srp, ModuleContext const &mc)
 
bool doEndSubRun (SubRunPrincipal &srp, ModuleContext const &mc)
 
bool doEvent (EventPrincipal &ep, ModuleContext const &mc, std::atomic< std::size_t > &counts_run, std::atomic< std::size_t > &counts_passed, std::atomic< std::size_t > &counts_failed)
 
- Public Member Functions inherited from art::Modifier
 ~Modifier () noexcept
 
 Modifier ()
 
 Modifier (Modifier const &)=delete
 
 Modifier (Modifier &&)=delete
 
Modifier & operator= (Modifier const &)=delete
 
Modifier & operator= (Modifier &&)=delete
 
- Public Member Functions inherited from art::ModuleBase
virtual ~ModuleBase () noexcept
 
 ModuleBase ()
 
ModuleDescription const & moduleDescription () const
 
void setModuleDescription (ModuleDescription const &)
 
std::array< std::vector< ProductInfo >, NumBranchTypes > const & getConsumables () const
 
void sortConsumables (std::string const &current_process_name)
 
template<typename T , BranchType BT>
ViewToken< T > consumesView (InputTag const &tag)
 
template<typename T , BranchType BT>
ViewToken< T > mayConsumeView (InputTag const &tag)
 

Private Attributes

std::string fSpacePointModuleLabel
 Module label for input space points. More...
 
std::string fSpacePointInstanceLabel
 
unsigned short fMinClusterHits
 Minimum number of space points to produce a graph. More...
 
bool fUseNeighbourRadius
 Number of neighbours as a graph feature - enable & define radius. More...
 
float fNeighbourRadius
 
bool fInclude2DFeatures
 2D node features More...
 
bool fCollectionPlaneOnly
 Do we want collection plane hits only? More...
 
bool fSaveTrueParticle
 Include true GEANT ID of primary associated particle as graph feature. More...
 
bool fUseNodeDeghostingGroundTruth
 Include ground truth for node - and if so, define proximity. More...
 
float fTruthRadius
 
bool fUseNodeDirectionGroundTruth
 
bool fSaveParticleFlow
 Whether to save particle hierarchy for particle flow ground truth. More...
 

Additional Inherited Members

- Public Types inherited from art::EDProducer
using ModuleType = EDProducer
 
using WorkerType = WorkerT< EDProducer >
 
- Public Types inherited from art::detail::Producer
template<typename UserConfig , typename KeysToIgnore = void>
using Table = Modifier::Table< UserConfig, KeysToIgnore >
 
- Public Types inherited from art::Modifier
template<typename UserConfig , typename UserKeysToIgnore = void>
using Table = ProducerTable< UserConfig, detail::ModuleConfig, UserKeysToIgnore >
 
- Static Public Member Functions inherited from art::EDProducer
static void commitEvent (EventPrincipal &ep, Event &e)
 
- Protected Member Functions inherited from art::ModuleBase
ConsumesCollector & consumesCollector ()
 
template<typename T , BranchType = InEvent>
ProductToken< T > consumes (InputTag const &)
 
template<typename Element , BranchType = InEvent>
ViewToken< Element > consumesView (InputTag const &)
 
template<typename T , BranchType = InEvent>
void consumesMany ()
 
template<typename T , BranchType = InEvent>
ProductToken< T > mayConsume (InputTag const &)
 
template<typename Element , BranchType = InEvent>
ViewToken< Element > mayConsumeView (InputTag const &)
 
template<typename T , BranchType = InEvent>
void mayConsumeMany ()
 

Detailed Description

Definition at line 33 of file GCNGraphMaker_module.cc.

Constructor & Destructor Documentation

cvn::GCNGraphMaker::GCNGraphMaker ( fhicl::ParameterSet const &  pset)
explicit

Definition at line 74 of file GCNGraphMaker_module.cc.

74  : art::EDProducer(pset),
75  fSpacePointModuleLabel (pset.get<std::string> ("SpacePointModuleLabel")),
76  fSpacePointInstanceLabel (pset.get<std::string> ("SpacePointInstanceLabel", "")),
77  fMinClusterHits (pset.get<unsigned short> ("MinClusterHits")),
78  fUseNeighbourRadius(pset.get<bool>("UseNeighbourRadius")),
79  fNeighbourRadius (pset.get<float>("NeighbourRadius")),
80  fInclude2DFeatures (pset.get<bool>("Include2DFeatures")),
81  fCollectionPlaneOnly(pset.get<bool>("CollectionPlaneOnly")),
82  fSaveTrueParticle(pset.get<bool>("SaveTrueParticle")),
83  fUseNodeDeghostingGroundTruth(pset.get<bool>("UseNodeDeghostingGroundTruth")),
84  fTruthRadius(pset.get<float>("TruthRadius")),
85  fUseNodeDirectionGroundTruth(pset.get<bool>("UseNodeDirectionGroundTruth")),
86  fSaveParticleFlow(pset.get<bool>("SaveParticleFlow"))
87 
88  {
89  produces< std::vector<cvn::GCNGraph> >();
90  if (fSaveParticleFlow) produces< std::vector<cvn::GCNParticleFlow> >();
91  }
string
std::string string
Definition: nybbler.cc:12
cvn::GCNGraphMaker::fSpacePointModuleLabel
std::string fSpacePointModuleLabel
Module label for input space points.
Definition: GCNGraphMaker_module.cc:44
cvn::GCNGraphMaker::fSpacePointInstanceLabel
std::string fSpacePointInstanceLabel
Definition: GCNGraphMaker_module.cc:45
cvn::GCNGraphMaker::fUseNeighbourRadius
bool fUseNeighbourRadius
Number of neighbours as a graph feature - enable & define radius.
Definition: GCNGraphMaker_module.cc:51
cvn::GCNGraphMaker::fMinClusterHits
unsigned short fMinClusterHits
Minimum number of space points to produce a graph.
Definition: GCNGraphMaker_module.cc:48
cvn::GCNGraphMaker::fUseNodeDeghostingGroundTruth
bool fUseNodeDeghostingGroundTruth
Include ground truth for node - and if so, define proximity.
Definition: GCNGraphMaker_module.cc:64
cvn::GCNGraphMaker::fInclude2DFeatures
bool fInclude2DFeatures
2D node features
Definition: GCNGraphMaker_module.cc:55
cvn::GCNGraphMaker::fCollectionPlaneOnly
bool fCollectionPlaneOnly
Do we want collection plane hits only?
Definition: GCNGraphMaker_module.cc:58
cvn::GCNGraphMaker::fSaveTrueParticle
bool fSaveTrueParticle
Include true GEANT ID of primary associated particle as graph feature.
Definition: GCNGraphMaker_module.cc:61
cvn::GCNGraphMaker::fSaveParticleFlow
bool fSaveParticleFlow
Whether to save particle hierarchy for particle flow ground truth.
Definition: GCNGraphMaker_module.cc:69
cvn::GCNGraphMaker::~GCNGraphMaker ( )

Definition at line 94 of file GCNGraphMaker_module.cc.

95  {
96  //======================================================================
97  // Clean up any memory allocated by your module
98  //======================================================================
99  }

Member Function Documentation

void cvn::GCNGraphMaker::beginJob ( )
virtual

Reimplemented from art::EDProducer.

Definition at line 102 of file GCNGraphMaker_module.cc.

103  {}
void cvn::GCNGraphMaker::endJob ( )
virtual

Reimplemented from art::EDProducer.

Definition at line 106 of file GCNGraphMaker_module.cc.

107  {}
void cvn::GCNGraphMaker::produce ( art::Event &  evt)
virtual

Implements art::EDProducer.

Definition at line 110 of file GCNGraphMaker_module.cc.

111  {
112  std::vector<art::Ptr<recob::SpacePoint>> spacePoints;
113  art::InputTag itag1(fSpacePointModuleLabel,fSpacePointInstanceLabel);
114  auto spacePointHandle = evt.getHandle<std::vector<recob::SpacePoint>>(itag1);
115  if (!spacePointHandle) {
116 
117  throw art::Exception(art::errors::LogicError)
118  << "Could not find spacepoints with module label "
119  << fSpacePointModuleLabel << " and instance label "
120  << fSpacePointInstanceLabel << "!";
121  }
122  art::fill_ptr_vector(spacePoints, spacePointHandle);
123  art::FindManyP<recob::Hit> fmp(spacePointHandle, evt, fSpacePointModuleLabel);
124  std::vector<std::vector<art::Ptr<recob::Hit>>> sp2Hit(spacePoints.size());
125  for (size_t spIdx = 0; spIdx < sp2Hit.size(); ++spIdx) {
126  sp2Hit[spIdx] = fmp.at(spIdx);
127  } // for spacepoint
128 
129  // Create the Graph vector and fill it if we have enough hits
130  std::unique_ptr<std::vector<cvn::GCNGraph>> graphs(new std::vector<cvn::GCNGraph>);
131  std::unique_ptr<std::vector<cvn::GCNParticleFlow>> gpf(nullptr);
132  if (fSaveParticleFlow) {
133  gpf = std::make_unique<std::vector<cvn::GCNParticleFlow> >();
134  }
135 
136  auto const clockData = art::ServiceHandle<detinfo::DetectorClocksService const>()->DataFor(evt);
137  if(spacePoints.size() >= fMinClusterHits) {
138 
139  cvn::GCNGraph newGraph;
140 
141  // Get the utility to help us calculate features
142  cvn::GCNFeatureUtils graphUtil;
143 
144  // We can calculate the number of neighbours for each space point with some radius
145  // Store the number of neighbours for each spacepoint ID
146  // const std::map<int, unsigned int> neighbourMap = graphUtil.GetAllNeighbours(evt, fNeighbourRadius, fSpacePointModuleLabel);
147 
148  // Get the charge and true ID for each spacepoint
149  auto chargeMap = graphUtil.GetSpacePointChargeMap(spacePoints, sp2Hit);
150  std::unique_ptr<std::map<unsigned int, int> const> trueIDMap{nullptr};
151  if (fSaveTrueParticle) {
152  trueIDMap = std::make_unique<std::map<unsigned int, int>>(graphUtil.GetTrueG4ID(clockData, spacePoints, sp2Hit));
153  }
154 
155  // Get 2D hit features if requested
156  std::map<unsigned int, std::vector<float>> hitMap;
157  if (fInclude2DFeatures) {
158  hitMap = graphUtil.Get2DFeatures(spacePoints, sp2Hit);
159  }
160 
161  // Get ground truth if requested
162  if (fUseNodeDirectionGroundTruth && !fUseNodeDeghostingGroundTruth) {
163  throw art::Exception(art::errors::LogicError)
164  << "You must enable deghosting ground truth if using direction ground truth!";
165  }
166  std::vector<float> nodeDeghostingGroundTruth;
167  std::vector<std::vector<float>>* nodeDirectionGroundTruth = nullptr;
168  if (fUseNodeDirectionGroundTruth) nodeDirectionGroundTruth = new std::vector<std::vector<float>>();
169  if (fUseNodeDeghostingGroundTruth) {
170  nodeDeghostingGroundTruth = graphUtil.GetNodeGroundTruth(clockData, spacePoints,
171  sp2Hit, fTruthRadius, nodeDirectionGroundTruth);
172  }
173 
174  std::set<unsigned int> trueParticles;
175  for (size_t spIdx = 0; spIdx < spacePoints.size(); ++spIdx) {
176  const art::Ptr<recob::SpacePoint> sp = spacePoints[spIdx];
177  // Do we only want collection plane spacepoints?
178 
179  if (fCollectionPlaneOnly) {
180  // Are there any associated hits from the collection plane?
181  bool collectionHit = false;
182  for (art::Ptr<recob::Hit> hit : sp2Hit[spIdx]) {
183  if (hit->View() == 2) {
184  collectionHit = true;
185  break;
186  }
187  }
188  // If not, skip this spacepoint
189  if (!collectionHit) continue;
190  }
191 
192  // Get the position
193  std::vector<float> position;
194  // Why does this use an array... we want a vector in any case
195  const double *pos = sp->XYZ();
196  for (size_t p = 0; p < 3; ++p) position.push_back(pos[p]);
197 
198  // Calculate some features
199  std::vector<float> features, truth;
200  // The neighbour map gives us our first feature
201  // features.push_back(neighbourMap.at(sp->ID()));
202  // Now charge and true ID
203  features.push_back(chargeMap.at(sp->ID()));
204 
205  if (fInclude2DFeatures) {
206  features.insert(features.end(), hitMap.at(sp->ID()).begin(), hitMap.at(sp->ID()).end());
207  }
208 
209  // Now ground truth info
210  if (fSaveTrueParticle) {
211  truth.push_back(trueIDMap->at(sp->ID()));
212  trueParticles.insert(abs(trueIDMap->at(sp->ID())));
213  }
214 
215  // Add deghosting ground truth if requested
216  if (fUseNodeDeghostingGroundTruth) {
217  truth.push_back(nodeDeghostingGroundTruth[spIdx]);
218  // Also add direction ground truth
219  if (fUseNodeDirectionGroundTruth) {
220  truth.insert(truth.end(), nodeDirectionGroundTruth->at(spIdx).begin(),
221  nodeDirectionGroundTruth->at(spIdx).end());
222  }
223  }
224 
225  // Add a node with the requested features & ground truth
226  newGraph.AddNode(position, features, truth);
227  }
228 
229  if (fSaveParticleFlow) {
230  gpf->push_back(graphUtil.GetParticleFlowMap(trueParticles));
231  }
232 
233  mf::LogInfo("GCNGraphMaker") << "Produced GCNGraph object with "
234  << newGraph.GetNumberOfNodes() << " nodes from " << spacePoints.size() << " spacepoints.";
235 
236  // Add out graph to the vector
237  graphs->push_back(newGraph);
238  }
239 
240  // Write our graph to the event
241  evt.put(std::move(graphs));
242  if (fSaveParticleFlow) evt.put(std::move(gpf));
243  }
ValidateOpDetReco.end
end
while True: pbar.update(maxval-len(onlies[E][S])) #print iS, "/", len(onlies[E][S]) found = False for...
Definition: ValidateOpDetReco.py:548
art::DataViewImpl::getHandle
Handle< PROD > getHandle(SelectorBase const &) const
Definition: DataViewImpl.h:382
mf::LogInfo
MaybeLogger_< ELseverityLevel::ELsev_info, false > LogInfo
Definition: MessageLogger.h:209
cvn::GCNGraph
GCNGraph, basic input for the GCN.
Definition: GCNGraph.h:18
cvn::GCNFeatureUtils::Get2DFeatures
std::map< unsigned int, std::vector< float > > Get2DFeatures(std::vector< art::Ptr< recob::SpacePoint >> const &spacePoints, std::vector< std::vector< art::Ptr< recob::Hit >>> const &sp2Hit) const
Get 2D hit features for a given spacepoint.
Definition: GCNFeatureUtils.cxx:508
cvn::GCNFeatureUtils::GetSpacePointChargeMap
std::map< unsigned int, float > GetSpacePointChargeMap(std::vector< art::Ptr< recob::SpacePoint >> const &spacePoints, std::vector< std::vector< art::Ptr< recob::Hit >>> const &sp2Hit) const
Use the association between space points and hits to return a charge.
Definition: GCNFeatureUtils.cxx:319
cvn::GCNGraph::AddNode
void AddNode(std::vector< float > position, std::vector< float > features)
Add a new node.
Definition: GCNGraph.cxx:37
cvn::GCNGraphMaker::fSpacePointModuleLabel
std::string fSpacePointModuleLabel
Module label for input space points.
Definition: GCNGraphMaker_module.cc:44
cvn::GCNFeatureUtils::GetNodeGroundTruth
std::vector< float > GetNodeGroundTruth(detinfo::DetectorClocksData const &clockData, std::vector< art::Ptr< recob::SpacePoint >> const &spacePoints, std::vector< std::vector< art::Ptr< recob::Hit >>> const &spToHit, float distCut, std::vector< std::vector< float >> *dirTruth=nullptr) const
Get ground truth for spacepoint deghosting graph network.
Definition: GCNFeatureUtils.cxx:639
cvn::GCNGraphMaker::fSpacePointInstanceLabel
std::string fSpacePointInstanceLabel
Definition: GCNGraphMaker_module.cc:45
features
const char features[]
Definition: feature_tests.c:2
abs
T abs(T value)
Definition: sparse_vector_test.cc:30
cvn::GCNFeatureUtils::GetParticleFlowMap
std::map< unsigned int, unsigned int > GetParticleFlowMap(const std::set< unsigned int > &particles) const
Get hierarchy map from set of particles.
Definition: GCNFeatureUtils.cxx:779
wirecell.gen.depos.move
def move(depos, offset)
Definition: depos.py:107
test.p
p
Definition: test.py:223
art::DataViewImpl::put
ProductID put(std::unique_ptr< PROD > &&edp, std::string const &instance={})
Definition: DataViewImpl.h:686
cvn::GCNGraphMaker::fMinClusterHits
unsigned short fMinClusterHits
Minimum number of space points to produce a graph.
Definition: GCNGraphMaker_module.cc:48
hit
Detector simulation of raw signals on wires.
Definition: NumberOfHitsFilter_module.cc:25
cvn::GCNGraphMaker::fUseNodeDeghostingGroundTruth
bool fUseNodeDeghostingGroundTruth
Include ground truth for node - and if so, define proximity.
Definition: GCNGraphMaker_module.cc:64
art::Exception
cet::coded_exception< errors::ErrorCodes, ExceptionDetail::translate > Exception
Definition: Exception.h:66
cvn::GCNGraphMaker::fInclude2DFeatures
bool fInclude2DFeatures
2D node features
Definition: GCNGraphMaker_module.cc:55
recob::SpacePoint::XYZ
const Double32_t * XYZ() const
Definition: SpacePoint.h:76
cvn::GCNGraphMaker::fCollectionPlaneOnly
bool fCollectionPlaneOnly
Do we want collection plane hits only?
Definition: GCNGraphMaker_module.cc:58
util::begin
decltype(auto) constexpr begin(T &&obj)
ADL-aware version of std::begin.
Definition: StdUtils.h:72
recob::SpacePoint::ID
ID_t ID() const
Definition: SpacePoint.h:75
cvn::GCNGraph::GetNumberOfNodes
const unsigned int GetNumberOfNodes() const
Get the number of nodes.
Definition: GCNGraph.cxx:54
art::fill_ptr_vector
void fill_ptr_vector(std::vector< Ptr< T >> &ptrs, H const &h)
Definition: Ptr.h:297
cvn::GCNGraphMaker::fSaveTrueParticle
bool fSaveTrueParticle
Include true GEANT ID of primary associated particle as graph feature.
Definition: GCNGraphMaker_module.cc:61
cvn::GCNGraphMaker::fSaveParticleFlow
bool fSaveParticleFlow
Whether to save particle hierarchy for particle flow ground truth.
Definition: GCNGraphMaker_module.cc:69
cvn::GCNFeatureUtils::GetTrueG4ID
std::map< unsigned int, int > GetTrueG4ID(detinfo::DetectorClocksData const &clockData, std::vector< art::Ptr< recob::SpacePoint >> const &spacePoints, std::vector< std::vector< art::Ptr< recob::Hit >>> const &sp2Hit) const
Get the true G4 ID for each spacepoint using energy matching.
Definition: GCNFeatureUtils.cxx:382
cvn::GCNFeatureUtils
Class containing some utility functions for all things CVN.
Definition: GCNFeatureUtils.h:36

Member Data Documentation

bool cvn::GCNGraphMaker::fCollectionPlaneOnly
private

Do we want collection plane hits only?

Definition at line 58 of file GCNGraphMaker_module.cc.

bool cvn::GCNGraphMaker::fInclude2DFeatures
private

2D node features

Definition at line 55 of file GCNGraphMaker_module.cc.

unsigned short cvn::GCNGraphMaker::fMinClusterHits
private

Minimum number of space points to produce a graph.

Definition at line 48 of file GCNGraphMaker_module.cc.

float cvn::GCNGraphMaker::fNeighbourRadius
private

Definition at line 52 of file GCNGraphMaker_module.cc.

bool cvn::GCNGraphMaker::fSaveParticleFlow
private

Whether to save particle hierarchy for particle flow ground truth.

Definition at line 69 of file GCNGraphMaker_module.cc.

bool cvn::GCNGraphMaker::fSaveTrueParticle
private

Include true GEANT ID of primary associated particle as graph feature.

Definition at line 61 of file GCNGraphMaker_module.cc.

std::string cvn::GCNGraphMaker::fSpacePointInstanceLabel
private

Definition at line 45 of file GCNGraphMaker_module.cc.

std::string cvn::GCNGraphMaker::fSpacePointModuleLabel
private

Module label for input space points.

Definition at line 44 of file GCNGraphMaker_module.cc.

float cvn::GCNGraphMaker::fTruthRadius
private

Definition at line 65 of file GCNGraphMaker_module.cc.

bool cvn::GCNGraphMaker::fUseNeighbourRadius
private

Number of neighbours as a graph feature - enable & define radius.

Definition at line 51 of file GCNGraphMaker_module.cc.

bool cvn::GCNGraphMaker::fUseNodeDeghostingGroundTruth
private

Include ground truth for node - and if so, define proximity.

Definition at line 64 of file GCNGraphMaker_module.cc.

bool cvn::GCNGraphMaker::fUseNodeDirectionGroundTruth
private

Definition at line 66 of file GCNGraphMaker_module.cc.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.11