cluster::ClusterMergeHelper Class Reference

#include "ClusterMergeHelper.h"

Public Member Functions
	ClusterMergeHelper ()
	Default constructor with fhicl parameters. More...
virtual	~ClusterMergeHelper ()
	Default destructor. More...
::cmtool::CMergeManager &	GetManager ()
	A method to retrieve Manager. More...
void	SetClusters (const std::vector< std::vector< art::Ptr< recob::Hit > > > &clusters)
	Utility method to set cluster input information to CMergeManager from LArSoft data product (vector of recob::Hit art::Ptr) More...
void	SetClusters (const art::Event &evt, const std::string &cluster_module_label)
	Utility method to set cluster input information to CMerteManager from art::Event and cluster data product label. More...
void	Process ()
	Function to execute CMergeManager::Process() More...
const std::vector< std::vector< art::Ptr< recob::Hit > > > &	GetMergedClusterHits () const
	Utility method to retrieve merged clusters in terms of a vector of art::Ptr<recob::Hit> More...
const std::vector< cluster::ClusterParamsAlg > &	GetMergedCPAN () const
	Utility method to retrieve merged clusters in terms of a vector of CPAN. More...
void	AppendResult (art::EDProducer &ed, art::Event &ev, std::vector< recob::Cluster > &out_clusters, art::Assns< recob::Cluster, recob::Hit > &assns) const
	Utility method to append result set to user's data product storage. More...

Protected Member Functions
void	SetClusters (const std::vector< std::vector< util::PxHit > > &clusters)
	Internal method to transfer input cluster information in the right format to CMergeManager. More...

Protected Attributes
::cmtool::CMergeManager	fMgr
	CMergeManager instance. More...
::util::GeometryUtilities	fGeoU
	GeometryUtilities. More...
std::vector< std::vector< art::Ptr< recob::Hit > > >	fInputClusters
	Input clusters in terms of a vector of art::Ptr<recob::Hit> collection. More...
std::vector< std::vector< art::Ptr< recob::Hit > > >	fOutputClusters
	Output clusters in terms of a vector of art::Ptr<recob::Hit> collection. More...

Detailed Description

Definition at line 46 of file ClusterMergeHelper.h.

Constructor & Destructor Documentation

cluster::ClusterMergeHelper::ClusterMergeHelper ( )

inline

Default constructor with fhicl parameters.

Definition at line 51 of file ClusterMergeHelper.h.

{};

virtual cluster::ClusterMergeHelper::~ClusterMergeHelper ( )

inlinevirtual

Default destructor.

Definition at line 54 of file ClusterMergeHelper.h.

{}

Member Function Documentation

void cluster::ClusterMergeHelper::AppendResult	(	art::EDProducer &	ed,
		art::Event &	ev,
		std::vector< recob::Cluster > &	out_clusters,
		art::Assns< recob::Cluster, recob::Hit > &	assns
	)		const

Utility method to append result set to user's data product storage.

Definition at line 154 of file ClusterMergeHelper.cxx.

References util::CreateAssn(), cluster::cluster_params::end_point, cluster::LazyClusterParamsAlg::EndAngle(), cluster::LazyClusterParamsAlg::EndCharge(), cluster::LazyClusterParamsAlg::EndOpeningAngle(), fGeoU, fOutputClusters, GetMergedClusterHits(), GetMergedCPAN(), hits(), cluster::LazyClusterParamsAlg::Integral(), cluster::LazyClusterParamsAlg::IntegralStdDev(), cluster::LazyClusterParamsAlg::MultipleHitDensity(), cluster::LazyClusterParamsAlg::NHits(), geo::GeometryCore::Plane(), recob::Cluster::Sentry, cluster::cluster_params::start_point, cluster::LazyClusterParamsAlg::StartAngle(), cluster::LazyClusterParamsAlg::StartCharge(), cluster::LazyClusterParamsAlg::StartOpeningAngle(), cluster::LazyClusterParamsAlg::SummedADC(), cluster::LazyClusterParamsAlg::SummedADCStdDev(), util::PxPoint::t, util::GeometryUtilities::TimeToCm(), cluster::details::Measure_t< T >::value(), geo::PlaneGeo::View(), util::PxPoint::w, cluster::LazyClusterParamsAlg::Width(), and util::GeometryUtilities::WireToCm().

Referenced by GetManager().

  {

    if(!fOutputClusters.size()) 

      throw cet::exception(__FUNCTION__) 
        << "\033[93m"
        << "You must call Process() before calling " << __FUNCTION__ << " to retrieve result."
        << "\033[00m"
        << std::endl;

    
    art::ServiceHandle<geo::Geometry> geo;
    
    // Store output
    for(size_t out_index=0; out_index < GetMergedCPAN().size(); ++out_index) {
      
      // To save typing let's just retrieve const cluster_params instance
      const cluster_params &res = GetMergedCPAN().at(out_index).GetParams();
      
      // this "algo" is actually parroting its cluster_params
      LazyClusterParamsAlg algo(res);
      
      std::vector<art::Ptr<recob::Hit>> const& hits
        = GetMergedClusterHits().at(out_index);
      
      // the full plane needed but not a part of cluster_params...
      // get the one from the first hit
      geo::PlaneID plane; // invalid by default
      if (!hits.empty()) plane = hits.front()->WireID().planeID();
      
      // View_t needed but not a part of cluster_params, so retrieve it here
      geo::View_t view_id = geo->Plane(plane).View();
      
      // Push back a new cluster data product with parameters copied from cluster_params
      out_clusters.emplace_back(
        res.start_point.w / fGeoU.WireToCm(), // start_wire
        0.,                                   // sigma_start_wire
        res.start_point.t / fGeoU.TimeToCm(), // start_tick
        0.,                                   // sigma_start_tick
        algo.StartCharge().value(),           // start_charge
        algo.StartAngle().value(),            // start_angle
        algo.StartOpeningAngle().value(),     // start_opening
        res.end_point.w   / fGeoU.WireToCm(), // end_wire
        0.,                                   // sigma_end_wire
        res.end_point.t   / fGeoU.TimeToCm(), // end_tick
        0.,                                   // sigma_end_tick
        algo.EndCharge().value(),             // end_charge
        algo.EndAngle().value(),              // end_angle
        algo.EndOpeningAngle().value(),       // end_opening
        algo.Integral().value(),              // integral
        algo.IntegralStdDev().value(),        // integral_stddev
        algo.SummedADC().value(),             // summedADC
        algo.SummedADCStdDev().value(),       // summedADC_stddev
        algo.NHits(),                         // n_hits
        algo.MultipleHitDensity(),              // multiple_hit_density
        algo.Width(),                         // width
        out_clusters.size(),                  // ID
        view_id,                              // view
        plane,                                // plane
        recob::Cluster::Sentry                // sentry
        );
      
      util::CreateAssn(ed,
                       ev, 
                       out_clusters,
                       GetMergedClusterHits().at(out_index), 
                       assns
                       );
    }
    
  }

::cmtool::CMergeManager& cluster::ClusterMergeHelper::GetManager ( )

inline

A method to retrieve Manager.

Definition at line 57 of file ClusterMergeHelper.h.

References AppendResult(), tca::evt, fMgr, GetMergedClusterHits(), GetMergedCPAN(), Process(), SetClusters(), and lar::dump::vector().

{ return fMgr; }

const std::vector< std::vector< art::Ptr< recob::Hit > > > & cluster::ClusterMergeHelper::GetMergedClusterHits

(

)

const

Utility method to retrieve merged clusters in terms of a vector of art::Ptr<recob::Hit>

Definition at line 125 of file ClusterMergeHelper.cxx.

References fOutputClusters.

Referenced by AppendResult(), and GetManager().

  { 
    if(!fOutputClusters.size()) 

      throw cet::exception(__FUNCTION__) 
        << "\033[93m"
        << "You must call Process() before calling " << __FUNCTION__ << " to retrieve result."
        << "\033[00m"
        << std::endl;

    return fOutputClusters;
  }

const std::vector< cluster::ClusterParamsAlg > & cluster::ClusterMergeHelper::GetMergedCPAN

(

)

const

Utility method to retrieve merged clusters in terms of a vector of CPAN.

Definition at line 140 of file ClusterMergeHelper.cxx.

References fMgr, fOutputClusters, and cmtool::CMergeManager::GetClusters().

Referenced by AppendResult(), and GetManager().

  {
    if(!fOutputClusters.size()) 

      throw cet::exception(__FUNCTION__) 
        << "\033[93m"
        << "You must call Process() before calling " << __FUNCTION__ << " to retrieve result."
        << "\033[00m"
        << std::endl;

    return fMgr.GetClusters();
  }

void cluster::ClusterMergeHelper::Process

(

)

Function to execute CMergeManager::Process()

Definition at line 82 of file ClusterMergeHelper.cxx.

References fInputClusters, fMgr, fOutputClusters, cmtool::CMergeManager::GetBookKeeper(), cmtool::CMergeManager::GetClusters(), cmtool::CMergeBookKeeper::GetResult(), and cmtool::CMManagerBase::Process().

Referenced by GetManager().

  {
    if(fMgr.GetClusters().size()) 

      throw cet::exception(__PRETTY_FUNCTION__) << "\033[93m"
                                                << "Merged cluster set not empty... Called Process() twice?"
                                                << "\033[00m"
                                                << std::endl;

    // Process
    fMgr.Process();

    // Now create output clusters
    auto res = fMgr.GetBookKeeper();
    
    std::vector<std::vector<unsigned short> > out_clusters = res.GetResult();

    fOutputClusters.clear();
    
    fOutputClusters.reserve(out_clusters.size());

    for(auto const &cluster_index_v : out_clusters) {
      
      std::vector<art::Ptr<recob::Hit> > out_cluster;

      for(auto const& cluster_index : cluster_index_v) {

        out_cluster.reserve(out_cluster.size() + fInputClusters.at(cluster_index).size());

        for(auto const& hit_ptr : fInputClusters.at(cluster_index))

          out_cluster.push_back(hit_ptr);

      }

      fOutputClusters.push_back(out_cluster);

    }

  }

void cluster::ClusterMergeHelper::SetClusters

(

const std::vector< std::vector< art::Ptr< recob::Hit > > > &

clusters

)

Utility method to set cluster input information to CMergeManager from LArSoft data product (vector of recob::Hit art::Ptr)

Definition at line 17 of file ClusterMergeHelper.cxx.

References fGeoU, fInputClusters, fOutputClusters, util::GeometryUtilities::TimeToCm(), and util::GeometryUtilities::WireToCm().

Referenced by GetManager(), and SetClusters().

  {
    fInputClusters.clear();
    fOutputClusters.clear();

    std::vector<std::vector<util::PxHit> > px_clusters(clusters.size(),std::vector<util::PxHit>());

    fInputClusters.resize(clusters.size(),std::vector<art::Ptr<recob::Hit> >());

    for(size_t cluster_index=0; cluster_index < clusters.size(); ++cluster_index) {

      px_clusters.at(cluster_index).resize(clusters.at(cluster_index).size(),util::PxHit());

      fInputClusters.at(cluster_index).resize(clusters.at(cluster_index).size());

      for(size_t hit_index=0; hit_index < clusters.at(cluster_index).size(); ++hit_index) {
        
        px_clusters.at(cluster_index).at(hit_index).plane  = clusters.at(cluster_index).at(hit_index)->WireID().Plane;
        px_clusters.at(cluster_index).at(hit_index).w      = clusters.at(cluster_index).at(hit_index)->WireID().Wire * fGeoU.WireToCm();
        px_clusters.at(cluster_index).at(hit_index).t      = clusters.at(cluster_index).at(hit_index)->PeakTime() * fGeoU.TimeToCm();
        px_clusters.at(cluster_index).at(hit_index).charge = clusters.at(cluster_index).at(hit_index)->Integral();

        fInputClusters.at(cluster_index).at(hit_index) = clusters.at(cluster_index).at(hit_index);

      }
      
    }

    SetClusters(px_clusters);

  }

void cluster::ClusterMergeHelper::SetClusters	(	const art::Event &	evt,
		const std::string &	cluster_module_label
	)

Utility method to set cluster input information to CMerteManager from art::Event and cluster data product label.

Definition at line 51 of file ClusterMergeHelper.cxx.

References art::DataViewImpl::getByLabel(), art::Handle< T >::isValid(), and SetClusters().

  {

    art::Handle<std::vector<recob::Cluster> >  clusters_h;
    evt.getByLabel(cluster_module_label, clusters_h);

    if(!(clusters_h.isValid()))

      throw cet::exception(__FUNCTION__) 
        << "\033[93m"
        << " Failed to retrieve recob::Cluster with label: " 
        << cluster_module_label.c_str()
        << "\033[00m"
        << std::endl;

    std::vector<std::vector<art::Ptr<recob::Hit> > > cluster_hits_v;

    cluster_hits_v.reserve(clusters_h->size());

    art::FindManyP<recob::Hit> hit_m(clusters_h, evt, cluster_module_label);

    for(size_t i=0; i<clusters_h->size(); ++i)

      cluster_hits_v.push_back(hit_m.at(i));

    SetClusters(cluster_hits_v);
    
  }

void cluster::ClusterMergeHelper::SetClusters ( const std::vector< std::vector< util::PxHit > > &  clusters )

inlineprotected

Internal method to transfer input cluster information in the right format to CMergeManager.

Definition at line 83 of file ClusterMergeHelper.h.

References fMgr, cmtool::CMergeManager::Reset(), and cmtool::CMManagerBase::SetClusters().

    { 
      fMgr.Reset();
      fMgr.SetClusters(clusters); 
    }

Member Data Documentation

::util::GeometryUtilities cluster::ClusterMergeHelper::fGeoU

protected

GeometryUtilities.

Definition at line 95 of file ClusterMergeHelper.h.

Referenced by AppendResult(), and SetClusters().

std::vector<std::vector<art::Ptr<recob::Hit> > > cluster::ClusterMergeHelper::fInputClusters

protected

Input clusters in terms of a vector of art::Ptr<recob::Hit> collection.

Definition at line 98 of file ClusterMergeHelper.h.

Referenced by Process(), and SetClusters().

::cmtool::CMergeManager cluster::ClusterMergeHelper::fMgr

protected

CMergeManager instance.

Definition at line 92 of file ClusterMergeHelper.h.

Referenced by GetManager(), GetMergedCPAN(), Process(), and SetClusters().

std::vector<std::vector<art::Ptr<recob::Hit> > > cluster::ClusterMergeHelper::fOutputClusters

protected

Output clusters in terms of a vector of art::Ptr<recob::Hit> collection.

Definition at line 101 of file ClusterMergeHelper.h.

Referenced by AppendResult(), GetMergedClusterHits(), GetMergedCPAN(), Process(), and SetClusters().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larreco/v07_10_02/source/larreco/RecoAlg/ClusterMergeHelper.h
• /cvmfs/larsoft.opensciencegrid.org/products/larreco/v07_10_02/source/larreco/RecoAlg/ClusterMergeHelper.cxx