cmtool::CBAlgoAngleCompat Class Reference

#include "CBAlgoAngleCompat.h"

Inheritance diagram for cmtool::CBAlgoAngleCompat:

Public Member Functions
	CBAlgoAngleCompat ()
	Default constructor. More...
virtual	~CBAlgoAngleCompat ()
	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	SetUseOpeningAngle (bool on)
	Method to set angle cut value to be based on opening angle. More...
void	SetMinHits (size_t n)
	Set Minimum Number of Hits to consider Cluster. 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
bool	_debug
bool	_allow_180_ambig
	bool to suppress lots of output if you want More...
double	_max_allowed_2D_angle_diff
	hard shower-axis angle cutoff (only valid for _use_opening_angle==false) More...
bool	_use_opening_angle
size_t	_minHits
TH1F *	angle_dist_histo
	Min Number of hits for cluster to be considered. 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

User defined class CBAlgoAngleCompat ... these comments are used to generate doxygen documentation!

Definition at line 26 of file CBAlgoAngleCompat.h.

Constructor & Destructor Documentation

cmtool::CBAlgoAngleCompat::CBAlgoAngleCompat

(

)

Default constructor.

Definition at line 8 of file CBAlgoAngleCompat.cxx.

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

                                       : CBoolAlgoBase() {

    //this just sets default values

    SetDebug(true);

    SetAngleCut(30.); // in degrees

    SetMinHits(0);
    
    SetAllow180Ambig(false);

    SetUseOpeningAngle(false);

    //    angle_dist_histo = 0;

    //    angle_dist_histo = new TH1F("angle_dist_histo","Cluster Angle Differences",100,-360,360);

  } //end constructor

virtual cmtool::CBAlgoAngleCompat::~CBAlgoAngleCompat ( )

inlinevirtual

Default destructor.

Definition at line 34 of file CBAlgoAngleCompat.h.

References Bool().

{};

Member Function Documentation

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

virtual

Overloaded (from CBoolAlgoBase) Bool function.

Reimplemented from cmtool::CBoolAlgoBase.

Definition at line 28 of file CBAlgoAngleCompat.cxx.

References _allow_180_ambig, _debug, _max_allowed_2D_angle_diff, _minHits, _use_opening_angle, cmtool::CMAlgoBase::_verbose, and min.

Referenced by ~CBAlgoAngleCompat().

  {
    
    //if number of hits not large enough skip
    if ( _minHits and ((cluster1.GetHitVector().size() < _minHits) or (cluster2.GetHitVector().size() < _minHits)) ) {
      return false;
    }

    //pretty sure we don't need conversion factors here. 
    //already in cm/cm units, degrees? need to check that
    double angle1 = cluster1.GetParams().angle_2d;// * _time_2_cm / _wire_2_cm;
    double angle2 = cluster2.GetParams().angle_2d;// * _time_2_cm / _wire_2_cm;

    double w_start1 = cluster1.GetParams().start_point.w;// * _wire_2_cm;
    double t_start1 = cluster1.GetParams().start_point.t;// * _time_2_cm;
    double w_start2 = cluster2.GetParams().start_point.w;// * _wire_2_cm;
    double t_start2 = cluster2.GetParams().start_point.t;// * _time_2_cm;

    if (_debug){

      std::cout << "Cluster 1:" << std::endl;
      std::cout << "\tAngle: " << angle1 << std::endl;
      std::cout << "\tStart: ( " << w_start1 << ", " << t_start1 << " )" << std::endl;
      std::cout << "Cluster 2:" << std::endl;
      std::cout << "\tAngle: " << angle2 << std::endl;
      std::cout << "\tStart: ( " << w_start2 << ", " << t_start2 << " )" << 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;

    //    if(angle_dist_histo){
    //      angle_dist_histo->Fill(angle1-angle2);
    //    }
    //    else
    //      std::cout<<"\n\n\nSOMETHING WENT HORRIBLY WRONG IN CBALGOANGLECOMPAT\n\n\n\n\n\n\n"<<std::endl;

    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(_verbose) {
        if(compatible) std::cout<<"These two clusters are compatible in angle."<<std::endl;
        else std::cout<<"These two clusters are NOT compatible in angle."<<std::endl;
    }
    
    return compatible;
    
  } // end Merge function 

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

inline

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

Definition at line 44 of file CBAlgoAngleCompat.h.

References _allow_180_ambig.

Referenced by CBAlgoAngleCompat(), and cluster::SimpleClusterMerger::SimpleClusterMerger().

{ _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::CBAlgoAngleCompat::SetAngleCut ( double  angle )

inline

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

Definition at line 47 of file CBAlgoAngleCompat.h.

References _max_allowed_2D_angle_diff.

Referenced by CBAlgoAngleCompat(), and cluster::SimpleClusterMerger::SimpleClusterMerger().

{ _max_allowed_2D_angle_diff = angle; }

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

inline

Method to set debug mode.

Definition at line 41 of file CBAlgoAngleCompat.h.

References _debug.

Referenced by CBAlgoAngleCompat().

{ _debug = on; }

void cmtool::CBAlgoAngleCompat::SetMinHits ( size_t  n )

inline

Set Minimum Number of Hits to consider Cluster.

Definition at line 53 of file CBAlgoAngleCompat.h.

References _minHits, and n.

Referenced by CBAlgoAngleCompat(), and cluster::SimpleClusterMerger::SimpleClusterMerger().

{ _minHits = n; }

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

inline

Method to set angle cut value to be based on opening angle.

Definition at line 50 of file CBAlgoAngleCompat.h.

References _use_opening_angle.

Referenced by CBAlgoAngleCompat().

{ _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::CBAlgoAngleCompat::_allow_180_ambig

protected

bool to suppress lots of output if you want

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 64 of file CBAlgoAngleCompat.h.

Referenced by Bool(), and SetAllow180Ambig().

bool cmtool::CBAlgoAngleCompat::_debug

protected

Definition at line 59 of file CBAlgoAngleCompat.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::CBAlgoAngleCompat::_max_allowed_2D_angle_diff

protected

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

Definition at line 67 of file CBAlgoAngleCompat.h.

Referenced by Bool(), and SetAngleCut().

size_t cmtool::CBAlgoAngleCompat::_minHits

protected

Definition at line 73 of file CBAlgoAngleCompat.h.

Referenced by Bool(), and SetMinHits().

bool cmtool::CBAlgoAngleCompat::_use_opening_angle

protected

bool set to true if you want to use opening angle as the cutoff angle instead of whatever you set with SetAngleCut

Definition at line 71 of file CBAlgoAngleCompat.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(), 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::CFAlgoQRatio::Float(), cmtool::CFAlgoZOverlap::Float(), cmtool::CFAlgoStartPointMatch::Float(), cmtool::CMAlgoBase::SetVerbose(), cmtool::CBAlgoShortestDist::ShortestDistanceSquared(), cmtool::CBAlgoShortestDistSmallCluster::ShortestDistanceSquared(), cmtool::CBAlgoCenterOfMassSmall::ShortestDistanceSquared(), and cmtool::CBAlgoCenterOfMass::ShortestDistanceSquared().

TH1F* cmtool::CBAlgoAngleCompat::angle_dist_histo

protected

Min Number of hits for cluster to be considered.

Histogram used for debugging/cut value settings

Definition at line 76 of file CBAlgoAngleCompat.h.

---

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

• larreco/v06_64_02/source/larreco/RecoAlg/CMTool/CMTAlgMerge/CBAlgoAngleCompat.h
• larreco/v06_64_02/source/larreco/RecoAlg/CMTool/CMTAlgMerge/CBAlgoAngleCompat.cxx