HitAnaModule_module.cc

Go to the documentation of this file.

////////////////////////////////////////////////////////////////////////
// Class:       HitAnaModule
// Module Type: analyzer
// File:        HitAnaModule_module.cc
//
// Generated at Sun Jun 22 08:40:08 2014 by Wesley Ketchum using artmod
// from cetpkgsupport v1_05_04.
////////////////////////////////////////////////////////////////////////

/*!
 * Title:   HitAnaModule
 * Author:  wketchum@lanl.gov
 * Inputs:  recob::Wire (calibrated), recob::Hit, Assns<recob::Wire, recob::Hit>
 * Outputs: validation histograms
 *
 * Description:
 * This module is intended to be yet another hit analyzer module. Its intention is
 *   (1) to compare hit-finding modules against each other, and eventually
 *   (2) to compare those to truth
 */

#include "art/Framework/Core/EDAnalyzer.h"
#include "art/Framework/Core/ModuleMacros.h"
#include "art/Framework/Principal/Event.h"
#include "art/Framework/Principal/Handle.h"
#include "art/Framework/Services/Registry/ServiceHandle.h"
#include "canvas/Persistency/Common/Assns.h"
#include "fhiclcpp/ParameterSet.h"

#include "art_root_io/TFileService.h"

#include <string>

#include "lardata/DetectorInfoServices/DetectorClocksService.h"
#include "lardataobj/MCBase/MCHitCollection.h"
#include "lardataobj/RecoBase/Hit.h"
#include "lardataobj/RecoBase/Wire.h"
#include "larreco/HitFinder/HitAnaAlg.h"

#include "TTree.h"

namespace hit {
  class HitAnaModule;
}

class hit::HitAnaModule : public art::EDAnalyzer {
public:
  explicit HitAnaModule(fhicl::ParameterSet const& p);

private:
  void analyze(art::Event const& e) override;

  void beginJob() override;

  using HitWireAssns_t = art::Assns<recob::Hit, recob::Wire>;

  void createAssocVector(HitWireAssns_t const&, std::vector<std::vector<int>>&);

  void createAssocVector(std::vector<recob::Wire> const&,
                         std::vector<recob::Hit> const&,
                         std::vector<std::vector<int>>&);

  void createMCAssocVector(std::vector<recob::Wire> const&,
                           std::vector<sim::MCHitCollection> const&,
                           std::vector<std::vector<int>>&);

  // Declare member data here.
  std::vector<std::string> fHitModuleLabels;
  std::string fMCHitModuleLabel;
  std::string fWireModuleLabel;

  TTree* wireDataTree;
  std::vector<TTree*> hitDataTree;

  HitAnaAlg analysisAlg;
};

hit::HitAnaModule::HitAnaModule(fhicl::ParameterSet const& p) : EDAnalyzer(p) // ,
// More initializers here.
{
  fHitModuleLabels = p.get<std::vector<std::string>>("HitModuleLabels");
  fWireModuleLabel = p.get<std::string>("WireModuleLabel");
  fMCHitModuleLabel = p.get<std::string>("MCHitModuleLabel");
}

void
hit::HitAnaModule::createAssocVector(HitWireAssns_t const& HitToWire,
                                     std::vector<std::vector<int>>& WireHitAssocVector)
{
  // WireHitAssocVector: for each wire, indices of all the hits associated to it

  // the iteration to art::Assns<Hit, Wire> points to a art::Ptr pair (assn_t)
  // with a hit as first element ("left") and a wire as the second one ("right")
  for (HitWireAssns_t::assn_t const& assn : HitToWire)
    WireHitAssocVector.at(assn.second.key()).push_back(assn.first.key());
}

void
hit::HitAnaModule::createAssocVector(std::vector<recob::Wire> const& wireVector,
                                     std::vector<recob::Hit> const& hitVector,
                                     std::vector<std::vector<int>>& WireHitAssocVector)
{
  WireHitAssocVector.resize(wireVector.size());
  for (size_t iwire = 0; iwire < wireVector.size(); iwire++) {
    for (size_t ihit = 0; ihit < hitVector.size(); ihit++) {
      if (hitVector[ihit].Channel() == wireVector[iwire].Channel())
        WireHitAssocVector[iwire].push_back(ihit);
    }
  }
}

void
hit::HitAnaModule::createMCAssocVector(std::vector<recob::Wire> const& wireVector,
                                       std::vector<sim::MCHitCollection> const& mcHitVector,
                                       std::vector<std::vector<int>>& WireMCHitAssocVector)
{

  WireMCHitAssocVector.clear();
  WireMCHitAssocVector.resize(wireVector.size());

  //first, store all the MCHitCollection indices in a map keyed on channel
  //then, loop through wires, and lookup mchitcollections based on the wire's channel

  std::map<unsigned int, std::vector<int>> mcHitIndicesByChannel;
  for (unsigned int icol = 0; icol < mcHitVector.size(); icol++)
    mcHitIndicesByChannel[mcHitVector[icol].Channel()].push_back(icol);

  for (unsigned int iwire = 0; iwire < wireVector.size(); iwire++)
    WireMCHitAssocVector[iwire].insert(WireMCHitAssocVector[iwire].end(),
                                       mcHitIndicesByChannel[wireVector[iwire].Channel()].begin(),
                                       mcHitIndicesByChannel[wireVector[iwire].Channel()].end());
}

void
hit::HitAnaModule::analyze(art::Event const& e)
{
  //get event and run numbers
  unsigned int eventNumber = e.id().event();
  unsigned int runNumber = e.run();

  analysisAlg.ClearHitModules();

  // get the data
  auto const& wireVector = *e.getValidHandle<std::vector<recob::Wire>>(fWireModuleLabel);
  auto const& mcHitVector = *e.getValidHandle<std::vector<sim::MCHitCollection>>(fMCHitModuleLabel);

  // make the association vector. First index is wire index, second is
  // mcHitCollection index
  std::vector<std::vector<int>> WireMCHitAssocVector;
  createMCAssocVector(wireVector, mcHitVector, WireMCHitAssocVector);

  //get the hit data
  size_t nHitModules = fHitModuleLabels.size();
  std::vector<art::Handle<std::vector<recob::Hit>>> hitHandles(nHitModules);
  // for each hit module output (first index), for each wire (second index)
  // the list of hits associated with that wire is stored
  std::vector<std::vector<std::vector<int>>> WireHitAssocVectors(nHitModules);
  for (size_t iter = 0; iter < nHitModules; iter++) {

    e.getByLabel(fHitModuleLabels[iter], hitHandles[iter]);

    //create association vectors by hand for now
    //art::ValidHandle<HitWireAssns_t> HitToWireAssns
    //= e.getValidHandle<HitWireAssns_t>(fHitModuleLabels[iter]);
    //WireHitAssocVectors[iter].resize(wireVector.size());
    //createAssocVector(*HitToWireAssns,WireHitAssocVectors[iter]);

    WireHitAssocVectors[iter].resize(wireVector.size());
    art::Handle<HitWireAssns_t> HitToWireAssns;
    if (e.getByLabel(fHitModuleLabels[iter], HitToWireAssns))
      createAssocVector(*HitToWireAssns, WireHitAssocVectors[iter]);
    else
      createAssocVector(wireVector, *(hitHandles[iter]), WireHitAssocVectors[iter]);

    //load in this hit/assoc pair
    analysisAlg.LoadHitAssocPair(
      *(hitHandles[iter]), WireHitAssocVectors[iter], fHitModuleLabels[iter]);
  }

  // get time service
  auto const clock_data = art::ServiceHandle<detinfo::DetectorClocksService const>()->DataFor(e);

  // run the analzyer alg
  analysisAlg.AnalyzeWires(
    wireVector, mcHitVector, WireMCHitAssocVector, clock_data, eventNumber, runNumber);
}

void
hit::HitAnaModule::beginJob()
{
  art::ServiceHandle<art::TFileService const> tfs;
  wireDataTree = tfs->make<TTree>("wireDataTree", "WireDataTree");
  analysisAlg.SetWireDataTree(wireDataTree);

  // The below creates a Tree with one branch - a recob::Hit branch - for each
  // Hit module specified in the fcl file. So, don't run this module once per Hit
  // Finder as one normally would. Just run it once and specify all HitFinders.
  // This was the design for the WireDataTree; we follow it here for the
  // Hit trees.
  for (auto const& label : fHitModuleLabels) {
    std::string firstArg("hitData_");
    firstArg += label;
    std::string secArg("HitDataTree_");
    secArg += label;
    TTree* intermediateTree = tfs->make<TTree>(firstArg.c_str(), secArg.c_str());
    hitDataTree.push_back(intermediateTree);
  }
  analysisAlg.SetHitDataTree(hitDataTree);
}

DEFINE_ART_MODULE(hit::HitAnaModule)