cmtool::CBAlgoAngleAlign Class Reference

#include "CBAlgoAngleAlign.h"

Inheritance diagram for cmtool::CBAlgoAngleAlign:

Public Member Functions
	CBAlgoAngleAlign ()
	Default constructor. More...
virtual	~CBAlgoAngleAlign ()
	Default destructor. More...
virtual bool	Bool (const ::cluster::ClusterParamsAlg &cluster1, const ::cluster::ClusterParamsAlg &cluster2)
	Overloaded (from CBoolAlgoBase) Bool function. More...
void	SetDebug (bool on)
	Method to set debug mode. More...
void	SetAllow180Ambig (bool on)
	Method to set whether you allow angles to match with +/- 180 deg difference. More...
void	SetAngleCut (double angle)
	Method to set cut value in degrees for angle compatibility test. More...
void	SetMinNHits (size_t n)
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 > &)
virtual void	EventEnd ()
virtual void	IterationBegin (const std::vector< cluster::ClusterParamsAlg > &)
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
size_t	_MinNHits
bool	_allow_180_ambig
	minimum number of hits for cluster to be considered More...
double	_MaxAngleSep
	hard shower-axis angle cutoff (only valid for _use_opening_angle==false) More...
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

Definition at line 26 of file CBAlgoAngleAlign.h.

Constructor & Destructor Documentation

cmtool::CBAlgoAngleAlign::CBAlgoAngleAlign

(

)

Default constructor.

Definition at line 7 of file CBAlgoAngleAlign.cxx.

References SetAllow180Ambig(), SetAngleCut(), SetDebug(), and SetMinNHits().

                                     : CBoolAlgoBase()
  {

    //this just sets default values
    SetDebug(true);
    SetAngleCut(10.); // in degrees
    SetAllow180Ambig(false);
    SetMinNHits(30);

  } //end constructor

virtual cmtool::CBAlgoAngleAlign::~CBAlgoAngleAlign ( )

inlinevirtual

Default destructor.

Definition at line 33 of file CBAlgoAngleAlign.h.

References Bool().

{};

Member Function Documentation

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

virtual

Overloaded (from CBoolAlgoBase) Bool function.

Reimplemented from cmtool::CBoolAlgoBase.

Definition at line 18 of file CBAlgoAngleAlign.cxx.

References _allow_180_ambig, _debug, _MaxAngleSep, _MinNHits, cmtool::CMAlgoBase::_verbose, and util::abs().

Referenced by ~CBAlgoAngleAlign().

  {

    double angle1 = cluster1.GetParams().angle_2d;
    double angle2 = cluster2.GetParams().angle_2d;
    size_t hits1 = cluster1.GetHitVector().size();
    size_t hits2 = cluster2.GetHitVector().size();

    //if don't make hit cut return aflse
    if ((hits1 < _MinNHits) or (hits2 < _MinNHits)) return false;

    if (_debug) {
      std::cout << "Cluster1:" << std::endl;
      std::cout << "\tAngle: " << angle1 << std::endl;
      std::cout << "\t Start: (" << cluster1.GetParams().start_point.w << ", "
                << cluster1.GetParams().start_point.t << ")" << std::endl;
      std::cout << "Cluster2:" << std::endl;
      std::cout << "\tAngle: " << angle2 << std::endl;
      std::cout << "\t Start: (" << cluster2.GetParams().start_point.w << ", "
                << cluster2.GetParams().start_point.t << ")" << std::endl;
      std::cout << std::endl;
    }

    //for some reason angles are frequently -999.99.
    //if either angle is this, clearly the cluster 2d angle is not well defined
    //and this algorithm does not apply
    if (angle1 < -998 || angle2 < -998) return false;

    bool compatible = false;

    //if you don't care if clusters have been reconstructed backwards
    if (_allow_180_ambig)
      compatible =
        (abs(angle1 - angle2) < _MaxAngleSep || abs(angle1 - angle2 - 180) < _MaxAngleSep ||
         abs(angle1 - angle2 + 180) < _MaxAngleSep);
    else
      compatible = (abs(angle1 - angle2) < _MaxAngleSep);

    if (_verbose) {
      if (compatible) std::cout << "These two clusters are compatible in angle." << std::endl;
    }

    return compatible;

  } // end Merge function

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

inlinevirtualinherited

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

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

Definition at line 45 of file CMAlgoBase.h.

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

{}

virtual void cmtool::CMAlgoBase::EventEnd ( )

inlinevirtualinherited

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

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

Definition at line 50 of file CMAlgoBase.h.

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

{}

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

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::CPAlgoArray, and cmtool::CBAlgoArray.

Definition at line 57 of file CMAlgoBase.h.

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

{}

virtual void cmtool::CMAlgoBase::IterationEnd ( )

inlinevirtualinherited

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

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

Definition at line 62 of file CMAlgoBase.h.

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

{}

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::CPAlgoArray, cmtool::CBAlgoArray, cmtool::CBAlgoPolyShortestDist, cmtool::CBAlgoStartTrack, cmtool::CBAlgoProhibitAllTracks, cmtool::CBAlgoOutOfConeSeparate, cmtool::CBAlgoAngleSeparate, cmtool::CBAlgoMergeTinyWithBig, cmtool::CFAlgoShowerCompat, cmtool::CBAlgoStartNearEnd, cmtool::CFAlgoTimeOverlap, cmtool::CBAlgoProhibitBigClusters, cmtool::CPAlgoIgnoreTracks, cmtool::CFAlgoQRatio, cmtool::CFAlgoZOverlap, cmtool::CBAlgoCenterOfMass, and cmtool::CBAlgoCenterOfMassSmall.

Definition at line 69 of file CMAlgoBase.h.

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

{}

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::CPAlgoArray, cmtool::CBAlgoPolyShortestDist, cmtool::CBAlgoStartTrack, cmtool::CBAlgoProhibitAllTracks, cmtool::CBAlgoOutOfConeSeparate, cmtool::CBAlgoMergeTinyWithBig, cmtool::CFAlgoShowerCompat, cmtool::CBAlgoAngleSeparate, cmtool::CBAlgoProhibitBigClusters, cmtool::CPAlgoIgnoreTracks, cmtool::CFAlgoTimeOverlap, cmtool::CFAlgoQRatio, cmtool::CFAlgoZOverlap, cmtool::CBAlgoStartNearEnd, cmtool::CBAlgoCenterOfMass, cmtool::CBAlgoCenterOfMassSmall, 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::CBAlgoAngleAlign::SetAllow180Ambig ( bool  on )

inline

Method to set whether you allow angles to match with +/- 180 deg difference.

Definition at line 43 of file CBAlgoAngleAlign.h.

References _allow_180_ambig.

Referenced by CBAlgoAngleAlign().

{ _allow_180_ambig = on; }

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

inlineinherited

Setter function for an output plot TFile pointer.

Definition at line 72 of file CMAlgoBase.h.

References cmtool::CMAlgoBase::_fout.

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

{ _fout = fout; }

void cmtool::CBAlgoAngleAlign::SetAngleCut ( double  angle )

inline

Method to set cut value in degrees for angle compatibility test.

Definition at line 46 of file CBAlgoAngleAlign.h.

References _MaxAngleSep.

Referenced by CBAlgoAngleAlign().

{ _MaxAngleSep = angle; }

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

inline

Method to set debug mode.

Definition at line 40 of file CBAlgoAngleAlign.h.

References _debug.

Referenced by CBAlgoAngleAlign().

{ _debug = on; }

void cmtool::CBAlgoAngleAlign::SetMinNHits ( size_t  n )

inline

Definition at line 48 of file CBAlgoAngleAlign.h.

References _MinNHits, and n.

Referenced by CBAlgoAngleAlign().

{ _MinNHits = n; }

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

inlinevirtualinherited

Setter function for verbosity.

Reimplemented in cmtool::CBAlgoArray, and cmtool::CFAlgoTimeOverlap.

Definition at line 75 of file CMAlgoBase.h.

References cmtool::CMAlgoBase::_verbose.

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

{ _verbose = doit; }

Member Data Documentation

bool cmtool::CBAlgoAngleAlign::_allow_180_ambig

protected

minimum number of hits for cluster to be considered

bool to allow "backwards" clusters (swapped start/end points) to still match in angle, even though they are 180 degrees apart only valid for _use_opening_angle==false

Definition at line 57 of file CBAlgoAngleAlign.h.

Referenced by Bool(), and SetAllow180Ambig().

bool cmtool::CBAlgoAngleAlign::_debug

protected

Definition at line 51 of file CBAlgoAngleAlign.h.

Referenced by Bool(), and SetDebug().

TFile* cmtool::CMAlgoBase::_fout

protectedinherited

TFile pointer to an output file.

Definition at line 79 of file CMAlgoBase.h.

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

double cmtool::CBAlgoAngleAlign::_MaxAngleSep

protected

hard shower-axis angle cutoff (only valid for _use_opening_angle==false)

Definition at line 60 of file CBAlgoAngleAlign.h.

Referenced by Bool(), and SetAngleCut().

size_t cmtool::CBAlgoAngleAlign::_MinNHits

protected

Definition at line 52 of file CBAlgoAngleAlign.h.

Referenced by Bool(), and SetMinNHits().

bool cmtool::CMAlgoBase::_verbose

protectedinherited

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

Definition at line 82 of file CMAlgoBase.h.

Referenced by Bool(), cmtool::CBAlgoAngleCompat::Bool(), cmtool::CBAlgoPolyOverlap::Bool(), cmtool::CBAlgoOutOfConeSeparate::Bool(), cmtool::CBAlgoAngleSeparate::Bool(), cmtool::CBAlgoCenterOfMassSmall::Bool(), cmtool::CBAlgoCenterOfMass::Bool(), cmtool::CBAlgoStartNearEnd::Bool(), cmtool::CBAlgoProhibitAllTracks::Bool(), cmtool::CMAlgoBase::CMAlgoBase(), cmtool::CFAlgoZOverlap::Float(), cmtool::CFAlgoQRatio::Float(), cmtool::CMAlgoBase::SetVerbose(), cmtool::CBAlgoCenterOfMassSmall::ShortestDistanceSquared(), and cmtool::CBAlgoCenterOfMass::ShortestDistanceSquared().

---

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

• larreco/v09_25_00/source/larreco/RecoAlg/CMTool/CMTAlgMerge/CBAlgoAngleAlign.h
• larreco/v09_25_00/source/larreco/RecoAlg/CMTool/CMTAlgMerge/CBAlgoAngleAlign.cxx