cmtool::CBAlgoCenterOfMass Class Reference

#include "CBAlgoCenterOfMass.h"

Inheritance diagram for cmtool::CBAlgoCenterOfMass:

Public Member Functions
	CBAlgoCenterOfMass ()
	Default constructor. More...
virtual	~CBAlgoCenterOfMass ()
	Default destructor. More...
virtual bool	Bool (const ::cluster::ClusterParamsAlg &cluster1, const ::cluster::ClusterParamsAlg &cluster2)
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 iteration. More...
void	SetDebug (bool on)
	Function to set Debug mode of output. More...
void	SetMaxHitsSmallClus (size_t n)
	Function to set Max hits for small clsuters. More...
void	SetMinHitsBigClus (size_t n)
	Function to se Min hits for big clusters. More...
void	SetMaxDistance (double d)
	Function to set Max Distance for COM to be from start-end. More...
void	UseCOMInPoly (bool on)
	Use COM in Poly algo to decide merging. More...
void	UseCOMInCone (bool on)
	Use COM in Poly algo to decide merging. More...
void	UseCOMNearClus (bool on)
	Use COM in Poly algo to decide merging. More...
void	SetLengthReach (double frac)
	Set Length Reach: How for out the cone extends as percent of cluster length. More...
double	ShortestDistanceSquared (double point_x, double point_y, double start_x, double start_y, double end_x, double end_y) const
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
size_t	_minHits
size_t	_maxHits
double	_MaxDist
double	_lengthReach
bool	_COMinPolyAlg
	How four out - as percent of cluster length - cone will extend from start point. More...
bool	_COMinConeAlg
bool	_COMNearClus
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

Designed mainly for small clusters (< 10 hits): Find Cluster's center of mass weighing by Q Then see if COM is in polygon/cone of a big cluster If so -> merge

Definition at line 29 of file CBAlgoCenterOfMass.h.

Constructor & Destructor Documentation

cmtool::CBAlgoCenterOfMass::CBAlgoCenterOfMass

(

)

Default constructor.

Definition at line 9 of file CBAlgoCenterOfMass.cxx.

References SetDebug(), SetLengthReach(), SetMaxDistance(), SetMaxHitsSmallClus(), SetMinHitsBigClus(), UseCOMInCone(), UseCOMInPoly(), and UseCOMNearClus().

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

    SetDebug(false);
    SetMaxHitsSmallClus(10);
    SetMinHitsBigClus(40);
    SetMaxDistance(20.);
    SetLengthReach(3.0);
    UseCOMInPoly(true);
    UseCOMInCone(true);
    UseCOMNearClus(true);

  }

virtual cmtool::CBAlgoCenterOfMass::~CBAlgoCenterOfMass ( )

inlinevirtual

Default destructor.

Definition at line 37 of file CBAlgoCenterOfMass.h.

References Bool().

{};

Member Function Documentation

bool cmtool::CBAlgoCenterOfMass::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 CBAlgoCenterOfMass.cxx.

References _COMinConeAlg, _COMinPolyAlg, _COMNearClus, _debug, _lengthReach, _MaxDist, _maxHits, _minHits, cmtool::CMAlgoBase::_verbose, Polygon2D::PointInside(), and ShortestDistanceSquared().

Referenced by ~CBAlgoCenterOfMass().

  {

    int small = 0;
    int hitssmall = 0;

    //determine if clusters ok and if so which is big and which is small
    if ( (cluster1.GetHitVector().size() > _minHits) and (cluster2.GetHitVector().size() < _maxHits) )
      small = 2;
    else if ( (cluster2.GetHitVector().size() > _minHits) and (cluster1.GetHitVector().size() < _maxHits) )
      small = 1;
    else
      return false;
    
    //Define COM values on w & t
    double COM_t_s = 0;
    double COM_w_s = 0;
    double Q_s     = 0;
    //Define cone parameters
    double opening_angle;
    double direc_angle;
    double length;
    double start_w;
    double start_t;
    double end_w;
    double end_t;
    Polygon2D poly;

    //Get Hit vector for small cluster
    //std::vector<util::PxHit> hitss;
    std::vector<util::PxHit> hitss;
    if ( small == 1 ){
      hitss = cluster1.GetHitVector();
      hitssmall = hitss.size();
      direc_angle   = cluster2.GetParams().angle_2d;
      opening_angle = cluster2.GetParams().opening_angle * (180./3.14);
      length  = cluster2.GetParams().length;
      start_w = cluster2.GetParams().start_point.w;
      start_t = cluster2.GetParams().start_point.t;
      end_w = cluster2.GetParams().end_point.w;
      end_t = cluster2.GetParams().end_point.t;
      poly  = cluster2.GetParams().PolyObject;
    }      
    if ( small == 2 ){
      hitss = cluster2.GetHitVector();
      hitssmall = hitss.size();
      direc_angle   = cluster1.GetParams().angle_2d;
      opening_angle = cluster1.GetParams().opening_angle * (180./3.14);
      length  = cluster1.GetParams().length;
      start_w = cluster1.GetParams().start_point.w;
      start_t = cluster1.GetParams().start_point.t;
      end_w = cluster1.GetParams().end_point.w;
      end_t = cluster1.GetParams().end_point.t;
      poly  = cluster1.GetParams().PolyObject;
    }

    if (_debug){
      std::cout << "Big Cluster:" << std::endl;
      std::cout << "\tOpening Angle: " << opening_angle << std::endl;
      std::cout << "\tLength: " << length << std::endl;
      std::cout << "\tStart Point: (" << start_w << ", " << end_w << ")" << std::endl;
      std::cout << "\tDirection Angle: " << direc_angle << std::endl;
      std::cout << std::endl;
    }

    for (auto& hit: hitss){
      COM_t_s += hit.t * hit.charge;
      COM_w_s += hit.w * hit.charge;
      Q_s     += hit.charge;
    }
    COM_t_s /= Q_s;
    COM_w_s /= Q_s;

    if (_debug) {
      std::cout << "Small Cluster: " << std::endl;
      std::cout << "N Hits: " << hitssmall << std::endl;
      std::cout << "COM: (w,t) -> (" << COM_w_s << ", " << COM_t_s << ")" << std::endl;
      std::cout << std::endl;
    }

    //Get COM
    std::pair<float,float> COM_s;
    COM_s = std::make_pair( COM_w_s, COM_t_s );

    //Get rotate COM to see if in cone
    double COM_w_rot = (COM_w_s - start_w)*cos(direc_angle*3.14/180.) + (COM_t_s - start_t)*sin(direc_angle*3.14/180.);
    double COM_t_rot = - (COM_w_s - start_w)*sin(direc_angle*3.14/180.) + (COM_t_s - start_t)*cos(direc_angle*3.14/180.);

    //look for polygon overlap
    if ( ( poly.PointInside(COM_s) ) and  _COMinPolyAlg ){
      if (_verbose) { std::cout << "Polygon Overlap -> Merge!" << std::endl << std::endl;}
      return true;
    }
    //look for COM in cone
    if ( _COMinConeAlg and
         (COM_w_rot < length*_lengthReach ) and ( COM_w_rot > 0 ) and
         ( abs(COM_t_rot) < abs(COM_w_rot*sin(opening_angle*3.14/180.)) ) ){
      if (_verbose) { std::cout << "COM in Cone -> Merge! " << std::endl; }
      return true;
    }
    //look for COM close to start-end of other cluster
    if ( _COMNearClus and
         ShortestDistanceSquared( COM_w_s, COM_t_s, start_w, start_t, end_w, end_t ) < _MaxDist ) {
      if (_verbose) { std::cout << "COM close to start-end -> Merge!" << 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::CBAlgoCenterOfMass::Report ( )

virtual

Function to report what's going on per merging iteration.

Reimplemented from cmtool::CMAlgoBase.

Definition at line 138 of file CBAlgoCenterOfMass.cxx.

Referenced by Reset().

  {

  }

virtual void cmtool::CBAlgoCenterOfMass::Reset ( )

inlinevirtual

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

Reimplemented from cmtool::CMAlgoBase.

Definition at line 47 of file CBAlgoCenterOfMass.h.

References Report().

{}

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

inline

Function to set Debug mode of output.

Definition at line 53 of file CBAlgoCenterOfMass.h.

References _debug.

Referenced by CBAlgoCenterOfMass().

{ _debug = on; }

void cmtool::CBAlgoCenterOfMass::SetLengthReach ( double  frac )

inline

Set Length Reach: How for out the cone extends as percent of cluster length.

Definition at line 74 of file CBAlgoCenterOfMass.h.

References _lengthReach, and ShortestDistanceSquared().

Referenced by CBAlgoCenterOfMass().

{ _lengthReach = frac; }

void cmtool::CBAlgoCenterOfMass::SetMaxDistance ( double  d )

inline

Function to set Max Distance for COM to be from start-end.

Definition at line 62 of file CBAlgoCenterOfMass.h.

References _MaxDist, and d.

Referenced by CBAlgoCenterOfMass().

{ _MaxDist = d; }

void cmtool::CBAlgoCenterOfMass::SetMaxHitsSmallClus ( size_t  n )

inline

Function to set Max hits for small clsuters.

Definition at line 56 of file CBAlgoCenterOfMass.h.

References _maxHits, and n.

Referenced by CBAlgoCenterOfMass().

{ _maxHits = n; }

void cmtool::CBAlgoCenterOfMass::SetMinHitsBigClus ( size_t  n )

inline

Function to se Min hits for big clusters.

Definition at line 59 of file CBAlgoCenterOfMass.h.

References _minHits, and n.

Referenced by CBAlgoCenterOfMass().

{ _minHits = n; }

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

double cmtool::CBAlgoCenterOfMass::ShortestDistanceSquared	(	double	point_x,
		double	point_y,
		double	start_x,
		double	start_y,
		double	end_x,
		double	end_y
	)		const

Definition at line 144 of file CBAlgoCenterOfMass.cxx.

References cmtool::CMAlgoBase::_verbose.

Referenced by Bool(), and SetLengthReach().

                                                                                           {
    
    //This code finds the shortest distance between a point and a line segment.    
    //code based off sample from 
    //http://stackoverflow.com/questions/849211/shortest-distance-between-a-point-and-a-line-segment
    //note to self: rewrite this with TVector2 and compare time differences... 
    //TVector2 code might be more understandable
    
    double distance_squared = -1;
    
    // Line segment: from ("V") = (start_x, start_y) to ("W")=(end_x, end_y)
    double length_squared = pow((end_x - start_x), 2) + pow((end_y - start_y), 2);
    
    // Treat the case start & end point overlaps
    if(length_squared < 0.1) {
      if(_verbose){
        std::cout << std::endl;
        std::cout << Form(" Provided very short line segment: (%g,%g) => (%g,%g)",
                          start_x,start_y,end_x,end_y) << std::endl;
        std::cout << " Likely this means one of two clusters have start & end point identical." << std::endl;
        std::cout << " Check the cluster output!" << std::endl;
        std::cout << std::endl;
        std::cout << Form(" At this time, the algorithm uses a point (%g,%g)",start_x,start_y) << std::endl;
        std::cout << " to represent this cluster's location." << std::endl;
        std::cout << std::endl;
      }
      
      return (pow((point_x - start_x),2) + pow((point_y - start_y),2));
    }
    
    //Find shortest distance between point ("P")=(point_x,point_y) to this line segment
    double t = ( (point_x - start_x)*(end_x - start_x) + (point_y - start_y)*(end_y - start_y) ) / length_squared;
    
    if(t<0.0) distance_squared = pow((point_x - start_x), 2) + pow((point_y - start_y), 2);
    
    else if (t>1.0) distance_squared = pow((point_x - end_x), 2) + pow(point_y - end_y, 2);
    
    else distance_squared = pow((point_x - (start_x + t*(end_x - start_x))), 2) + pow((point_y - (start_y + t*(end_y - start_y))),2);
    
    return distance_squared;
    
  }//end ShortestDistanceSquared function

void cmtool::CBAlgoCenterOfMass::UseCOMInCone ( bool  on )

inline

Use COM in Poly algo to decide merging.

Definition at line 68 of file CBAlgoCenterOfMass.h.

References _COMinConeAlg.

Referenced by CBAlgoCenterOfMass().

{ _COMinConeAlg = on; }

void cmtool::CBAlgoCenterOfMass::UseCOMInPoly ( bool  on )

inline

Use COM in Poly algo to decide merging.

Definition at line 65 of file CBAlgoCenterOfMass.h.

References _COMinPolyAlg.

Referenced by CBAlgoCenterOfMass().

{ _COMinPolyAlg = on; }

void cmtool::CBAlgoCenterOfMass::UseCOMNearClus ( bool  on )

inline

Use COM in Poly algo to decide merging.

Definition at line 71 of file CBAlgoCenterOfMass.h.

References _COMNearClus.

Referenced by CBAlgoCenterOfMass().

{ _COMNearClus = on; }

Member Data Documentation

bool cmtool::CBAlgoCenterOfMass::_COMinConeAlg

protected

Definition at line 89 of file CBAlgoCenterOfMass.h.

Referenced by Bool(), and UseCOMInCone().

bool cmtool::CBAlgoCenterOfMass::_COMinPolyAlg

protected

How four out - as percent of cluster length - cone will extend from start point.

Definition at line 88 of file CBAlgoCenterOfMass.h.

Referenced by Bool(), and UseCOMInPoly().

bool cmtool::CBAlgoCenterOfMass::_COMNearClus

protected

Definition at line 90 of file CBAlgoCenterOfMass.h.

Referenced by Bool(), and UseCOMNearClus().

bool cmtool::CBAlgoCenterOfMass::_debug

protected

Definition at line 83 of file CBAlgoCenterOfMass.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::CBAlgoCenterOfMass::_lengthReach

protected

Definition at line 87 of file CBAlgoCenterOfMass.h.

Referenced by Bool(), and SetLengthReach().

double cmtool::CBAlgoCenterOfMass::_MaxDist

protected

Definition at line 86 of file CBAlgoCenterOfMass.h.

Referenced by Bool(), and SetMaxDistance().

size_t cmtool::CBAlgoCenterOfMass::_maxHits

protected

Definition at line 85 of file CBAlgoCenterOfMass.h.

Referenced by Bool(), and SetMaxHitsSmallClus().

size_t cmtool::CBAlgoCenterOfMass::_minHits

protected

Definition at line 84 of file CBAlgoCenterOfMass.h.

Referenced by Bool(), and SetMinHitsBigClus().

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