ClusterMergeHelper.h

Go to the documentation of this file.

////////////////////////////////////////////////////////////////////////
// \file ClusterMergeHelper.h
//
// \brief ClusterMergeHelper header file
//
// \author kazuhiro@nevis.columbia.edu
//
////////////////////////////////////////////////////////////////////////

#ifndef CLUSTERMERGEHELPER_H
#define CLUSTERMERGEHELPER_H

// ART includes
#include "art/Framework/Principal/fwd.h"
#include "canvas/Persistency/Common/Assns.h"
#include "canvas/Persistency/Common/Ptr.h"
#include "fhiclcpp/fwd.h"

// LArSoft
#include "lardata/Utilities/GeometryUtilities.h"
#include "lardataobj/RecoBase/Cluster.h"
#include "lardataobj/RecoBase/Hit.h"
#include "larreco/RecoAlg/CMTool/CMToolBase/CMergeManager.h"
#include "larreco/RecoAlg/ClusterRecoUtil/ClusterParamsAlg.h"

// STL
#include <vector>

namespace util {
  class GeometryUtilities;
}

namespace cluster {

  class ClusterMergeHelper {
  public:
    ::cmtool::CMergeManager&
    GetManager()
    {
      return fMgr;
    }

    /// Utility method to set cluster input information to CMergeManager from LArSoft data product (vector of recob::Hit art::Ptr)
    void SetClusters(util::GeometryUtilities const& gser,
                     const std::vector<std::vector<art::Ptr<recob::Hit>>>& clusters);

    /// Utility method to set cluster input information to CMerteManager from art::Event and cluster data product label
    void SetClusters(util::GeometryUtilities const& gser,
                     const art::Event& evt,
                     const std::string& cluster_module_label);

    /// Function to execute CMergeManager::Process()
    void Process(util::GeometryUtilities const& gser);

    /// Utility method to retrieve merged clusters in terms of a vector of art::Ptr<recob::Hit>
    const std::vector<std::vector<art::Ptr<recob::Hit>>>& GetMergedClusterHits() const;

    /// Utility method to retrieve merged clusters in terms of a vector of CPAN
    const std::vector<cluster::ClusterParamsAlg>& GetMergedCPAN() const;

    /// Utility method to append result set to user's data product storage
    void AppendResult(util::GeometryUtilities const& gser,
                      art::Event& ev,
                      std::vector<recob::Cluster>& out_clusters,
                      art::Assns<recob::Cluster, recob::Hit>& assns) const;

  protected:
    /// Internal method to transfer input cluster information in the right format to CMergeManager
    void
    SetClusters(util::GeometryUtilities const& gser,
                const std::vector<std::vector<util::PxHit>>& clusters)
    {
      fMgr.Reset();
      fMgr.SetClusters(gser, clusters);
    }

  protected:
    /// CMergeManager instance
    ::cmtool::CMergeManager fMgr;

    /// GeometryUtilities
    ::util::GeometryUtilities fGeoU;

    /// Input clusters in terms of a vector of art::Ptr<recob::Hit> collection
    std::vector<std::vector<art::Ptr<recob::Hit>>> fInputClusters;

    /// Output clusters in terms of a vector of art::Ptr<recob::Hit> collection
    std::vector<std::vector<art::Ptr<recob::Hit>>> fOutputClusters;

  }; // class ClusterMergeHelper

} //namespace cluster
#endif