HitAnaAlg.cxx

Go to the documentation of this file.

/*!
 * 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 "HitAnaAlg.h"
#include "lardataalg/DetectorInfo/DetectorClocks.h"

#include <functional>
#include <unordered_map>

#include "TTree.h"

hit::HitAnaAlg::HitAnaAlg()
{
  wireData.NHitModules = 0;
}

void
hit::HitAnaAlg::SetWireDataTree(TTree* wdt)
{
  wireDataTree = wdt;
  SetupWireDataTree();
}

void
hit::HitAnaAlg::SetHitDataTree(std::vector<TTree*>& trees)
{

  hitDataTree.clear();
  hitData.clear();

  hitDataTree.reserve(trees.size());
  // This is particularly important: to establish the hitData memory -- all before
  // individually making the tree->Branch() calls, specifying those addresses.
  hitData.reserve(trees.size());

  // Construct the local attribute data container
  for (auto const& t : trees) {
    hitDataTree.push_back(t);
    hitData.push_back(new recob::Hit);
  }

  for (size_t i = 0; i < hitData.size(); ++i)
    hitDataTree[i]->Branch(hitDataTree[i]->GetName(), "recob::Hit", &(hitData[i]));
}

void
hit::HitAnaAlg::SetupWireDataTree()
{
  wireDataTree->Branch("event", &wireData.event, "event/i");
  wireDataTree->Branch("run", &wireData.run, "run/i");
  wireDataTree->Branch("channel", &wireData.channel, "channel/i");
  wireDataTree->Branch("plane", &wireData.plane, "plane/i");
  wireDataTree->Branch("roi_index", &wireData.range_index, "roi_index/i");
  wireDataTree->Branch("roi_start", &wireData.range_start, "roi_start/i");
  wireDataTree->Branch("roi_size", &wireData.range_size, "roi_size/i");
  wireDataTree->Branch("roi_charge", &wireData.integrated_charge, "roi_charge/F");
  wireDataTree->Branch("roi_peak_charge", &wireData.peak_charge, "roi_peak_charge/F");
  wireDataTree->Branch("roi_peak_time", &wireData.peak_time, "roi_peak_time/F");
  wireDataTree->Branch("nHitModules", &wireData.NHitModules, "nHitModules/I");
  wireDataTree->Branch("HitModuleLabels", &wireData.HitModuleLabels);
  wireDataTree->Branch("NHits", &wireData.NHits);
  wireDataTree->Branch("Hits_IntegratedCharge", &wireData.Hits_IntegratedCharge);
  wireDataTree->Branch("Hits_AverageCharge", &wireData.Hits_AverageCharge);
  wireDataTree->Branch("Hits_PeakCharge", &wireData.Hits_PeakCharge);
  wireDataTree->Branch("Hits_Peak", &wireData.Hits_PeakTime);
  wireDataTree->Branch("Hits_wAverageCharge", &wireData.Hits_wAverageCharge);
  wireDataTree->Branch("Hits_wAverageTime", &wireData.Hits_wAverageTime);
  wireDataTree->Branch("Hits_MeanMultiplicity", &wireData.Hits_MeanMultiplicity);

  wireDataTree->Branch("NMCHits", &wireData.NMCHits);
  wireDataTree->Branch("MCHits_IntegratedCharge", &wireData.MCHits_IntegratedCharge);
  wireDataTree->Branch("MCHits_AverageCharge", &wireData.MCHits_AverageCharge);
  wireDataTree->Branch("MCHits_PeakCharge", &wireData.MCHits_PeakCharge);
  wireDataTree->Branch("MCHits_Peak", &wireData.MCHits_PeakTime);
  wireDataTree->Branch("MCHits_wAverageCharge", &wireData.MCHits_wAverageCharge);
  wireDataTree->Branch("MCHits_wAverageTime", &wireData.MCHits_wAverageTime);
}

void
hit::HitAnaAlg::ClearHitModules()
{
  HitModuleLabels.clear();
  HitProcessingQueue.clear();
  wireData.NHitModules = 0;
}

void
hit::HitAnaAlg::LoadHitAssocPair(std::vector<recob::Hit> const& HitVector,
                                 std::vector<std::vector<int>> const& AssocVector,
                                 std::string const& HitModuleLabel)
{

  HitProcessingQueue.push_back(std::make_pair(std::cref(HitVector), std::cref(AssocVector)));
  HitModuleLabels.push_back(HitModuleLabel);

  if (HitProcessingQueue.size() != HitModuleLabels.size()) throw hitanaalgexception;
}

void
hit::HitAnaAlg::AnalyzeWires(std::vector<recob::Wire> const& WireVector,
                             std::vector<sim::MCHitCollection> const& MCHitCollectionVector,
                             std::vector<std::vector<int>> const& AssocVector,
                             detinfo::DetectorClocksData const& clock_data,
                             unsigned int event,
                             unsigned int run)
{

  InitWireData(event, run);
  for (size_t iwire = 0; iwire < WireVector.size(); iwire++)
    FillWireInfo(WireVector[iwire], iwire, MCHitCollectionVector, AssocVector[iwire], clock_data);
}

void
hit::HitAnaAlg::InitWireData(unsigned int event, unsigned int run)
{

  wireData.event = event;
  wireData.run = run;
  wireData.NHitModules = HitModuleLabels.size();
  wireData.HitModuleLabels = HitModuleLabels;
}

void
hit::HitAnaAlg::ClearWireDataHitInfo()
{
  wireData.NMCHits = 0;
  wireData.MCHits_IntegratedCharge = 0;
  wireData.MCHits_AverageCharge = 0;
  wireData.MCHits_PeakCharge = -999;
  wireData.MCHits_PeakTime = 0;
  wireData.MCHits_wAverageCharge = 0;
  wireData.MCHits_wAverageTime = 0;

  wireData.NHits.assign(wireData.NHitModules, 0);
  wireData.Hits_IntegratedCharge.assign(wireData.NHitModules, 0);
  wireData.Hits_AverageCharge.assign(wireData.NHitModules, 0);
  wireData.Hits_PeakCharge.assign(wireData.NHitModules, -999);
  wireData.Hits_PeakTime.assign(wireData.NHitModules, 0);
  wireData.Hits_wAverageCharge.assign(wireData.NHitModules, 0);
  wireData.Hits_wAverageTime.assign(wireData.NHitModules, 0);
  wireData.Hits_MeanMultiplicity.assign(wireData.NHitModules, 0);
  wireData.Hits.clear();
  wireData.Hits.resize(wireData.NHitModules);
}

void
hit::HitAnaAlg::FillWireInfo(recob::Wire const& wire,
                             int WireIndex,
                             std::vector<sim::MCHitCollection> const& MCHitCollectionVector,
                             std::vector<int> const& thisAssocVector,
                             detinfo::DetectorClocksData const& clock_data)
{

  wireData.channel = wire.Channel();
  wireData.plane = wire.View();
  unsigned int range_index = 0;

  for (auto const& range : wire.SignalROI().get_ranges()) {

    wireData.range_index = range_index;
    wireData.range_start = range.begin_index();
    wireData.range_size = range.size();

    ClearWireDataHitInfo();

    ProcessROI(range, WireIndex, MCHitCollectionVector, thisAssocVector, clock_data);
    range_index++;

  } //end loop over roi ranges
}

void
hit::HitAnaAlg::ROIInfo(lar::sparse_vector<float>::datarange_t const& range,
                        float& charge_sum,
                        float& charge_peak,
                        float& charge_peak_time)
{

  charge_sum = 0;
  charge_peak = -999;
  unsigned int counter = range.begin_index();

  for (auto const& value : range) {
    charge_sum += value;
    if (value > charge_peak) {
      charge_peak = value;
      charge_peak_time = (float)counter;
    }
    counter++;
  }
}

void
hit::HitAnaAlg::ProcessROI(lar::sparse_vector<float>::datarange_t const& range,
                           int WireIndex,
                           std::vector<sim::MCHitCollection> const& MCHitCollectionVector,
                           std::vector<int> const& thisAssocVector,
                           detinfo::DetectorClocksData const& clock_data)
{

  ROIInfo(range, wireData.integrated_charge, wireData.peak_charge, wireData.peak_time);

  //std::cout << "----------------------------------------------------------------" << std::endl;
  //std::cout << "WireIndex = " << WireIndex << std::endl;
  //std::cout << "\tRange begin: " << range.begin_index() << std::endl;
  //std::cout << "\tRange end: " << range.begin_index()+range.size() << std::endl;

  for (size_t iter = 0; iter < HitProcessingQueue.size(); iter++)
    FindAndStoreHitsInRange(HitProcessingQueue[iter].first,
                            HitProcessingQueue[iter].second.at(WireIndex),
                            iter,
                            range.begin_index(),
                            range.begin_index() + range.size());

  FindAndStoreMCHitsInRange(MCHitCollectionVector,
                            thisAssocVector,
                            range.begin_index(),
                            range.begin_index() + range.size(),
                            clock_data);

  wireDataTree->Fill();
}

void
hit::HitAnaAlg::FindAndStoreHitsInRange(std::vector<recob::Hit> const& HitVector,
                                        std::vector<int> const& HitsOnWire,
                                        size_t hitmodule_iter,
                                        size_t begin_wire_tdc,
                                        size_t end_wire_tdc)
{

  wireData.Hits_PeakCharge[hitmodule_iter] = -999;

  for (auto const& hit_index : HitsOnWire) {
    recob::Hit const& thishit = HitVector.at(hit_index);

    //check if this hit is on this ROI
    if (thishit.PeakTimeMinusRMS() < begin_wire_tdc || thishit.PeakTimePlusRMS() > end_wire_tdc)
      continue;

    FillHitInfo(thishit, wireData.Hits[hitmodule_iter]);
    wireData.NHits[hitmodule_iter]++;
    wireData.Hits_IntegratedCharge[hitmodule_iter] += thishit.Integral();

    if (thishit.PeakAmplitude() > wireData.Hits_PeakCharge[hitmodule_iter]) {
      wireData.Hits_PeakCharge[hitmodule_iter] = thishit.PeakAmplitude();
      wireData.Hits_PeakTime[hitmodule_iter] = thishit.PeakTime();
    }

    wireData.Hits_wAverageCharge[hitmodule_iter] += thishit.Integral() * thishit.Integral();
    wireData.Hits_wAverageTime[hitmodule_iter] += thishit.Integral() * thishit.PeakTime();
    wireData.Hits_MeanMultiplicity[hitmodule_iter] += thishit.Multiplicity();

    *(hitData.at(hitmodule_iter)) = thishit;
    (hitDataTree.at(hitmodule_iter))->Fill();
  }

  wireData.Hits_AverageCharge[hitmodule_iter] =
    wireData.Hits_IntegratedCharge[hitmodule_iter] / wireData.NHits[hitmodule_iter];
  wireData.Hits_wAverageCharge[hitmodule_iter] =
    wireData.Hits_wAverageCharge[hitmodule_iter] / wireData.Hits_IntegratedCharge[hitmodule_iter];
  wireData.Hits_wAverageTime[hitmodule_iter] =
    wireData.Hits_wAverageTime[hitmodule_iter] / wireData.Hits_IntegratedCharge[hitmodule_iter];

  wireData.Hits_MeanMultiplicity[hitmodule_iter] /= wireData.NHits[hitmodule_iter];
}

void
hit::HitAnaAlg::FindAndStoreMCHitsInRange(
  std::vector<sim::MCHitCollection> const& MCHitCollectionVector,
  std::vector<int> const& HitsOnWire,
  size_t begin_wire_tdc,
  size_t end_wire_tdc,
  detinfo::DetectorClocksData const& clock_data)
{

  wireData.MCHits_PeakCharge = -999;

  for (auto const& hit_index : HitsOnWire) {
    sim::MCHitCollection const& thismchitcol = MCHitCollectionVector.at(hit_index);

    //let's have a map to keep track of the number of total particles
    std::unordered_map<int, unsigned int> nmchits_per_trackID_map;
    for (auto const& thishit : thismchitcol) {

      //std::cout << "\t************************************************************" << std::endl;
      //std::cout << "\t\tMCHit begin: " << ts->TPCTDC2Tick( thishit.PeakTime()-thishit.PeakWidth() ) << std::endl;
      //std::cout << "\t\tMCHit end: " << ts->TPCTDC2Tick( thishit.PeakTime()+thishit.PeakWidth() ) << std::endl;

      //check if this hit is on this ROI
      if (clock_data.TPCTDC2Tick(thishit.PeakTime() - thishit.PeakWidth()) < begin_wire_tdc ||
          clock_data.TPCTDC2Tick(thishit.PeakTime() + thishit.PeakWidth()) > end_wire_tdc)
        continue;

      nmchits_per_trackID_map[thishit.PartTrackId()] += 1;
      wireData.MCHits_IntegratedCharge += thishit.Charge();

      if (thishit.Charge(true) > wireData.MCHits_PeakCharge) {
        wireData.MCHits_PeakCharge = thishit.Charge(true);
        wireData.MCHits_PeakTime = clock_data.TPCTDC2Tick(thishit.PeakTime());
      }

      wireData.MCHits_wAverageCharge += thishit.Charge() * thishit.Charge();
      wireData.MCHits_wAverageTime += thishit.Charge() * clock_data.TPCTDC2Tick(thishit.PeakTime());
    }

    wireData.NMCHits = nmchits_per_trackID_map.size();

    wireData.MCHits_AverageCharge = wireData.MCHits_IntegratedCharge / wireData.NMCHits;
    wireData.MCHits_wAverageCharge =
      wireData.MCHits_wAverageCharge / wireData.MCHits_IntegratedCharge;
    wireData.MCHits_wAverageTime = wireData.MCHits_wAverageTime / wireData.MCHits_IntegratedCharge;
  }
}

void
hit::HitAnaAlg::FillHitInfo(recob::Hit const& hit, std::vector<HitInfo>& HitInfoVector)
{
  HitInfoVector.emplace_back(hit.PeakTime(),
                             hit.SigmaPeakTime(),
                             hit.RMS(),
                             hit.StartTick(),
                             hit.EndTick(),
                             hit.Integral(),
                             hit.SigmaIntegral(),
                             hit.PeakAmplitude(),
                             hit.SigmaPeakAmplitude(),
                             hit.GoodnessOfFit());
}