cmtool::CBAlgoPolyOverlap Class Reference

#include "CBAlgoPolyOverlap.h"

Inheritance diagram for cmtool::CBAlgoPolyOverlap:

Public Member Functions
	CBAlgoPolyOverlap ()
	Default constructor. More...
virtual	~CBAlgoPolyOverlap ()
	Default destructor. More...
virtual bool	Bool (const ::cluster::ClusterParamsAlg &cluster1, const ::cluster::ClusterParamsAlg &cluster2)
void	SetDebug (bool debug)
void	SetMinNumHits (size_t nhits)
void	reconfigure ()
	Method to re-configure the instance. More...
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 ()
virtual void	Report ()
void	SetAnaFile (TFile *fout)
	Setter function for an output plot TFile pointer. More...
virtual void	SetVerbose (bool doit=true)
	Setter function for verbosity. More...

Protected Attributes
TFile *	_fout
	TFile pointer to an output file. More...
bool	_verbose
	Boolean to choose verbose mode. Turned on if CMergeManager/CMatchManager's verbosity level is >= kPerMerging. More...

Private Attributes
bool	_debug
size_t	_min_hits

Detailed Description

Definition at line 27 of file CBAlgoPolyOverlap.h.

Constructor & Destructor Documentation

cmtool::CBAlgoPolyOverlap::CBAlgoPolyOverlap

(

)

Default constructor.

Definition at line 8 of file CBAlgoPolyOverlap.cxx.

References reconfigure(), SetDebug(), and SetMinNumHits().

                                       : CBoolAlgoBase()
  {
    // Nothing to be done in the base class
    SetDebug(false);
    SetMinNumHits(0);

    this->reconfigure();
  }

virtual cmtool::CBAlgoPolyOverlap::~CBAlgoPolyOverlap ( )

inlinevirtual

Default destructor.

Definition at line 35 of file CBAlgoPolyOverlap.h.

References Bool().

{};

Member Function Documentation

bool cmtool::CBAlgoPolyOverlap::Bool ( const ::cluster::ClusterParamsAlg &  cluster1, const ::cluster::ClusterParamsAlg &  cluster2  )

virtual

Core function: given the ClusterParamsAlg input, return whether a cluster should be merged or not.

Reimplemented from cmtool::CBoolAlgoBase.

Definition at line 25 of file CBAlgoPolyOverlap.cxx.

References _debug, _min_hits, cmtool::CMAlgoBase::_verbose, and n.

Referenced by ~CBAlgoPolyOverlap().

  {

    if( (cluster1.GetParams().N_Hits < _min_hits) ||
        (cluster2.GetParams().N_Hits < _min_hits) )
      return false;

    //if either has < 3 sides do not merge!
    if ( (cluster1.GetParams().PolyObject.Size() < 2) or
         (cluster2.GetParams().PolyObject.Size() < 2) ){
      return false;
    }
    if (_debug and cluster1.GetParams().N_Hits > 10 and cluster2.GetParams().N_Hits > 10) {
      std::cout << "Cluster 1:" << std::endl;
      std::cout << "\tN_Hits: " << cluster1.GetParams().N_Hits << std::endl;
      std::cout << "\tN Sides:" << cluster1.GetParams().PolyObject.Size() << std::endl;
      for (unsigned int n=0; n < cluster1.GetParams().PolyObject.Size(); n++)
        std::cout << "\t\t\t(" << cluster1.GetParams().PolyObject.Point(n).first << ", "
                  << cluster1.GetParams().PolyObject.Point(n).second << ")" << std::endl;
      std::cout << "Cluster 2:" << std::endl;
      std::cout << "\tN_Hits: " << cluster2.GetParams().N_Hits << std::endl;
      std::cout << "\tN Sides:" << cluster2.GetParams().PolyObject.Size() << std::endl;
      for (unsigned int n=0; n < cluster2.GetParams().PolyObject.Size(); n++)
        std::cout << "\t\t\t(" << cluster2.GetParams().PolyObject.Point(n).first << ", "
                  << cluster2.GetParams().PolyObject.Point(n).second << ")" << std::endl;
    }

    //if the two polygons overlap even partially
    //then return true! --> MERGE!
    if ( cluster1.GetParams().PolyObject.PolyOverlapSegments(cluster2.GetParams().PolyObject) ){
      if (_verbose) { std::cout << "Overlap...merging!" << std::endl; }
      return true;
    }
    return false;

  }

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;}

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::CBAlgoPolyOverlap::reconfigure

(

)

Method to re-configure the instance.

Definition at line 18 of file CBAlgoPolyOverlap.cxx.

Referenced by CBAlgoPolyOverlap(), and SetMinNumHits().

                                     {

    //not sure what needs to be reset/reconfigured for this algo
    
  }//end reconfigure function

virtual void cmtool::CMAlgoBase::Report ( )

inlinevirtualinherited

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 in cmtool::CFAlgoArray, cmtool::CPAlgoArray, cmtool::CBAlgoArray, cmtool::CBAlgoStartTrack, cmtool::CBAlgoPolyShortestDist, cmtool::CBAlgoProhibitAllTracks, cmtool::CBAlgoOutOfConeSeparate, cmtool::CBAlgoTrackSeparate, cmtool::CBAlgoAngleSeparate, cmtool::CFAlgo3DAngle, cmtool::CBAlgoMergeTinyWithBig, cmtool::CFAlgoShowerCompat, cmtool::CFAlgoTimeOverlap, cmtool::CBAlgoStartNearEnd, cmtool::CFAlgoVolumeOverlap, cmtool::CFAlgoWireOverlap, cmtool::CBAlgoProhibitBigClusters, cmtool::CFAlgoStartPointCompat, cmtool::CFAlgoStartPointMatch, cmtool::CFAlgoStartTimeCompat, cmtool::CFAlgoChargeDistrib, cmtool::CFAlgoQRatio, cmtool::CFAlgoZOverlap, cmtool::CPAlgoIgnoreTracks, cmtool::CBAlgoCenterOfMass, cmtool::CBAlgoCenterOfMassSmall, and cmtool::CFAlgoTimeProf.

Definition at line 73 of file CMAlgoBase.h.

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

    {return;}

virtual void cmtool::CMAlgoBase::Reset ( )

inlinevirtualinherited

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

Reimplemented in cmtool::CBAlgoArray, cmtool::CFAlgoArray, cmtool::CPAlgoArray, cmtool::CBAlgoStartTrack, cmtool::CBAlgoPolyShortestDist, cmtool::CBAlgoProhibitAllTracks, cmtool::CBAlgoOutOfConeSeparate, cmtool::CBAlgoTrackSeparate, cmtool::CBAlgoMergeTinyWithBig, cmtool::CFAlgoShowerCompat, cmtool::CFAlgo3DAngle, cmtool::CFAlgoTimeOverlap, cmtool::CBAlgoAngleSeparate, cmtool::CFAlgoVolumeOverlap, cmtool::CFAlgoWireOverlap, cmtool::CBAlgoProhibitBigClusters, cmtool::CFAlgoStartPointCompat, cmtool::CFAlgoStartPointMatch, cmtool::CFAlgoStartTimeCompat, cmtool::CFAlgoChargeDistrib, cmtool::CFAlgoQRatio, cmtool::CFAlgoZOverlap, cmtool::CPAlgoIgnoreTracks, cmtool::CBAlgoStartNearEnd, cmtool::CBAlgoCenterOfMass, cmtool::CBAlgoCenterOfMassSmall, cmtool::CFAlgoTimeProf, cmtool::CBAlgoFake, and cmtool::CBAlgoMergeAll.

Definition at line 40 of file CMAlgoBase.h.

Referenced by cmtool::CMergeManager::Reset(), cmtool::CMatchManager::Reset(), and cmtool::CMManagerBase::Reset().

{}

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

inline

Definition at line 44 of file CBAlgoPolyOverlap.h.

References _debug, and tca::debug.

Referenced by CBAlgoPolyOverlap().

{ _debug = debug; }

void cmtool::CBAlgoPolyOverlap::SetMinNumHits ( size_t  nhits )

inline

Definition at line 47 of file CBAlgoPolyOverlap.h.

References _min_hits, and reconfigure().

Referenced by CBAlgoPolyOverlap().

{ _min_hits = nhits; }

virtual void cmtool::CMAlgoBase::SetVerbose ( bool  doit = true )

inlinevirtualinherited

Setter function for verbosity.

Reimplemented in cmtool::CBAlgoArray, cmtool::CFAlgoChargeDistrib, cmtool::CFAlgoVolumeOverlap, cmtool::CFAlgoWireOverlap, cmtool::CFAlgoStartPointCompat, cmtool::CFAlgoStartTimeCompat, cmtool::CFAlgoTimeOverlap, cmtool::CBAlgoStartInCone, cmtool::CBAlgoShortestDistNonEndpoint, and cmtool::CBAlgoTrackSeparate.

Definition at line 80 of file CMAlgoBase.h.

References cmtool::CMAlgoBase::_verbose.

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

{ _verbose = doit; }

Member Data Documentation

bool cmtool::CBAlgoPolyOverlap::_debug

private

Definition at line 54 of file CBAlgoPolyOverlap.h.

Referenced by Bool(), 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().

size_t cmtool::CBAlgoPolyOverlap::_min_hits

private

Definition at line 55 of file CBAlgoPolyOverlap.h.

Referenced by Bool(), and SetMinNumHits().

bool cmtool::CMAlgoBase::_verbose

protectedinherited

Boolean to choose verbose mode. Turned on if CMergeManager/CMatchManager's verbosity level is >= kPerMerging.

Definition at line 88 of file CMAlgoBase.h.

Referenced by cmtool::CBAlgoAngleAlign::Bool(), cmtool::CBAlgoAngleCompat::Bool(), cmtool::CBAlgoShortestDistSmallCluster::Bool(), cmtool::CBAlgoShortestDist::Bool(), cmtool::CBAlgoOutOfConeSeparate::Bool(), Bool(), cmtool::CBAlgoAngleSeparate::Bool(), cmtool::CBAlgoCenterOfMassSmall::Bool(), cmtool::CBAlgoCenterOfMass::Bool(), cmtool::CBAlgoStartInPoly::Bool(), cmtool::CBAlgoStartNearEnd::Bool(), cmtool::CBAlgoProhibitAllTracks::Bool(), cmtool::CBAlgoShortestDist::CBAlgoShortestDist(), cmtool::CBAlgoShortestDistSmallCluster::CBAlgoShortestDistSmallCluster(), cmtool::CMAlgoBase::CMAlgoBase(), cmtool::CFAlgoQRatio::Float(), cmtool::CFAlgoZOverlap::Float(), cmtool::CFAlgoStartPointMatch::Float(), cmtool::CMAlgoBase::SetVerbose(), cmtool::CBAlgoShortestDist::ShortestDistanceSquared(), cmtool::CBAlgoShortestDistSmallCluster::ShortestDistanceSquared(), cmtool::CBAlgoCenterOfMassSmall::ShortestDistanceSquared(), and cmtool::CBAlgoCenterOfMass::ShortestDistanceSquared().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larreco/v07_10_02/source/larreco/RecoAlg/CMTool/CMTAlgMerge/CBAlgoPolyOverlap.h
• /cvmfs/larsoft.opensciencegrid.org/products/larreco/v07_10_02/source/larreco/RecoAlg/CMTool/CMTAlgMerge/CBAlgoPolyOverlap.cxx