#include "CBAlgoShortestDistNonEndPoint.h"

Inheritance diagram for cmtool::CBAlgoShortestDistNonEndpoint:

Public Member Functions
	CBAlgoShortestDistNonEndpoint ()
	Default constructor. More...

virtual	~CBAlgoShortestDistNonEndpoint ()
	Default destructor. More...

virtual bool	Bool (const ::cluster::ClusterParamsAlg &cluster1, const ::cluster::ClusterParamsAlg &cluster2)
	Overloaded (from CBoolAlgoBase) Bool function. More...

void	SetSquaredDistanceCut (double d)
	Method to set cut value in cm^2 for distance compatibility test. More...

void	SetVerbose (bool on)
	Method to set verbose mode. More...

void	SetDebug (bool on)
	Method to set debug mode. More...

void	SetMinHits (int n)
	Set Minimum Number of Hits to consider Cluster. More...

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

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

Protected Attributes
bool	_verbose

bool	_debug
	bool to suppress lots of output if you want More...

size_t	_minHits
	bool to suppress lots of output if you want More...

double	_min_distance_unit
	Min Number of hits for cluster to be considered. More...

double	_max_2D_dist2
	minimum distance b/t start and end point of cluster to use it More...

TFile *	_fout
	TFile pointer to an output file. More...

Detailed Description

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

Definition at line 26 of file CBAlgoShortestDistNonEndPoint.h.

Constructor & Destructor Documentation

cmtool::CBAlgoShortestDistNonEndpoint::CBAlgoShortestDistNonEndpoint ( )

Default constructor.

Definition at line 9 of file CBAlgoShortestDistNonEndPoint.cxx.

References _min_distance_unit, SetDebug(), SetMinHits(), SetSquaredDistanceCut(), and SetVerbose().

                                                                {
 
     //this just sets default values    
     SetVerbose(true);
     SetDebug(false);
     SetMinHits(0);
     
     //1e9 is huge; everything will be merged
     SetSquaredDistanceCut(1e9);
 
     _min_distance_unit = 1.e-3;
   } //end constructor

virtual cmtool::CBAlgoShortestDistNonEndpoint::~CBAlgoShortestDistNonEndpoint ( )

inlinevirtual

Default destructor.

Definition at line 34 of file CBAlgoShortestDistNonEndPoint.h.

References Bool().

34 {};

Member Function Documentation

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

virtual

Overloaded (from CBoolAlgoBase) Bool function.

Reimplemented from cmtool::CBoolAlgoBase.

Definition at line 22 of file CBAlgoShortestDistNonEndPoint.cxx.

References _debug, _max_2D_dist2, _minHits, _verbose, and ShortestDistanceSquared().

Referenced by ~CBAlgoShortestDistNonEndpoint().

   {
     
     //if number of hits not large enough skip
     if ( (_minHits > 0) and ((cluster1.GetParams().N_Hits < _minHits) or (cluster2.GetParams().N_Hits < _minHits)) ) {
       if (_debug) { std::cout << "Num of Hits below threshold..." << std::endl; }
       return false;
     }
 
     double w_start1 = cluster1.GetParams().start_point.w;
     double t_start1 = cluster1.GetParams().start_point.t;
     double w_end1   = cluster1.GetParams().end_point.w;
     double t_end1   = cluster1.GetParams().end_point.t;
 
     double w_start2 = cluster2.GetParams().start_point.w;
     double t_start2 = cluster2.GetParams().start_point.t;
     double w_end2   = cluster2.GetParams().end_point.w;
     double t_end2   = cluster2.GetParams().end_point.t;
 
     if (_debug){
       std::cout << "Start point Cluster 1: (" << w_start1 << ", " << t_start1 << ")"  << std::endl;
       std::cout << "End point Cluster 2: (" << w_end1 << ", " << t_end1 << ")"  << std::endl;
       std::cout << "Start point Cluster 1: (" << w_start2 << ", " << t_start2 << ")"  << std::endl;
       std::cout << "End point Cluster 2: (" << w_end2 << ", " << t_end2 << ")"  << std::endl;
     }
     
     //First, pretend the first cluster is a 2D line segment, from its start point to end point
     //Find the shortest distance between start point of the second cluster to this line segment.
     //Repeat for end point of second cluster to this line segment.
     //Then, pretend second cluster is a 2D line segment, from its start point to end point.
     //Find the shortest distance between start point of the first cluster to this line segment.
     //Repeat for end point of first cluster to this line segment.
     //If the shortest of these four distances is less than the cutoff, 
     //return true (the clusters are merge-compatible). else, return false.
     
     // Step 1: inspect (w_start1, t_start1) vs. line (w_start2, t_start2) => (w_end2, t_end2)
     double shortest_distance2 = ShortestDistanceSquared(w_start1, t_start1,
                                                         w_start2, t_start2, 
                                                         w_end2, t_end2);
     
     // Step 2: inspect (w_end1, t_end1) vs. line (w_start2, t_start2) => (w_end2, t_end2)
     double shortest_distance2_tmp = ShortestDistanceSquared(w_end1, t_end1,
                                                             w_start2, t_start2, 
                                                             w_end2, t_end2);
     
     shortest_distance2 = (shortest_distance2_tmp < shortest_distance2) ?
       shortest_distance2_tmp : shortest_distance2;
     
     // Step 3: inspect (w_start2, t_start2) vs. line (w_start1, t_start1) => (w_end1, t_end1)
     shortest_distance2_tmp = ShortestDistanceSquared(w_start2, t_start2,
                                                      w_start1, t_start1, 
                                                      w_end1, t_end1);
 
     shortest_distance2 = (shortest_distance2_tmp < shortest_distance2) ? 
       shortest_distance2_tmp : shortest_distance2;
 
     // Step 4: inspect (w_end2, t_end2) vs. line (w_start1, t_start1) => (w_end1, t_end1)
     shortest_distance2_tmp = ShortestDistanceSquared(w_end2, t_end2,
                                                      w_start1, t_start1, 
                                                      w_end1, t_end1);
     
     shortest_distance2 = (shortest_distance2_tmp < shortest_distance2) ? 
       shortest_distance2_tmp : shortest_distance2;
 
     bool compatible = shortest_distance2 < _max_2D_dist2;
 
     if(_verbose) {
 
       if(compatible) std::cout<<Form(" Compatible in distance (%g).\n",shortest_distance2);
       else std::cout<<Form(" NOT compatible in distance (%g).\n",shortest_distance2);
     
     }
 
     return compatible;
 
 
   }//end Bool 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().

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

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

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

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

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

40 {}

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

77 { _fout = fout; }

cmtool::CMAlgoBase::_fout

TFile * _fout

TFile pointer to an output file.

Definition: CMAlgoBase.h:85

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

inline

Method to set debug mode.

Definition at line 48 of file CBAlgoShortestDistNonEndPoint.h.

References _debug.

Referenced by CBAlgoShortestDistNonEndpoint().

48 { _debug = on; }

cmtool::CBAlgoShortestDistNonEndpoint::_debug

bool _debug

bool to suppress lots of output if you want

Definition: CBAlgoShortestDistNonEndPoint.h:67

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

inline

Set Minimum Number of Hits to consider Cluster.

Definition at line 51 of file CBAlgoShortestDistNonEndPoint.h.

References _minHits, n, and ShortestDistanceSquared().

Referenced by CBAlgoShortestDistNonEndpoint().

51 { _minHits = n; }

cmtool::CBAlgoShortestDistNonEndpoint::_minHits

size_t _minHits

bool to suppress lots of output if you want

Definition: CBAlgoShortestDistNonEndPoint.h:69

n

Char_t n[5]

Definition: comparison_ascii.C:55

void cmtool::CBAlgoShortestDistNonEndpoint::SetSquaredDistanceCut ( double d )

inline

Method to set cut value in cm^2 for distance compatibility test.

Definition at line 42 of file CBAlgoShortestDistNonEndPoint.h.

References _max_2D_dist2, and d.

Referenced by CBAlgoShortestDistNonEndpoint().

42 { _max_2D_dist2 = d; }

d

Float_t d

Definition: plot.C:237

cmtool::CBAlgoShortestDistNonEndpoint::_max_2D_dist2

double _max_2D_dist2

minimum distance b/t start and end point of cluster to use it

Definition: CBAlgoShortestDistNonEndPoint.h:73

void cmtool::CBAlgoShortestDistNonEndpoint::SetVerbose ( bool on )

inlinevirtual

Method to set verbose mode.

Reimplemented from cmtool::CMAlgoBase.

Definition at line 45 of file CBAlgoShortestDistNonEndPoint.h.

References _verbose.

Referenced by CBAlgoShortestDistNonEndpoint().

45 { _verbose = on; }

cmtool::CBAlgoShortestDistNonEndpoint::_verbose

bool _verbose

Definition: CBAlgoShortestDistNonEndPoint.h:65

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

Function to compute a distance between a 2D point (point_x, point_y) to a 2D finite line segment (start_x, start_y) => (end_x, end_y).

Definition at line 101 of file CBAlgoShortestDistNonEndPoint.cxx.

References _min_distance_unit, and _verbose.

Referenced by Bool(), and SetMinHits().

                                                                                                       {
     
     //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 = 999999;
     
     // 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 < _min_distance_unit) {
       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);
 
 
     if(t>0.1 && t < 0.9) 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

Member Data Documentation

bool cmtool::CBAlgoShortestDistNonEndpoint::_debug

protected

bool to suppress lots of output if you want

Definition at line 67 of file CBAlgoShortestDistNonEndPoint.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::CBAlgoShortestDistNonEndpoint::_max_2D_dist2

protected

minimum distance b/t start and end point of cluster to use it

Definition at line 73 of file CBAlgoShortestDistNonEndPoint.h.

Referenced by Bool(), and SetSquaredDistanceCut().

double cmtool::CBAlgoShortestDistNonEndpoint::_min_distance_unit

protected

Min Number of hits for cluster to be considered.

Definition at line 71 of file CBAlgoShortestDistNonEndPoint.h.

Referenced by CBAlgoShortestDistNonEndpoint(), and ShortestDistanceSquared().

size_t cmtool::CBAlgoShortestDistNonEndpoint::_minHits

protected

bool to suppress lots of output if you want

Definition at line 69 of file CBAlgoShortestDistNonEndPoint.h.

Referenced by Bool(), and SetMinHits().

bool cmtool::CBAlgoShortestDistNonEndpoint::_verbose

protected

Definition at line 65 of file CBAlgoShortestDistNonEndPoint.h.

Referenced by Bool(), SetVerbose(), 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/CBAlgoShortestDistNonEndPoint.h
/cvmfs/larsoft.opensciencegrid.org/products/larreco/v07_10_02/source/larreco/RecoAlg/CMTool/CMTAlgMerge/CBAlgoShortestDistNonEndPoint.cxx

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation