cmtool::CFAlgoStartPointMatch Class Reference

#include "CFAlgoStartPointMatch.h"

Inheritance diagram for cmtool::CFAlgoStartPointMatch:

Public Member Functions
	CFAlgoStartPointMatch ()
	Default constructor. More...
virtual	~CFAlgoStartPointMatch ()
	Default destructor. More...
virtual float	Float (const std::vector< const cluster::ClusterParamsAlg * > &clusters)
virtual void	Report ()
virtual void	Reset ()
	Function to reset the algorithm instance, called together with manager's Reset() More...
double	Area2D (double Ax, double Ay, double Bx, double By, double Cx, double Cy)
double	Area3D (double Ax, double Ay, double Az, double Bx, double By, double Bz, double Cx, double Cy, double Cz)
void	UseTime (bool on)
void	SetMaxArea (double area)
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
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...

Private Attributes
double	_w2cm
double	_t2cm
double	_MaxArea
bool	_time

Detailed Description

User implementation for CFloatAlgoBase class doxygen documentation!

Definition at line 26 of file CFAlgoStartPointMatch.h.

Constructor & Destructor Documentation

cmtool::CFAlgoStartPointMatch::CFAlgoStartPointMatch

(

)

Default constructor.

Definition at line 9 of file CFAlgoStartPointMatch.cxx.

References _t2cm, _w2cm, SetMaxArea(), util::GeometryUtilities::TimeToCm(), UseTime(), and util::GeometryUtilities::WireToCm().

                                               : CFloatAlgoBase()
  //-------------------------------------------------------
  {
    ::util::GeometryUtilities geou;
    _w2cm = geou.WireToCm();
    _t2cm = geou.TimeToCm();
    UseTime(true);
    SetMaxArea(100.);
    
  }

virtual cmtool::CFAlgoStartPointMatch::~CFAlgoStartPointMatch ( )

inlinevirtual

Default destructor.

Definition at line 34 of file CFAlgoStartPointMatch.h.

References Area2D(), Area3D(), Float(), Report(), and Reset().

{};

Member Function Documentation

double cmtool::CFAlgoStartPointMatch::Area2D	(	double	Ax,
		double	Ay,
		double	Bx,
		double	By,
		double	Cx,
		double	Cy
	)

Definition at line 124 of file CFAlgoStartPointMatch.cxx.

Referenced by Float(), and ~CFAlgoStartPointMatch().

                                                                                                         {
  //---------------------------------------------------------------------------------------------------

    double a = (Ax*(By-Cy)+Bx*(Cy-Ay)+Cx*(Ay-By))*0.5;

    if ( a < 0 ) { a *= -1; }

    return a;

  }

double cmtool::CFAlgoStartPointMatch::Area3D	(	double	Ax,
		double	Ay,
		double	Az,
		double	Bx,
		double	By,
		double	Bz,
		double	Cx,
		double	Cy,
		double	Cz
	)

Definition at line 136 of file CFAlgoStartPointMatch.cxx.

Referenced by Float(), and ~CFAlgoStartPointMatch().

                                                                          {
  //---------------------------------------------------------------------------------------------------

    //Create vectors AB and AC
    Bx = Bx-Ax;
    By = By-Ay;
    Bz = Bz-Az;
    Cx = Cx-Ax;
    Cy = Cy-Ay;
    Cz = Cz-Az;

    return 0.5*sqrt( (By*Cz-Cz*By)*(By*Cz-Cz*By) + (Bz*Cx-Bx*Cz)*(Bz*Cx-Bx*Cz) + (Bx*Cy-By*Cx)*(Bx*Cy-By*Cx) );
  }

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

float cmtool::CFAlgoStartPointMatch::Float ( const std::vector< const cluster::ClusterParamsAlg * > &  clusters )

virtual

Core function: given a set of CPANs, return a float which indicates the compatibility the cluster combination.

Reimplemented from cmtool::CFloatAlgoBase.

Definition at line 28 of file CFAlgoStartPointMatch.cxx.

References _MaxArea, _time, cmtool::CMAlgoBase::_verbose, _w2cm, Area2D(), Area3D(), and geo::GeometryCore::IntersectionPoint().

Referenced by ~CFAlgoStartPointMatch().

  {

    // Code-block by Kazu starts
    // This ensures the algorithm works only if # clusters is > 2 (and not =2)
    // You may take out this block if you want to allow matching using clusters from only 2 planes.
    if(clusters.size()==2) return -1;
    // Code-block by Kazu ends

    //This algorithm now works for 3 planes: find 3Dstart point from first 2 planes and find
    //How well that agrees with 3rd plane's start point location.

    //So first, make sure clusters vector has only 3 elements. If not return -1
    if ( clusters.size() != 3 )
      return -1;

    //Find 3D start point from start point on first 2 planes:
    //For now convert start point wire in cm back to wire number
    //Round to integer (sometimes output is double...why???)
    int startWire1 = int( clusters.at(0)->GetParams().start_point.w / _w2cm );
    double startTime1 = clusters.at(0)->GetParams().start_point.t;
    unsigned int Pl1 = clusters.at(0)->GetParams().start_point.plane;
    int startWire2 = int( clusters.at(1)->GetParams().start_point.w / _w2cm );
    double startTime2 = clusters.at(1)->GetParams().start_point.t;
    unsigned int Pl2 = clusters.at(1)->GetParams().start_point.plane;
    int startWire3 = int( clusters.at(2)->GetParams().start_point.w / _w2cm );
    double startTime3 = clusters.at(2)->GetParams().start_point.t;
    unsigned int Pl3 = clusters.at(2)->GetParams().start_point.plane;

    unsigned int cryo=0;
    unsigned int tpc =0;

    //Get Intersections in pairs:
    //y and z indicate detector coordinate and numbers indicate planes
    //used to generate that intersection point
    double yS12, zS12, yS13, zS13, yS23, zS23;
    
    art::ServiceHandle<geo::Geometry> geo;
    geo->IntersectionPoint( startWire1, startWire2,
                            Pl1, Pl2,
                            cryo, tpc,
                            yS12, zS12);

    geo->IntersectionPoint( startWire1, startWire3,
                            Pl1, Pl3,
                            cryo, tpc,
                            yS13, zS13);

    geo->IntersectionPoint( startWire2, startWire3,
                            Pl2, Pl3,
                            cryo, tpc,
                            yS23, zS23);

    if ( _verbose ){
      std::cout << "Wire Start Numbers: " << std::endl;
      std::cout << "\t" << startWire1 << std::endl;
      std::cout << "\t" << startWire2 << std::endl;
      std::cout << "\t" << startWire3 << std::endl;
      std::cout << std::endl;
    }

    if ( _verbose ){
      std::cout << "Intersection Pl1-Pl3: ( " << yS13 << ", " << zS13 << " )" << std::endl;  
      std::cout << "Intersection Pl1-Pl2: ( " << yS12 << ", " << zS12 << " )" << std::endl;  
      std::cout << "Intersection Pl2-Pl3: ( " << yS23 << ", " << zS23 << " )" << std::endl;  
    }

    //Parameter used for evaluation is area of triangle formed by the three intersection points
    double area = -1;
    if ( !_time ){
      area = Area2D( yS12, zS12, yS23, zS23, yS13, zS13 );
    }
    if ( _time ){
      area = Area3D( (yS12+yS13)/2. , (zS12+zS13)/2. , startTime1,
                     (yS13+yS23)/2. , (zS13+zS23)/2. , startTime3,
                     (yS12+yS23)/2. , (zS13+zS23)/2. , startTime2 );
    }
    
    if ( _verbose ) { std::cout << "Area of intersections triangle is: " << area << std::endl; }

    if ( area > _MaxArea )
      return -1;
    else
      return 1./area;

  }

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::CFAlgoStartPointMatch::Report ( )

virtual

Optional function: called after each iterative approach if a manager class is run with verbosity level <= kPerIteration. Maybe useful for debugging.

Reimplemented from cmtool::CMAlgoBase.

Definition at line 117 of file CFAlgoStartPointMatch.cxx.

Referenced by ~CFAlgoStartPointMatch().

  {

  }

void cmtool::CFAlgoStartPointMatch::Reset ( )

virtual

Function to reset the algorithm instance, called together with manager's Reset()

Reimplemented from cmtool::CMAlgoBase.

Definition at line 21 of file CFAlgoStartPointMatch.cxx.

Referenced by ~CFAlgoStartPointMatch().

  {

  }

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::CFAlgoStartPointMatch::SetMaxArea ( double  area )

inline

Definition at line 67 of file CFAlgoStartPointMatch.h.

References _MaxArea.

Referenced by CFAlgoStartPointMatch().

{ _MaxArea = area; }

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

void cmtool::CFAlgoStartPointMatch::UseTime ( bool  on )

inline

Definition at line 65 of file CFAlgoStartPointMatch.h.

References _time.

Referenced by CFAlgoStartPointMatch().

{ _time = on; }

Member Data Documentation

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::CFAlgoStartPointMatch::_MaxArea

private

Definition at line 94 of file CFAlgoStartPointMatch.h.

Referenced by Float(), and SetMaxArea().

double cmtool::CFAlgoStartPointMatch::_t2cm

private

Definition at line 93 of file CFAlgoStartPointMatch.h.

Referenced by CFAlgoStartPointMatch().

bool cmtool::CFAlgoStartPointMatch::_time

private

Definition at line 95 of file CFAlgoStartPointMatch.h.

Referenced by Float(), and UseTime().

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(), 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(), Float(), cmtool::CMAlgoBase::SetVerbose(), cmtool::CBAlgoShortestDist::ShortestDistanceSquared(), cmtool::CBAlgoShortestDistSmallCluster::ShortestDistanceSquared(), cmtool::CBAlgoCenterOfMassSmall::ShortestDistanceSquared(), and cmtool::CBAlgoCenterOfMass::ShortestDistanceSquared().

double cmtool::CFAlgoStartPointMatch::_w2cm

private

Optional function: called at the beginning of 1st iteration. This is called per event. Optional function: called at the end of event ... after the last merging iteration is over. Optional function: called at the beggining of each iterative loop. 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. Optional function: called at the end of each iterative loop.

Definition at line 93 of file CFAlgoStartPointMatch.h.

Referenced by CFAlgoStartPointMatch(), and Float().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larreco/v07_10_02/source/larreco/RecoAlg/CMTool/CMTAlgMatch/CFAlgoStartPointMatch.h
• /cvmfs/larsoft.opensciencegrid.org/products/larreco/v07_10_02/source/larreco/RecoAlg/CMTool/CMTAlgMatch/CFAlgoStartPointMatch.cxx