cmtool::CFAlgoChargeDistrib Class Reference

#include "CFAlgoChargeDistrib.h"

Inheritance diagram for cmtool::CFAlgoChargeDistrib:

Public Member Functions
	CFAlgoChargeDistrib ()
	Default constructor. More...
virtual	~CFAlgoChargeDistrib ()
	Default destructor. More...
virtual float	Float (const std::vector< const cluster::ClusterParamsAlg * > &clusters)
virtual void	Report ()
virtual void	Reset ()
	Function to reset the algorithm instance, called together with manager's Reset() More...
virtual void	EventBegin (const std::vector< cluster::ClusterParamsAlg > &clusters)
virtual void	EventEnd ()
virtual void	IterationBegin (const std::vector< cluster::ClusterParamsAlg > &clusters)
virtual void	IterationEnd ()
void	SetAnaFile (TFile *fout)
	Setter function for an output plot TFile pointer. More...

Protected Attributes
TFile *	_fout
	TFile pointer to an output file. More...

Private Member Functions
float	TProfConvol (std::vector< util::PxHit > hita, std::vector< util::PxHit > hitb)
void	SetVerbose (bool on)
	Setter function for verbosity. More...
void	SetDebug (bool on)

Private Attributes
bool	_verbose
bool	_debug

Detailed Description

User implementation for CFloatAlgoBase class doxygen documentation!

Definition at line 25 of file CFAlgoChargeDistrib.h.

Constructor & Destructor Documentation

cmtool::CFAlgoChargeDistrib::CFAlgoChargeDistrib

(

)

Default constructor.

Definition at line 10 of file CFAlgoChargeDistrib.cxx.

References SetDebug(), and SetVerbose().

                                           : CFloatAlgoBase()
  //-------------------------------------------------------
  {
    SetVerbose(false);
    SetDebug(false);
  }

virtual cmtool::CFAlgoChargeDistrib::~CFAlgoChargeDistrib ( )

inlinevirtual

Default destructor.

Definition at line 33 of file CFAlgoChargeDistrib.h.

References Float(), Report(), Reset(), and TProfConvol().

{};

Member Function Documentation

virtual void cmtool::CMAlgoBase::EventBegin ( const std::vector< cluster::ClusterParamsAlg > &  clusters )

inlinevirtualinherited

Optional function: called at the beginning of 1st iteration. This is called per event.

Reimplemented in cmtool::CFAlgoArray, cmtool::CPAlgoArray, cmtool::CBAlgoArray, and cmtool::CBAlgoPolyShortestDist.

Definition at line 45 of file CMAlgoBase.h.

Referenced by cmtool::CMergeManager::EventBegin().

    { if(clusters.size()) return; }

virtual void cmtool::CMAlgoBase::EventEnd ( )

inlinevirtualinherited

Optional function: called at the end of event ... after the last merging iteration is over.

Reimplemented in cmtool::CFAlgoArray, cmtool::CPAlgoArray, and cmtool::CBAlgoArray.

Definition at line 51 of file CMAlgoBase.h.

Referenced by cmtool::CMatchManager::EventEnd(), and cmtool::CMergeManager::EventEnd().

    {return;}

float cmtool::CFAlgoChargeDistrib::Float ( const std::vector< const cluster::ClusterParamsAlg * > &  clusters )

virtual

Core function: given a set of CPANs, return a float which indicates the compatibility the cluster combination.

Reimplemented from cmtool::CFloatAlgoBase.

Definition at line 25 of file CFAlgoChargeDistrib.cxx.

References _verbose, c1, c2, and TProfConvol().

Referenced by ~CFAlgoChargeDistrib().

  {

    // Code-block by Kazu starts
    // This ensures the algorithm works only if # clusters is > 2 (and not =2)
    // You may take out this block if you want to allow matching using clusters from only 2 planes.
    //if(clusters.size()==2) return -1;
    // Code-block by Kazu ends

    //This algorithm now works for 3 planes: find 3Dstart point from first 2 planes and find
    //How well that agrees with 3rd plane's start point location.

    //So first, make sure clusters vector has more than 1 element.
    //If not, return -1. Algorithm does not make sense
    if ( clusters.size() == 1 )
      return -1;

    if (_verbose) { std::cout << "Number of clusters taken into account: " << clusters.size() << std::endl; }
    
    //MicroBooNE Nomenclature:
    //Planes: U == 0; V == 1; Y == 2.

    //Get hits for all 3 clusters
    std::vector<std::vector<util::PxHit> > Hits;//(clusters.size(), std::vector<util::PxHit>());

    for (size_t c=0; c < clusters.size(); c++)
      Hits.push_back( clusters.at(c)->GetHitVector() );

    // return parameter is the product of 
    // "convolutions" of each pair of clusters
    // return conv(a,b)*conv(b,c)*conv(c,a)
    // in the case of 3 planes with clusters
    // a, b and c.
    // The functions being convolved are the
    // charge-distribution in time of each clusters
    // The "convolution" is the common area of the
    // two distributions: the larger the charge-
    // -overlap the better the match
    // No normalization is performed.

    float totOverlap = 1;
    for (size_t c1=0; c1 < (Hits.size()-1); c1++){
      for (size_t c2=c1+1; c2 < Hits.size(); c2++){
        if (_verbose) { std::cout << "Considering Clusters: " << c1 << ", " << c2 << std::endl; }
        totOverlap *= TProfConvol(Hits.at(c1), Hits.at(c2) );
      }
    }

    if (_verbose) { std::cout << "Tot Overlap is: " << totOverlap << std::endl << std::endl; }
    
    return totOverlap;

  }

virtual void cmtool::CMAlgoBase::IterationBegin ( const std::vector< cluster::ClusterParamsAlg > &  clusters )

inlinevirtualinherited

Optional function: called at the beggining of each iteration over all pairs of clusters. This provides all clusters' information in case the algorithm need them. Note this is called per iteration which may be more than once per event.

Reimplemented in cmtool::CFAlgoArray, cmtool::CPAlgoArray, and cmtool::CBAlgoArray.

Definition at line 59 of file CMAlgoBase.h.

Referenced by cmtool::CMatchManager::EventBegin(), cmtool::CMatchManager::IterationBegin(), and cmtool::CMergeManager::IterationBegin().

    { if(clusters.size()) return;}

virtual void cmtool::CMAlgoBase::IterationEnd ( )

inlinevirtualinherited

Optional function: called at the end of each iteration over all pairs of clusters.

Reimplemented in cmtool::CFAlgoArray, cmtool::CPAlgoArray, and cmtool::CBAlgoArray.

Definition at line 65 of file CMAlgoBase.h.

Referenced by cmtool::CMatchManager::IterationEnd(), and cmtool::CMergeManager::IterationEnd().

    {return; }

void cmtool::CFAlgoChargeDistrib::Report ( )

virtual

Optional function: called after each iterative approach if a manager class is run with verbosity level <= kPerIteration. Maybe useful for debugging.

Reimplemented from cmtool::CMAlgoBase.

Definition at line 81 of file CFAlgoChargeDistrib.cxx.

Referenced by ~CFAlgoChargeDistrib().

  {

  }

void cmtool::CFAlgoChargeDistrib::Reset ( )

virtual

Function to reset the algorithm instance, called together with manager's Reset()

Reimplemented from cmtool::CMAlgoBase.

Definition at line 18 of file CFAlgoChargeDistrib.cxx.

Referenced by ~CFAlgoChargeDistrib().

  {

  }

void cmtool::CMAlgoBase::SetAnaFile ( TFile *  fout )

inlineinherited

Setter function for an output plot TFile pointer.

Definition at line 77 of file CMAlgoBase.h.

References cmtool::CMAlgoBase::_fout.

Referenced by cmtool::CMergeManager::EventBegin().

{ _fout = fout; }

void cmtool::CFAlgoChargeDistrib::SetDebug ( bool  on )

inlineprivate

Definition at line 62 of file CFAlgoChargeDistrib.h.

References _debug.

Referenced by CFAlgoChargeDistrib().

{ _debug = on; }

void cmtool::CFAlgoChargeDistrib::SetVerbose ( bool  doit )

inlineprivatevirtual

Setter function for verbosity.

Reimplemented from cmtool::CMAlgoBase.

Definition at line 60 of file CFAlgoChargeDistrib.h.

References _verbose.

Referenced by CFAlgoChargeDistrib().

{ _verbose = on; }

float cmtool::CFAlgoChargeDistrib::TProfConvol ( std::vector< util::PxHit >  hita, std::vector< util::PxHit >  hitb  )

private

Definition at line 89 of file CFAlgoChargeDistrib.cxx.

References _debug, _verbose, detinfo::DetectorProperties::NumberTimeSamples(), and util::GeometryUtilities::TimeToCm().

Referenced by Float(), and ~CFAlgoChargeDistrib().

  {
    ::util::GeometryUtilities geou;
    const detinfo::DetectorProperties* detp = lar::providerFrom<detinfo::DetectorPropertiesService>();
    int NumTimeSamples = detp->NumberTimeSamples() * geou.TimeToCm();
    
    double Tmin = NumTimeSamples;
    double Tmax = 0;

    // Make two vectors to hold the Time-Profile of the Q-distribution
    // of the two clusters
    std::vector<float> QprofA(100,0.);
    std::vector<float> QprofB(100,0.);
    float QB = 0;
    float QA = 0;
    
    //First find min and max times
    for(auto const& hitA : hA) {
      if(hitA.t > Tmax) Tmax = hitA.t;
      if(hitA.t < Tmin) Tmin = hitA.t;
    }
    for(auto const& hitB : hB) {
      if(hitB.t > Tmax) Tmax = hitB.t;
      if(hitB.t < Tmin) Tmin = hitB.t;
    }

    //Now Fill Q-profile vectors
    for(auto const& hitA : hA){
      QprofA.at( int(99*(hitA.t-Tmin)/(Tmax-Tmin)) ) += hitA.charge;
      QA += hitA.charge;
    }
    for(auto const& hitB : hB){
      QprofB.at( int(99*(hitB.t-Tmin)/(Tmax-Tmin)) ) += hitB.charge;
      QB += hitB.charge;
    }

    /*//Normalize distributions
    for (size_t b=0; b < QprofA.size(); b++)
      QprofA.at(b) /= QA;
    for (size_t b=0; b < QprofB.size(); b++)
      QprofB.at(b) /= QB;
    */

    //print out distribution if verbose
    if (_debug){
      std::cout << "Q distribution for Cluster A:" << std::endl;
      for (size_t b=0; b < QprofA.size(); b++)
        if ( QprofA.at(b) != 0 ) { std::cout << b << "\t" << QprofA.at(b) << std::endl; }
      std::cout << "Q distribution for Cluster B:" << std::endl;
      for (size_t b=0; b < QprofB.size(); b++)
        if ( QprofB.at(b) != 0 ) { std::cout << b << "\t" << QprofB.at(b) << std::endl; }
    }

    // Now find convolution between the two distributions
    // Scan two vectors and always take smallest quantity
    // Add this smallest quantity as vector is scanned to
    // obtain the common Q-distribution for the clusters
    float conv= 0;
    for (size_t b=0; b < QprofA.size(); b++){
      if ( QprofA.at(b) < QprofB.at(b) ) { conv += QprofA.at(b); }
      else { conv += QprofB.at(b); }
    }
    if (_verbose) { std::cout << "Convolution is: " << conv << std::endl; }
    
    return conv;
  }

Member Data Documentation

bool cmtool::CFAlgoChargeDistrib::_debug

private

Definition at line 65 of file CFAlgoChargeDistrib.h.

Referenced by SetDebug(), and TProfConvol().

TFile* cmtool::CMAlgoBase::_fout

protectedinherited

TFile pointer to an output file.

Definition at line 85 of file CMAlgoBase.h.

Referenced by cmtool::CMAlgoBase::CMAlgoBase(), and cmtool::CMAlgoBase::SetAnaFile().

bool cmtool::CFAlgoChargeDistrib::_verbose

private

Definition at line 64 of file CFAlgoChargeDistrib.h.

Referenced by Float(), SetVerbose(), and TProfConvol().

---

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

• larreco/v06_64_02/source/larreco/RecoAlg/CMTool/CMTAlgMatch/CFAlgoChargeDistrib.h
• larreco/v06_64_02/source/larreco/RecoAlg/CMTool/CMTAlgMatch/CFAlgoChargeDistrib.cxx