showerreco::ShowerRecoAlgBase Class Reference

#include "ShowerRecoAlgBase.h"

Inheritance diagram for showerreco::ShowerRecoAlgBase:

Public Member Functions
	ShowerRecoAlgBase ()
	Default constructor. More...
virtual	~ShowerRecoAlgBase ()
	Default destructor. More...
virtual void	Reset ()=0
	Function to reset algorithm, to be called @ beginning of each event. More...
virtual void	AppendInputClusters (const std::vector< cluster::ClusterParamsAlg > &cpan_v)
	Setter for a matched combination of clusters. More...
std::vector< recob::Shower >	Reconstruct ()
	Execute reconstruction. More...
virtual void	Verbose (bool on=true)
	Verbosity switch. More...
void	CaloAlgo (::calo::CalorimetryAlg *alg)
	Calorimetry algorithm setter. More...

Protected Member Functions
virtual void	ProcessInputClusters ()
	Function to reorganize input cluster information. More...
virtual ::recob::Shower	RecoOneShower (const std::vector< showerreco::ShowerCluster_t > &clusters)=0
	Function to reconstruct one shower. More...

Protected Attributes
bool	fVerbosity
	Verbosity flag. More...
::calo::CalorimetryAlg *	fCaloAlg
	Calorimetry algorithm. More...
std::vector< std::vector< showerreco::ShowerCluster_t > >	fInputClusters
	Input clusters. More...

Detailed Description

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

Definition at line 41 of file ShowerRecoAlgBase.h.

Constructor & Destructor Documentation

showerreco::ShowerRecoAlgBase::ShowerRecoAlgBase

(

)

Default constructor.

Definition at line 8 of file ShowerRecoAlgBase.cxx.

References fVerbosity.

                                       : fInputClusters()
  {
    fVerbosity = false;
  }

virtual showerreco::ShowerRecoAlgBase::~ShowerRecoAlgBase ( )

inlinevirtual

Default destructor.

Definition at line 49 of file ShowerRecoAlgBase.h.

References Reset().

{}

Member Function Documentation

void showerreco::ShowerRecoAlgBase::AppendInputClusters ( const std::vector< cluster::ClusterParamsAlg > &  cpan_v )

virtual

Setter for a matched combination of clusters.

Definition at line 18 of file ShowerRecoAlgBase.cxx.

References fInputClusters.

Referenced by showerreco::ShowerRecoManager::Process().

  {
    std::vector< ::showerreco::ShowerCluster_t> clusters;
    clusters.reserve(cpan_v.size());

    for(auto const& cpan : cpan_v) {

      clusters.push_back( ::showerreco::ShowerCluster_t() );

      (*clusters.rbegin()).start_point = cpan.GetParams().start_point;
      (*clusters.rbegin()).end_point   = cpan.GetParams().end_point;
      (*clusters.rbegin()).angle_2d    = cpan.GetParams().angle_2d;
      (*clusters.rbegin()).plane_id    = cpan.Plane();
      (*clusters.rbegin()).hit_vector  = cpan.GetHitVector();

    }

    fInputClusters.push_back(clusters);

  }

void showerreco::ShowerRecoAlgBase::CaloAlgo ( ::calo::CalorimetryAlg *  alg )

inline

Calorimetry algorithm setter.

Definition at line 64 of file ShowerRecoAlgBase.h.

Referenced by ShowerReco3D::ShowerReco3D().

{ fCaloAlg = alg; }

virtual void showerreco::ShowerRecoAlgBase::ProcessInputClusters ( )

inlineprotectedvirtual

Function to reorganize input cluster information.

Definition at line 69 of file ShowerRecoAlgBase.h.

Referenced by Reconstruct().

    { return; }

std::vector<::recob::Shower > showerreco::ShowerRecoAlgBase::Reconstruct

(

)

Execute reconstruction.

Definition at line 39 of file ShowerRecoAlgBase.cxx.

References fCaloAlg, fInputClusters, ProcessInputClusters(), and RecoOneShower().

Referenced by showerreco::ShowerRecoManager::Process().

  {

    if(!fCaloAlg) throw ShowerRecoException("Calorimetry algorithm must be provided!");

    ProcessInputClusters();

    std::vector< ::recob::Shower> output;

    output.reserve(fInputClusters.size());

    for(auto const& clusters : fInputClusters)

      output.push_back( RecoOneShower(clusters) );

    return output;

  }

virtual ::recob::Shower showerreco::ShowerRecoAlgBase::RecoOneShower ( const std::vector< showerreco::ShowerCluster_t > &  clusters )

protectedpure virtual

Function to reconstruct one shower.

Referenced by Reconstruct().

void showerreco::ShowerRecoAlgBase::Reset ( )

pure virtual

Function to reset algorithm, to be called @ beginning of each event.

Implemented in showerreco::ShowerRecoAlg.

Definition at line 13 of file ShowerRecoAlgBase.cxx.

References fInputClusters.

Referenced by showerreco::ShowerRecoAlg::Reset(), and showerreco::ShowerRecoManager::Reset().

  {
    fInputClusters.clear();
  }

virtual void showerreco::ShowerRecoAlgBase::Verbose ( bool  on = true )

inlinevirtual

Verbosity switch.

Definition at line 61 of file ShowerRecoAlgBase.h.

Referenced by ShowerReco3D::ShowerReco3D().

{ fVerbosity=on; }

Member Data Documentation

::calo::CalorimetryAlg* showerreco::ShowerRecoAlgBase::fCaloAlg

protected

Calorimetry algorithm.

Definition at line 81 of file ShowerRecoAlgBase.h.

Referenced by Reconstruct(), and showerreco::ShowerRecoAlg::RecoOneShower().

std::vector<std::vector<showerreco::ShowerCluster_t> > showerreco::ShowerRecoAlgBase::fInputClusters

protected

Input clusters.

Definition at line 84 of file ShowerRecoAlgBase.h.

Referenced by AppendInputClusters(), Reconstruct(), and Reset().

bool showerreco::ShowerRecoAlgBase::fVerbosity

protected

Verbosity flag.

Definition at line 78 of file ShowerRecoAlgBase.h.

Referenced by showerreco::ShowerRecoAlg::RecoOneShower(), showerreco::ShowerRecoAlg::ShowerRecoAlg(), and ShowerRecoAlgBase().

---

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

• larreco/v06_64_02/source/larreco/ShowerFinder/ShowerReco3D/ShowerRecoAlgBase.h
• larreco/v06_64_02/source/larreco/ShowerFinder/ShowerReco3D/ShowerRecoAlgBase.cxx