cmtool::CPAlgoIgnoreTracks Class Reference

#include "CPAlgoIgnoreTracks.h"

Inheritance diagram for cmtool::CPAlgoIgnoreTracks:

Public Member Functions
	CPAlgoIgnoreTracks ()
	Default constructor. More...
virtual	~CPAlgoIgnoreTracks ()
	Default destructor. More...
virtual float	Priority (const ::cluster::ClusterParamsAlg &cluster)
virtual void	Report ()
virtual void	Reset ()
	Function to reset the algorithm instance, called together with manager's Reset() More...
bool	IsTrack (const ::cluster::ClusterParamsAlg &cluster)
	Function to check if cluster is a track. More...
void	SetMinHits (size_t BAKA)
	Setter for track-like parameters. More...
void	SetMinModHitDens (Double_t AHO)
void	SetMinMHitWires (Double_t BOKE)
void	SetMinPrincipal (Double_t HEKOKI)
virtual float	Priority (const cluster::ClusterParamsAlg &cluster)
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
size_t	_min_hits
Double_t	_min_mod_hit_dens
Double_t	_min_multihit_wires
Double_t	_min_principal
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 implementation for CPriorityAlgoBase class doxygen documentation!

Definition at line 25 of file CPAlgoIgnoreTracks.h.

Constructor & Destructor Documentation

cmtool::CPAlgoIgnoreTracks::CPAlgoIgnoreTracks

(

)

Default constructor.

Definition at line 9 of file CPAlgoIgnoreTracks.cxx.

References SetMinHits(), SetMinMHitWires(), SetMinModHitDens(), and SetMinPrincipal().

                                         : CPriorityAlgoBase()
  //----------------------------------------------------------
  {
    SetMinHits(20);
    SetMinModHitDens(1.4);
    SetMinMHitWires(3.5);
    //"fPrincipal" is log(1-eigenvalue_principal)
    // >-7 means EP > 0.99908
    SetMinPrincipal(-6.);
  }

virtual cmtool::CPAlgoIgnoreTracks::~CPAlgoIgnoreTracks ( )

inlinevirtual

Default destructor.

Definition at line 33 of file CPAlgoIgnoreTracks.h.

References IsTrack(), Priority(), Report(), and Reset().

{};

Member Function Documentation

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

bool cmtool::CPAlgoIgnoreTracks::IsTrack

(

const ::cluster::ClusterParamsAlg &

cluster

)

Function to check if cluster is a track.

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 49 of file CPAlgoIgnoreTracks.cxx.

References _min_mod_hit_dens, _min_multihit_wires, and _min_principal.

Referenced by Priority(), and ~CPAlgoIgnoreTracks().

  {
    double fPrincipal = TMath::Log(1-cluster.GetParams().eigenvalue_principal);

    bool isTrack = false;
    if(//cluster.GetNHits() > _min_hits &&
       cluster.GetParams().modified_hit_density < _min_mod_hit_dens ||
       cluster.GetParams().multi_hit_wires < _min_multihit_wires ||
       fPrincipal < _min_principal)
      isTrack = true;

    return isTrack;
  }

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 float cmtool::CPriorityAlgoBase::Priority ( const cluster::ClusterParamsAlg &  cluster )

inlinevirtualinherited

Core function: given the CPAN input, return whether a cluster should be merged or not.

Definition at line 40 of file CPriorityAlgoBase.h.

References cluster::ClusterParamsAlg::GetNHits().

Referenced by cmtool::CMManagerBase::ComputePriority().

    { 
      if(cluster.GetNHits()) return 1.;
      return 0.1;
    }

float cmtool::CPAlgoIgnoreTracks::Priority ( const ::cluster::ClusterParamsAlg &  cluster )

virtual

Core function: given the CPAN input, return a float which indicates the user-defined priority for analysis.

Definition at line 28 of file CPAlgoIgnoreTracks.cxx.

References IsTrack().

Referenced by ~CPAlgoIgnoreTracks().

  {
    //return -1 for tracks, otherwise return nhits
    auto nhit = cluster.GetNHits();
    
    //NOTE! default return value for non-track clusters is nhits
    //but if you want to sort by a different way, use a separate
    //CPAlgo in an array with this one, and use the kLastAlgo option
    //to sort by that algo and still remove tracks!
    return ( IsTrack(cluster) ? -1 : (float)nhit );
  }

void cmtool::CPAlgoIgnoreTracks::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 42 of file CPAlgoIgnoreTracks.cxx.

Referenced by ~CPAlgoIgnoreTracks().

  {

  }

void cmtool::CPAlgoIgnoreTracks::Reset ( )

virtual

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

Reimplemented from cmtool::CMAlgoBase.

Definition at line 21 of file CPAlgoIgnoreTracks.cxx.

Referenced by ~CPAlgoIgnoreTracks().

  {

  }

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::CPAlgoIgnoreTracks::SetMinHits ( size_t  BAKA )

inline

Setter for track-like parameters.

Definition at line 82 of file CPAlgoIgnoreTracks.h.

References _min_hits.

Referenced by CPAlgoIgnoreTracks().

{ _min_hits = BAKA; }

void cmtool::CPAlgoIgnoreTracks::SetMinMHitWires ( Double_t  BOKE )

inline

Definition at line 84 of file CPAlgoIgnoreTracks.h.

References _min_multihit_wires.

Referenced by CPAlgoIgnoreTracks().

{ _min_multihit_wires = BOKE; }

void cmtool::CPAlgoIgnoreTracks::SetMinModHitDens ( Double_t  AHO )

inline

Definition at line 83 of file CPAlgoIgnoreTracks.h.

References _min_mod_hit_dens.

Referenced by CPAlgoIgnoreTracks().

{ _min_mod_hit_dens = AHO; }

void cmtool::CPAlgoIgnoreTracks::SetMinPrincipal ( Double_t  HEKOKI )

inline

Definition at line 85 of file CPAlgoIgnoreTracks.h.

References _min_principal.

Referenced by CPAlgoIgnoreTracks().

{ _min_principal = HEKOKI; }

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

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

size_t cmtool::CPAlgoIgnoreTracks::_min_hits

protected

Definition at line 90 of file CPAlgoIgnoreTracks.h.

Referenced by SetMinHits().

Double_t cmtool::CPAlgoIgnoreTracks::_min_mod_hit_dens

protected

Definition at line 91 of file CPAlgoIgnoreTracks.h.

Referenced by IsTrack(), and SetMinModHitDens().

Double_t cmtool::CPAlgoIgnoreTracks::_min_multihit_wires

protected

Definition at line 92 of file CPAlgoIgnoreTracks.h.

Referenced by IsTrack(), and SetMinMHitWires().

Double_t cmtool::CPAlgoIgnoreTracks::_min_principal

protected

Definition at line 93 of file CPAlgoIgnoreTracks.h.

Referenced by IsTrack(), and SetMinPrincipal().

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

---

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

• larreco/v06_64_02/source/larreco/RecoAlg/CMTool/CMTAlgPriority/CPAlgoIgnoreTracks.h
• larreco/v06_64_02/source/larreco/RecoAlg/CMTool/CMTAlgPriority/CPAlgoIgnoreTracks.cxx