cmtool::CFAlgoTimeOverlap Class Reference

#include "CFAlgoTimeOverlap.h"

Inheritance diagram for cmtool::CFAlgoTimeOverlap:

Public Member Functions
	CFAlgoTimeOverlap ()
	Default constructor. More...
virtual	~CFAlgoTimeOverlap ()
	Default destructor. More...
virtual float	Float (const std::vector< const cluster::ClusterParamsAlg * > &clusters)
void	SetStartTimeCut (float start_time)
void	SetRatioCut (float ratio)
void	SetDebug (bool debug)
void	SetVerbose (bool verbose)
	Setter function for verbosity. More...
void	RequireThreePlanes (bool doit)
virtual void	Report ()
virtual void	Reset ()
	Function to reset the algorithm instance called within CMergeManager/CMatchManager's Reset() ... maybe implemented via child class. 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
float	_time_ratio_cut
float	_start_time_cut
bool	_debug
bool	_verbose
bool	_require_3planes
TFile *	_fout
	TFile pointer to an output file. More...

Detailed Description

User implementation for CFloatAlgoBase class doxygen documentation!

Definition at line 25 of file CFAlgoTimeOverlap.h.

Constructor & Destructor Documentation

cmtool::CFAlgoTimeOverlap::CFAlgoTimeOverlap

(

)

Default constructor.

Definition at line 9 of file CFAlgoTimeOverlap.cxx.

References RequireThreePlanes(), SetDebug(), SetRatioCut(), SetStartTimeCut(), and SetVerbose().

                                       : CFloatAlgoBase()
  //-------------------------------------------------------
  {
    SetRatioCut(0.001) ; //(0.095) ;  
    SetStartTimeCut(10) ;
    SetDebug(false) ;
    SetVerbose(false) ;
    RequireThreePlanes(true) ;
  }

virtual cmtool::CFAlgoTimeOverlap::~CFAlgoTimeOverlap ( )

inlinevirtual

Default destructor.

Definition at line 33 of file CFAlgoTimeOverlap.h.

References Float().

{};

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::CFAlgoTimeOverlap::Float ( const std::vector< const cluster::ClusterParamsAlg * > &  clusters )

virtual

This algorithm calculates the difference between start and end times for merged clusters, and compares across planes to form matches.

Reimplemented from cmtool::CFloatAlgoBase.

Definition at line 27 of file CFAlgoTimeOverlap.cxx.

References _debug, _require_3planes, _start_time_cut, _time_ratio_cut, and _verbose.

Referenced by ~CFAlgoTimeOverlap().

  {
    
    // 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(_require_3planes && clusters.size()==2) return -1;
    // Code-block by Kazu ends

    double ratio               = 1;
    double time_difference     = 0;
    double max_time_difference = 0;
    double max_charge          = 0;
    double charge_ratio        = 1;     

    //Preserve location in time space. Cut clusters that have similar time differences,
    // but hit wires at very different times. 
    double start_t      = 0;
    double end_t        = 0;
    double prev_start_t = 0;
    double prev_end_t   = 0;

    double max_hits_1 = 0;
    double max_hits_2 = 0;
    
    for(auto const& c : clusters){
      
      auto charge = c->GetParams().sum_charge ;         
      
      time_difference  = c->GetParams().start_point.t - c->GetParams().end_point.t ; 
      
      if(time_difference < 0) 
        time_difference *= -1; 
      
      if(max_time_difference < time_difference)
        max_time_difference = time_difference ;
      
      if(max_charge < charge)
        max_charge = charge ;

      if(c->GetParams().N_Hits > max_hits_1) {
        max_hits_2 = max_hits_1;
        max_hits_1 = c->GetParams().N_Hits;
      }else if(c->GetParams().N_Hits > max_hits_2) 
        max_hits_2 = c->GetParams().N_Hits;
      
    }

    ratio        = 1;
    charge_ratio = 1;
    for(size_t c_index=0; c_index<clusters.size(); ++c_index) {
      auto const& c = clusters[c_index];
      
      double length = c->GetParams().length ;
      //auto charge = c->GetParams().sum_charge ;               
      //Order hits from most to least     
      //SetMaxMiddleMin(hits_0,hits_1,hits_2,max_hits,middle_hits,min_hits);
      
      //Make start_t always smaller
      if(c->GetParams().start_point.t > c->GetParams().end_point.t){
        start_t = c->GetParams().end_point.t   ;
        end_t   = c->GetParams().start_point.t ;
      }
      else{
        start_t = c->GetParams().start_point.t ;
        end_t   = c->GetParams().end_point.t   ;
      }  
      
      if(prev_start_t ==0)
        prev_start_t = start_t ;
      if(prev_end_t ==0)
        prev_end_t = end_t ;
      
      time_difference  = end_t - start_t ; 
      
      ratio *= time_difference/max_time_difference ;
      
      charge_ratio = max_hits_2 / max_hits_1;// charge/max_charge ;

      if(c_index==(clusters.size()-1))
        ratio *= charge_ratio ;
      
      //If current cluster's start time is not within some range of the previous cluster's start time,
      //modify ratio to disallow matching
      
      if( (start_t > (prev_start_t - _start_time_cut) && start_t < (prev_start_t + _start_time_cut)) 
          || (end_t > (prev_end_t - _start_time_cut) && end_t < (prev_end_t + _start_time_cut) )
          || (length >25 && start_t >(prev_start_t - 2*_start_time_cut) && start_t < (prev_start_t + 2*_start_time_cut) ) )
        ratio *= 1;
      else      
        ratio*= 0.001;
      
      prev_start_t = start_t ;
      prev_end_t   = end_t ;    
      
      if( _debug && c_index==(clusters.size()-1) && ratio > _time_ratio_cut ){
        std::cout<<"\nPLANE: "<<c->Plane() ;
        std::cout<<"\nStart point: "<<start_t<<std::endl;
        std::cout<<"End Point: "<<end_t  <<std::endl;
        //      std::cout<<"Previous start time: "<<prev_start_t<<std::endl;
        std::cout<<"Time diff: "<<time_difference<<std::endl;
        std::cout<<"Max time diff: "<<max_time_difference<<std::endl;
        std::cout<<"Ratio for each cluster: "<<ratio<<std::endl;
        //                              std::cout<<"Charge: "<<charge<<std::endl;
        std::cout<<"Charge Ratio: "<<charge_ratio<<std::endl;
        //std::cout<<"Hits are: "<<min_hits<<", "<<middle_hits<<", "<<max_hits<<std::endl;
        //                              std::cout<<"Adjusted Charge Ratio: "<<adjusted_charge_ratio<<std::endl;
        std::cout<<"Length and Width: "<<c->GetParams().length<<", "<<c->GetParams().width<<std::endl;
      } 
      
    }
    
    if(_verbose && ratio> _time_ratio_cut)
      std::cout<<"**************************FOUND A MATCH . ratio is: "<<ratio<<"\n\n\n"<<std::endl;
    
    return (ratio > _time_ratio_cut ? ratio : -1 ); 
    
   }

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::CFAlgoTimeOverlap::Report ( )

virtual

Optional function: called after Bool() function is called for all possible cluster pairs by CMergeManager/CMatchManager IFF run with verbosity level kPerIteration. Maybe useful for debugging.

Reimplemented from cmtool::CMAlgoBase.

Definition at line 237 of file CFAlgoTimeOverlap.cxx.

Referenced by RequireThreePlanes().

  {
  }

void cmtool::CFAlgoTimeOverlap::RequireThreePlanes ( bool  doit )

inline

Definition at line 54 of file CFAlgoTimeOverlap.h.

References _require_3planes, Report(), and Reset().

Referenced by CFAlgoTimeOverlap().

{ _require_3planes = doit; }

void cmtool::CFAlgoTimeOverlap::Reset ( )

virtual

Function to reset the algorithm instance called within CMergeManager/CMatchManager's Reset() ... maybe implemented via child class.

Reimplemented from cmtool::CMAlgoBase.

Definition at line 20 of file CFAlgoTimeOverlap.cxx.

Referenced by RequireThreePlanes().

  {

  }

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::CFAlgoTimeOverlap::SetDebug ( bool  debug )

inline

Definition at line 50 of file CFAlgoTimeOverlap.h.

References _debug, and tca::debug.

Referenced by CFAlgoTimeOverlap().

{ _debug = debug ; }

void cmtool::CFAlgoTimeOverlap::SetRatioCut ( float  ratio )

inline

Definition at line 42 of file CFAlgoTimeOverlap.h.

References _time_ratio_cut.

Referenced by CFAlgoTimeOverlap().

{ _time_ratio_cut = ratio ; } 

void cmtool::CFAlgoTimeOverlap::SetStartTimeCut ( float  start_time )

inline

Definition at line 40 of file CFAlgoTimeOverlap.h.

References _start_time_cut.

Referenced by CFAlgoTimeOverlap().

{ _start_time_cut = start_time ; } 

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

inlinevirtual

Setter function for verbosity.

Reimplemented from cmtool::CMAlgoBase.

Definition at line 52 of file CFAlgoTimeOverlap.h.

References _verbose.

Referenced by CFAlgoTimeOverlap().

{ _verbose = verbose ; }

Member Data Documentation

bool cmtool::CFAlgoTimeOverlap::_debug

protected

Definition at line 63 of file CFAlgoTimeOverlap.h.

Referenced by Float(), and SetDebug().

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::CFAlgoTimeOverlap::_require_3planes

protected

Definition at line 65 of file CFAlgoTimeOverlap.h.

Referenced by Float(), and RequireThreePlanes().

float cmtool::CFAlgoTimeOverlap::_start_time_cut

protected

Definition at line 62 of file CFAlgoTimeOverlap.h.

Referenced by Float(), and SetStartTimeCut().

float cmtool::CFAlgoTimeOverlap::_time_ratio_cut

protected

Definition at line 61 of file CFAlgoTimeOverlap.h.

Referenced by Float(), and SetRatioCut().

bool cmtool::CFAlgoTimeOverlap::_verbose

protected

Definition at line 64 of file CFAlgoTimeOverlap.h.

Referenced by Float(), and SetVerbose().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larreco/v07_10_02/source/larreco/RecoAlg/CMTool/CMTAlgMatch/CFAlgoTimeOverlap.h
• /cvmfs/larsoft.opensciencegrid.org/products/larreco/v07_10_02/source/larreco/RecoAlg/CMTool/CMTAlgMatch/CFAlgoTimeOverlap.cxx