btutil::MCMatchAlg Class Reference

#include "MCMatchAlg.h"

Public Member Functions
	MCMatchAlg ()
	Default constructor. More...
virtual	~MCMatchAlg ()
	Default destructor. More...
bool	BuildMap (detinfo::DetectorClocksData const &clockData, const std::vector< unsigned int > &g4_trackid_v, const std::vector< sim::SimChannel > &simch_v, const std::vector< std::vector< art::Ptr< recob::Hit >>> &cluster_v)
	Constructs needed information for Reco=>MC matching. More...
bool	BuildMap (detinfo::DetectorClocksData const &clockData, const std::vector< std::vector< unsigned int >> &g4_trackid_v, const std::vector< sim::SimChannel > &simch_v, const std::vector< std::vector< art::Ptr< recob::Hit >>> &cluster_v)
	Constructs needed information for Reco=>MC matching. More...
const std::vector< int > &	BestClusters (const size_t mcshower_index) const
double	ClusterCorrectness (const size_t cluster_index, const size_t mcshower_index) const
std::pair< size_t, double >	ShowerCorrectness (const std::vector< unsigned int > cluster_indices) const
std::pair< double, double >	ClusterEP (const size_t cluster_index, const size_t mcshower_index) const
	For a specified cluster, compute cluster efficiency and purity in terms of specified MC object. More...
std::pair< double, double >	BestClusterEP (const size_t mcshower_index, const size_t plane_id) const
const MCBTAlg &	BTAlg () const
	BTAlgo getter. More...

Protected Member Functions
bool	BuildMap (detinfo::DetectorClocksData const &clockData, const std::vector< std::vector< art::Ptr< recob::Hit >>> &cluster_v)

Protected Attributes
MCBTAlg	fBTAlgo
	MCBTAlg instance. More...
std::vector< size_t >	_view_to_plane
std::vector< std::vector< double > >	_summed_mcq
std::vector< std::vector< double > >	_cluster_mcq_v
std::vector< unsigned char >	_cluster_plane_id
std::vector< std::vector< int > >	_bmatch_id

Detailed Description

User defined class MCMatchAlg ... these comments are used to generate doxygen documentation!

Definition at line 36 of file MCMatchAlg.h.

Constructor & Destructor Documentation

btutil::MCMatchAlg::MCMatchAlg

(

)

Default constructor.

Definition at line 16 of file MCMatchAlg.cxx.

References _view_to_plane.

  {
    _view_to_plane.clear();
  }

virtual btutil::MCMatchAlg::~MCMatchAlg ( )

inlinevirtual

Default destructor.

Definition at line 43 of file MCMatchAlg.h.

References lar::dump::vector().

{};

Member Function Documentation

std::pair< double, double > btutil::MCMatchAlg::BestClusterEP	(	const size_t	mcshower_index,
		const size_t	plane_id
	)		const

For a specified MC object, compute the best-matched cluster's efficiency and purity from the specified plane ID. Internally this function calls BestClusters() to find the best cluster on each plane, then calls ClusterEP() to retrieve the efficiency and purity.

Definition at line 229 of file MCMatchAlg.cxx.

References BestClusters(), and ClusterEP().

  {

    auto c_index_v = BestClusters(mc_index);

    if (c_index_v.size() <= plane_id)
      throw MCBTException(Form(
        "Plane ID %zu exceeds # of planes recorded in data (%zu)...", plane_id, c_index_v.size()));

    std::pair<double, double> result(0, 0);

    if (c_index_v[plane_id] < 0) return result;

    return ClusterEP(c_index_v[plane_id], mc_index);
  }

const std::vector< int > & btutil::MCMatchAlg::BestClusters

(

const size_t

mcshower_index

)

const

For a specified MC object (via index in MCShower/MCTrack), returns best-matched clusters represented by an index number of clusters. The return vector length is same as

of planes, and "-1" if there is no cluster found on the corresponding plane.

Definition at line 218 of file MCMatchAlg.cxx.

References _bmatch_id.

Referenced by BestClusterEP().

  {
    if (!_bmatch_id.size()) throw MCBTException("Preparation not done yet!");

    if (mc_index >= _bmatch_id.size())
      throw MCBTException(
        Form("Input MC object index (%zu) out of range (%zu)!", mc_index, _bmatch_id.size()));

    return _bmatch_id[mc_index];
  }

const MCBTAlg& btutil::MCMatchAlg::BTAlg ( ) const

inline

BTAlgo getter.

Definition at line 92 of file MCMatchAlg.h.

References lar::dump::vector().

Referenced by ShowerQuality::analyze().

{ return fBTAlgo; }

bool btutil::MCMatchAlg::BuildMap	(	detinfo::DetectorClocksData const &	clockData,
		const std::vector< unsigned int > &	g4_trackid_v,
		const std::vector< sim::SimChannel > &	simch_v,
		const std::vector< std::vector< art::Ptr< recob::Hit >>> &	cluster_v
	)

Constructs needed information for Reco=>MC matching.

Definition at line 21 of file MCMatchAlg.cxx.

References fBTAlgo, and btutil::MCBTAlg::Reset().

Referenced by ShowerQuality::analyze(), and BuildMap().

  {
    fBTAlgo.Reset(g4_trackid_v, simch_v);

    return BuildMap(clockData, cluster_v);
  }

bool btutil::MCMatchAlg::BuildMap	(	detinfo::DetectorClocksData const &	clockData,
		const std::vector< std::vector< unsigned int >> &	g4_trackid_v,
		const std::vector< sim::SimChannel > &	simch_v,
		const std::vector< std::vector< art::Ptr< recob::Hit >>> &	cluster_v
	)

Constructs needed information for Reco=>MC matching.

Definition at line 31 of file MCMatchAlg.cxx.

References BuildMap(), fBTAlgo, and btutil::MCBTAlg::Reset().

  {

    fBTAlgo.Reset(g4_trackid_v, simch_v);

    return BuildMap(clockData, cluster_v);
  }

bool btutil::MCMatchAlg::BuildMap ( detinfo::DetectorClocksData const &  clockData, const std::vector< std::vector< art::Ptr< recob::Hit >>> &  cluster_v  )

protected

Definition at line 42 of file MCMatchAlg.cxx.

References _bmatch_id, _cluster_mcq_v, _cluster_plane_id, _summed_mcq, btutil::WireRange_t::ch, btutil::WireRange_t::end, fBTAlgo, Get, btutil::MCBTAlg::MCQ(), btutil::MCBTAlg::NumParts(), and btutil::WireRange_t::start.

  {
    size_t num_mcobj = fBTAlgo.NumParts();
    size_t num_cluster = cluster_v.size();

    auto const& wireReadoutGeom = art::ServiceHandle<geo::WireReadout>()->Get();

    //
    // Perform back-tracking
    //
    // (1) Load cluster/hit data product
    // (2) Loop over all clusters and find charge fraction to each MC object
    // (3) For each MC object, find a cluster per plane with the highest charge

    // Loop over clusters & get charge fraction per MC object
    _summed_mcq.clear();
    _cluster_mcq_v.clear();
    _cluster_plane_id.clear();

    _summed_mcq.resize(num_mcobj + 1, std::vector<double>(wireReadoutGeom.Nplanes(), 0));
    _cluster_mcq_v.reserve(num_cluster);
    _cluster_plane_id.reserve(num_cluster);

    for (auto const& hit_v : cluster_v) {

      size_t plane = wireReadoutGeom.Nplanes();

      // Create hit list
      std::vector<WireRange_t> wr_v;
      wr_v.reserve(hit_v.size());

      for (auto const& h : hit_v) {

        WireRange_t wr;
        wr.ch = h->Channel();
        wr.start = h->StartTick();
        wr.end = h->EndTick();
        wr_v.push_back(wr);
        if (plane == wireReadoutGeom.Nplanes()) plane = h->WireID().Plane;
      }

      _cluster_plane_id.push_back(plane);

      auto mcq_v = fBTAlgo.MCQ(clockData, wr_v);

      for (size_t i = 0; i < mcq_v.size(); ++i)

        _summed_mcq[i][plane] += mcq_v[i];

      _cluster_mcq_v.push_back(mcq_v);
    }

    //
    // Find the best matched pair (and its charge) per MC object
    //
    _bmatch_id.clear();
    _bmatch_id.resize(num_mcobj, std::vector<int>(wireReadoutGeom.Nplanes(), -1));

    std::vector<std::vector<double>> bmatch_mcq(num_mcobj,
                                                std::vector<double>(wireReadoutGeom.Nplanes(), 0));

    for (size_t mc_index = 0; mc_index < num_mcobj; ++mc_index) {

      for (size_t cluster_index = 0; cluster_index < num_cluster; ++cluster_index) {

        auto plane = _cluster_plane_id.at(cluster_index);

        double q = _cluster_mcq_v[cluster_index][mc_index];

        if (bmatch_mcq[mc_index][plane] < q) {

          bmatch_mcq[mc_index][plane] = q;
          _bmatch_id[mc_index][plane] = cluster_index;
        }
      }
    }

    return true;
  }

double btutil::MCMatchAlg::ClusterCorrectness	(	const size_t	cluster_index,
		const size_t	mcshower_index
	)		const

For a specified cluster, compute the correctness for the specified MC object

Definition at line 123 of file MCMatchAlg.cxx.

References _bmatch_id, _cluster_mcq_v, and _cluster_plane_id.

Referenced by ShowerCorrectness().

  {

    if (!_bmatch_id.size()) throw MCBTException("Preparation not done yet!");

    if (cluster_index >= _cluster_mcq_v.size())
      throw MCBTException(Form(
        "Input cluster index (%zu) out of range (%zu)!", cluster_index, _cluster_mcq_v.size()));

    if (mc_index >= _bmatch_id.size())
      throw MCBTException(
        Form("Input MC object index (%zu) out of range (%zu)!", mc_index, _bmatch_id.size()));

    auto plane = _cluster_plane_id.at(cluster_index);

    auto best_cluster_index = _bmatch_id.at(mc_index).at(plane);

    if (best_cluster_index < 0) return -1;

    return _cluster_mcq_v.at(cluster_index).at(mc_index) /
           _cluster_mcq_v.at(best_cluster_index).at(mc_index);
  }

std::pair< double, double > btutil::MCMatchAlg::ClusterEP	(	const size_t	cluster_index,
		const size_t	mcshower_index
	)		const

For a specified cluster, compute cluster efficiency and purity in terms of specified MC object.

Definition at line 187 of file MCMatchAlg.cxx.

References _bmatch_id, _cluster_mcq_v, _cluster_plane_id, and _summed_mcq.

Referenced by ShowerQuality::analyze(), and BestClusterEP().

  {
    if (!_bmatch_id.size()) throw MCBTException("Preparation not done yet!");

    if (cluster_index >= _cluster_mcq_v.size())
      throw MCBTException(Form(
        "Input cluster index (%zu) out of range (%zu)!", cluster_index, _cluster_mcq_v.size()));

    if (mc_index >= _bmatch_id.size())
      throw MCBTException(
        Form("Input MC object index (%zu) out of range (%zu)!", mc_index, _bmatch_id.size()));

    // efficiency = this cluster's mcq for specified mc obj / total mcq by this mcshower in all clusters
    // purity = this cluster's mcq for this mcshower / total mcq from all mc obj in this cluster

    std::pair<double, double> result;

    auto plane = _cluster_plane_id[cluster_index];

    result.first = _cluster_mcq_v[cluster_index][mc_index] / _summed_mcq[mc_index][plane];

    double cluster_mcq_total = 0;
    for (auto const& q : _cluster_mcq_v[cluster_index])
      cluster_mcq_total += q;

    result.second = _cluster_mcq_v[cluster_index][mc_index] / cluster_mcq_total;

    return result;
  }

std::pair< size_t, double > btutil::MCMatchAlg::ShowerCorrectness

(

const std::vector< unsigned int >

cluster_indices

)

const

Similar to ClusterCorrectness() function except this one computes the correctness for multiple clusters. It is meant to compute the correctness for a cluster combination that is matched across plane to represent one 3D reco object. The return is a pair of best-matched MC object and correctness.

Definition at line 146 of file MCMatchAlg.cxx.

References _bmatch_id, _cluster_mcq_v, and ClusterCorrectness().

Referenced by ShowerQuality::analyze().

  {

    if (!_bmatch_id.size()) throw MCBTException("Preparation not done yet!");

    if (cluster_indices.size() > _cluster_mcq_v.size())
      throw MCBTException(
        Form("Input cluster indices length (%zu) > # of registered clusters (%zu)!",
             cluster_indices.size(),
             _cluster_mcq_v.size()));

    if (!cluster_indices.size()) throw MCBTException("Input cluster indices empty!");

    // Compute efficiency per MC
    std::vector<double> match_eff(_bmatch_id.size(), 1);

    for (auto const& cluster_index : cluster_indices) {

      for (size_t mc_index = 0; mc_index < _bmatch_id.size(); ++mc_index) {

        double correctness = ClusterCorrectness(cluster_index, mc_index);

        if (correctness >= 0) match_eff.at(mc_index) *= correctness;
      }
    }

    std::pair<size_t, double> result(0, -1);

    // Find the best qratio
    for (size_t mc_index = 0; mc_index < match_eff.size(); ++mc_index) {

      if (match_eff.at(mc_index) < result.second) continue;

      result.second = match_eff.at(mc_index);

      result.first = mc_index;
    }
    return result;
  }

Member Data Documentation

std::vector<std::vector<int> > btutil::MCMatchAlg::_bmatch_id

protected

Definition at line 107 of file MCMatchAlg.h.

Referenced by BestClusters(), BuildMap(), ClusterCorrectness(), ClusterEP(), and ShowerCorrectness().

std::vector<std::vector<double> > btutil::MCMatchAlg::_cluster_mcq_v

protected

Definition at line 104 of file MCMatchAlg.h.

Referenced by BuildMap(), ClusterCorrectness(), ClusterEP(), and ShowerCorrectness().

std::vector<unsigned char> btutil::MCMatchAlg::_cluster_plane_id

protected

Definition at line 106 of file MCMatchAlg.h.

Referenced by BuildMap(), ClusterCorrectness(), and ClusterEP().

std::vector<std::vector<double> > btutil::MCMatchAlg::_summed_mcq

protected

Definition at line 103 of file MCMatchAlg.h.

Referenced by BuildMap(), and ClusterEP().

std::vector<size_t> btutil::MCMatchAlg::_view_to_plane

protected

Definition at line 101 of file MCMatchAlg.h.

Referenced by MCMatchAlg().

MCBTAlg btutil::MCMatchAlg::fBTAlgo

protected

MCBTAlg instance.

Definition at line 99 of file MCMatchAlg.h.

Referenced by BuildMap().

---

The documentation for this class was generated from the following files:

• larreco/v10_01_07/source/larreco/MCComp/MCMatchAlg.h
• larreco/v10_01_07/source/larreco/MCComp/MCMatchAlg.cxx