cmtool::CBAlgoOutOfConeSeparate Class Reference

#include "CBAlgoOutOfConeSeparate.h"

Inheritance diagram for cmtool::CBAlgoOutOfConeSeparate:

Public Member Functions
	CBAlgoOutOfConeSeparate ()
	Default constructor. More...
virtual	~CBAlgoOutOfConeSeparate ()
	Default destructor. More...
virtual bool	Bool (const ::cluster::ClusterParamsAlg &cluster1, const ::cluster::ClusterParamsAlg &cluster2)
void	SetDebug (bool on)
	Set Debug Mode on or off. More...
void	SetMaxAngleSep (float angle)
	Set Max Angle Separation for separation. More...
void	SetMaxAngleFar (float angle)
	Set Max Angle Separation for separation for far away clusters. More...
void	SetStartAngleFalloff (float d)
	Set Distance at which cone-acceptance angle starts falling off as 1/distance. Value should be distance^2 in cm^2. More...
void	SetMinLength (float len)
	Set Minimum length for "big" cluster. More...
void	SetMinHits (size_t n)
	SetMinimum number of hits for small cluster. More...
virtual void	Reset ()
	Function to reset the algorithm instance ... maybe implemented via child class. More...
virtual void	Report ()
	Function to report what's going on per merging. 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...
virtual void	SetVerbose (bool doit=true)
	Setter function for verbosity. More...

Protected Attributes
bool	_debug
float	_MaxAngle
float	_MaxAngleFar
float	_MinLen
float	_FallOff
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

Definition at line 27 of file CBAlgoOutOfConeSeparate.h.

Constructor & Destructor Documentation

cmtool::CBAlgoOutOfConeSeparate::CBAlgoOutOfConeSeparate

(

)

Default constructor.

Definition at line 9 of file CBAlgoOutOfConeSeparate.cxx.

References SetDebug(), SetMaxAngleSep(), SetMinHits(), SetMinLength(), and SetStartAngleFalloff().

                                                   : CBoolAlgoBase()
  //----------------------------------------
  {

    SetDebug(false);
    SetMaxAngleSep(20.);
    SetMinLength(15.);
    SetMinHits(20);
    SetStartAngleFalloff(2800); // in cm^2

  }

virtual cmtool::CBAlgoOutOfConeSeparate::~CBAlgoOutOfConeSeparate ( )

inlinevirtual

Default destructor.

Definition at line 35 of file CBAlgoOutOfConeSeparate.h.

References Bool().

{};

Member Function Documentation

bool cmtool::CBAlgoOutOfConeSeparate::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 22 of file CBAlgoOutOfConeSeparate.cxx.

References _debug, _FallOff, _MaxAngle, _MaxAngleFar, _minHits, _MinLen, cmtool::CMAlgoBase::_verbose, and SetMaxAngleFar().

Referenced by ~CBAlgoOutOfConeSeparate().

  {

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

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

    double len1 = cluster1.GetParams().length;
    double len2 = cluster2.GetParams().length;
    
    size_t hits1 = cluster1.GetHitVector().size();
    size_t hits2 = cluster2.GetHitVector().size();

    double startseparation = (w_start2-w_start1)*(w_start2-w_start1) + (t_start2-t_start1)*(t_start2-t_start1);
    //convert sepration to be instead of just angle -> angle/distance^n (n=1 for now)
    SetMaxAngleFar(_MaxAngle*(_FallOff/startseparation)); //distance^2 of 400 cm^2 taken as "standard" 
    if ( _MaxAngleFar > 90. )
      _MaxAngleFar = 90.;

    //if either cluster has less than _minHits don't even try...
    if ( (hits1 < _minHits) or (hits2 < _minHits)
         or (angle1 < -360) or (angle2 < -360) )
      return false;
    
    if (_debug){
      std::cout << "Cluster 1:" << std::endl;
      std::cout << "\tStart: ( " << w_start1 << ", " << t_start1 << " )" << std::endl;
      std::cout << "\tAngle: " << angle1 << std::endl;
      std::cout << "\tLength: " << len1 << std::endl;
      std::cout << "\tN Hits: " << hits1 << std::endl;

      std::cout << "Cluster 2:" << std::endl;
      std::cout << "\tStart: ( " << w_start2 << ", " << t_start2 << " )" << std::endl;
      std::cout << "\tAngle: " << angle2 << std::endl;
      std::cout << "\tLength: " << len2 << std::endl;
      std::cout << "\tN Hits: " << hits2 << std::endl;

      std::cout << "Start Point Separation: " << startseparation << std::endl;
    }

    //cluster 1 needs to be long enough (i.e. good) and cluster 2 must have minimum number of hits
    double angle;
    double separation;

    if ( startseparation == 0 ) //do not prohibit merging if start point identical
      return false;

    //first calculate angle of line in 2D plane connectng the two start points
    if ( (t_start2-t_start1) == 0 )
      angle = 0.;
    else {
      double slope = (t_start2-t_start1)/(w_start2-w_start1);
      angle = atan(slope)*180./3.14;
    }

    separation = abs(angle-angle1);

    if (_debug){
      std::cout << "Angle S1--S2: " << angle << std::endl;
      std::cout << "Angle1--S2: " << separation << std::endl;
    }
    if ( ( ( ( (separation > _MaxAngle) and (separation < 180-_MaxAngle) ) or
             ( (separation > 180+_MaxAngle) and (separation< 360-_MaxAngle) ) )
           or ( ( (separation > _MaxAngleFar) and (separation < 180-_MaxAngleFar) ) or
                ( (separation > 180+_MaxAngleFar) and (separation< 360-_MaxAngleFar) ) ) )
         and (hits2 > _minHits)
         and (len1 > _MinLen)      ){
      if (_verbose) { std::cout << "Separate! cluster 1 BIG" << std::endl << std::endl; }
      return true;
    }

    //now change direction of angle so that it points from cluster 2 (big) to cluster 1 (small)
    angle += 180.;
    angle = (int)(angle) % 360;

    separation = abs(angle-angle2);
    //separation *= (400./startseparation); //distance^2 of 400 cm^2 taken as "standard"
    if (_debug){
      std::cout << "Angle S2--S1: " << angle << std::endl;
      std::cout << "Angle2--S1: " << separation << std::endl;
    }
    if ( ( ( ( (separation > _MaxAngle) and (separation < 180-_MaxAngle) ) or
             ( (separation > 180+_MaxAngle) and (separation< 360-_MaxAngle) ) )
           or ( ( (separation > _MaxAngleFar) and (separation < 180-_MaxAngleFar) ) or
                ( (separation > 180+_MaxAngleFar) and (separation< 360-_MaxAngleFar) ) ) )
         and (hits1 > _minHits)
         and (len2 > _MinLen)    ){
      if (_verbose) { std::cout << "Separate! cluster 2 BIG" << std::endl << 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; }

virtual void cmtool::CBAlgoOutOfConeSeparate::Report ( )

inlinevirtual

Function to report what's going on per merging.

Reimplemented from cmtool::CMAlgoBase.

Definition at line 66 of file CBAlgoOutOfConeSeparate.h.

{}

virtual void cmtool::CBAlgoOutOfConeSeparate::Reset ( )

inlinevirtual

Function to reset the algorithm instance ... maybe implemented via child class.

Reimplemented from cmtool::CMAlgoBase.

Definition at line 63 of file CBAlgoOutOfConeSeparate.h.

{}

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::CBAlgoOutOfConeSeparate::SetDebug ( bool  on )

inline

Set Debug Mode on or off.

Definition at line 45 of file CBAlgoOutOfConeSeparate.h.

References _debug.

Referenced by CBAlgoOutOfConeSeparate().

{ _debug = on; }

void cmtool::CBAlgoOutOfConeSeparate::SetMaxAngleFar ( float  angle )

inline

Set Max Angle Separation for separation for far away clusters.

Definition at line 51 of file CBAlgoOutOfConeSeparate.h.

References _MaxAngleFar.

Referenced by Bool().

{ _MaxAngleFar = angle; }

void cmtool::CBAlgoOutOfConeSeparate::SetMaxAngleSep ( float  angle )

inline

Set Max Angle Separation for separation.

Definition at line 48 of file CBAlgoOutOfConeSeparate.h.

References _MaxAngle.

Referenced by CBAlgoOutOfConeSeparate().

{ _MaxAngle = angle; }

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

inline

SetMinimum number of hits for small cluster.

Definition at line 60 of file CBAlgoOutOfConeSeparate.h.

References _minHits, and n.

Referenced by CBAlgoOutOfConeSeparate().

{ _minHits = n; }

void cmtool::CBAlgoOutOfConeSeparate::SetMinLength ( float  len )

inline

Set Minimum length for "big" cluster.

Definition at line 57 of file CBAlgoOutOfConeSeparate.h.

References _MinLen.

Referenced by CBAlgoOutOfConeSeparate().

{ _MinLen = len; }

void cmtool::CBAlgoOutOfConeSeparate::SetStartAngleFalloff ( float  d )

inline

Set Distance at which cone-acceptance angle starts falling off as 1/distance. Value should be distance^2 in cm^2.

Definition at line 54 of file CBAlgoOutOfConeSeparate.h.

References _FallOff, and d.

Referenced by CBAlgoOutOfConeSeparate().

{ _FallOff = d; }

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::CBAlgoOutOfConeSeparate::_debug

protected

Definition at line 70 of file CBAlgoOutOfConeSeparate.h.

Referenced by Bool(), and SetDebug().

float cmtool::CBAlgoOutOfConeSeparate::_FallOff

protected

Definition at line 74 of file CBAlgoOutOfConeSeparate.h.

Referenced by Bool(), and SetStartAngleFalloff().

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().

float cmtool::CBAlgoOutOfConeSeparate::_MaxAngle

protected

Definition at line 71 of file CBAlgoOutOfConeSeparate.h.

Referenced by Bool(), and SetMaxAngleSep().

float cmtool::CBAlgoOutOfConeSeparate::_MaxAngleFar

protected

Definition at line 72 of file CBAlgoOutOfConeSeparate.h.

Referenced by Bool(), and SetMaxAngleFar().

size_t cmtool::CBAlgoOutOfConeSeparate::_minHits

protected

Definition at line 75 of file CBAlgoOutOfConeSeparate.h.

Referenced by Bool(), and SetMinHits().

float cmtool::CBAlgoOutOfConeSeparate::_MinLen

protected

Definition at line 73 of file CBAlgoOutOfConeSeparate.h.

Referenced by Bool(), and SetMinLength().

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(), 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/CBAlgoOutOfConeSeparate.h
• /cvmfs/larsoft.opensciencegrid.org/products/larreco/v07_10_02/source/larreco/RecoAlg/CMTool/CMTAlgMerge/CBAlgoOutOfConeSeparate.cxx