cmtool::CBAlgoAngleIncompat Class Reference

#include "CBAlgoAngleIncompat.h"

Inheritance diagram for cmtool::CBAlgoAngleIncompat:

Public Member Functions
	CBAlgoAngleIncompat ()
	Default constructor. More...
virtual	~CBAlgoAngleIncompat ()
	Default destructor. More...
virtual bool	Bool (const ::cluster::ClusterParamsAlg &cluster1, const ::cluster::ClusterParamsAlg &cluster2)
void	SetAllow180Ambig (bool on)
void	SetAngleCut (double angle)
void	SetUseOpeningAngle (bool on)
void	SetMinHits (int n)
void	SetMinLength (double l)
void	SetDebug (bool on)
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
bool	_debug
bool	_allow_180_ambig
double	_max_allowed_2D_angle_diff
double	_min_length
bool	_use_opening_angle
size_t	_minHits
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...

Detailed Description

User implementation for CBoolAlgoBase class doxygen documentation!

Definition at line 26 of file CBAlgoAngleIncompat.h.

Constructor & Destructor Documentation

cmtool::CBAlgoAngleIncompat::CBAlgoAngleIncompat

(

)

Default constructor.

Definition at line 9 of file CBAlgoAngleIncompat.cxx.

References SetAllow180Ambig(), SetAngleCut(), SetDebug(), SetMinHits(), SetMinLength(), and SetUseOpeningAngle().

                                           : CBoolAlgoBase()
  //-------------------------------------------------------
  {
    SetAngleCut(30.);

    SetMinHits(0);

    SetAllow180Ambig(false);

    SetUseOpeningAngle(false);

    SetMinLength(20);

    SetDebug(false);
  }

virtual cmtool::CBAlgoAngleIncompat::~CBAlgoAngleIncompat ( )

inlinevirtual

Default destructor.

Definition at line 34 of file CBAlgoAngleIncompat.h.

References Bool().

{};

Member Function Documentation

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

virtual

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

Reimplemented from cmtool::CBoolAlgoBase.

Definition at line 26 of file CBAlgoAngleIncompat.cxx.

References _allow_180_ambig, _debug, _max_allowed_2D_angle_diff, _min_length, _minHits, _use_opening_angle, and min.

Referenced by ~CBAlgoAngleIncompat().

  {
    //if either cluster is too small, do not prohibit them
    if (cluster1.GetNHits() < _minHits || cluster2.GetNHits() < _minHits)
      return false;
    
    //if either cluster is too short, do not prohibit them
    if (cluster1.GetParams().length < _min_length ||
        cluster2.GetParams().length < _min_length)
      return false;

    
    double angle1 = cluster1.GetParams().angle_2d;
    double angle2 = cluster2.GetParams().angle_2d;

    if(angle1 < -998 || angle2 < -998)
      return false;

    bool compatible = false;
    
    double my_cut_value = _max_allowed_2D_angle_diff;

    //if using opening angle, have angle cutoff be the smaller of the two opening angles
    if(_use_opening_angle) 
      my_cut_value = std::min(cluster1.GetParams().opening_angle, cluster2.GetParams().opening_angle);
    
    //if you don't care if clusters have been reconstructed backwards
    if(_allow_180_ambig)
      compatible = ( abs(angle1-angle2) < my_cut_value ||
                     abs(angle1-angle2-180) < my_cut_value ||
                     abs(angle1-angle2+180) < my_cut_value   );
    else
      compatible = ( abs(angle1-angle2)     < my_cut_value );
    

    if(_debug){
      if(!compatible)
        
        std::cout<<"CBAlgoAngleIncompat is PROHIBITING clusters with angles "
                 <<angle1<<" and "<<angle2<<std::endl;

    }



    return !compatible;
  }

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

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::CBAlgoAngleIncompat::SetAllow180Ambig ( bool  on )

inline

Definition at line 43 of file CBAlgoAngleIncompat.h.

References _allow_180_ambig.

Referenced by CBAlgoAngleIncompat().

{ _allow_180_ambig = on; }

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::CBAlgoAngleIncompat::SetAngleCut ( double  angle )

inline

Definition at line 45 of file CBAlgoAngleIncompat.h.

References _max_allowed_2D_angle_diff.

Referenced by CBAlgoAngleIncompat().

{ _max_allowed_2D_angle_diff = angle; }

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

inline

Definition at line 53 of file CBAlgoAngleIncompat.h.

References _debug.

Referenced by CBAlgoAngleIncompat().

{ _debug = on; }

void cmtool::CBAlgoAngleIncompat::SetMinHits ( int  n )

inline

Definition at line 49 of file CBAlgoAngleIncompat.h.

References _minHits, and n.

Referenced by CBAlgoAngleIncompat().

{ _minHits = n; }

void cmtool::CBAlgoAngleIncompat::SetMinLength ( double  l )

inline

Definition at line 51 of file CBAlgoAngleIncompat.h.

References _min_length.

Referenced by CBAlgoAngleIncompat().

{ _min_length = l; }

void cmtool::CBAlgoAngleIncompat::SetUseOpeningAngle ( bool  on )

inline

Definition at line 47 of file CBAlgoAngleIncompat.h.

References _use_opening_angle.

Referenced by CBAlgoAngleIncompat().

{ _use_opening_angle = on; }

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::CBAlgoAngleIncompat::_allow_180_ambig

protected

Definition at line 58 of file CBAlgoAngleIncompat.h.

Referenced by Bool(), and SetAllow180Ambig().

bool cmtool::CBAlgoAngleIncompat::_debug

protected

Definition at line 57 of file CBAlgoAngleIncompat.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().

double cmtool::CBAlgoAngleIncompat::_max_allowed_2D_angle_diff

protected

Definition at line 59 of file CBAlgoAngleIncompat.h.

Referenced by Bool(), and SetAngleCut().

double cmtool::CBAlgoAngleIncompat::_min_length

protected

Definition at line 60 of file CBAlgoAngleIncompat.h.

Referenced by Bool(), and SetMinLength().

size_t cmtool::CBAlgoAngleIncompat::_minHits

protected

Definition at line 62 of file CBAlgoAngleIncompat.h.

Referenced by Bool(), and SetMinHits().

bool cmtool::CBAlgoAngleIncompat::_use_opening_angle

protected

Definition at line 61 of file CBAlgoAngleIncompat.h.

Referenced by Bool(), and SetUseOpeningAngle().

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(), cmtool::CBAlgoPolyOverlap::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::CFAlgoZOverlap::Float(), cmtool::CFAlgoQRatio::Float(), cmtool::CFAlgoStartPointMatch::Float(), cmtool::CMAlgoBase::SetVerbose(), cmtool::CBAlgoShortestDist::ShortestDistanceSquared(), cmtool::CBAlgoShortestDistSmallCluster::ShortestDistanceSquared(), cmtool::CBAlgoCenterOfMass::ShortestDistanceSquared(), and cmtool::CBAlgoCenterOfMassSmall::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/CBAlgoAngleIncompat.h
• /cvmfs/larsoft.opensciencegrid.org/products/larreco/v07_10_02/source/larreco/RecoAlg/CMTool/CMTAlgMerge/CBAlgoAngleIncompat.cxx