LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
Public Member Functions | List of all members
lar_cluster3d::IClusterParametersBuilder Class Referenceabstract

ClusterParamsBuilder class definiton. More...

#include "IClusterParamsBuilder.h"

Inheritance diagram for lar_cluster3d::IClusterParametersBuilder:
lar_cluster3d::ClusterParamsBuilder

Public Member Functions

virtual ~IClusterParametersBuilder () noexcept=default
 Destructor. More...
 
virtual void configure (const fhicl::ParameterSet &)=0
 
virtual void BuildClusterInfo (reco::ClusterParametersList &clusterParametersList) const =0
 Given the results of running DBScan, format the clusters so that they can be easily transferred back to the larsoft world. More...
 
virtual void FillClusterParams (reco::ClusterParameters &, reco::Hit2DToClusterMap &, double minUniqueFrac=0., double maxLostFrac=1.) const =0
 Fill the cluster parameters (expose to outside world for case of splitting/merging clusters) More...
 

Detailed Description

ClusterParamsBuilder class definiton.

Definition at line 26 of file IClusterParamsBuilder.h.

Constructor & Destructor Documentation

virtual lar_cluster3d::IClusterParametersBuilder::~IClusterParametersBuilder ( )
virtualdefaultnoexcept

Destructor.

Member Function Documentation

virtual void lar_cluster3d::IClusterParametersBuilder::BuildClusterInfo ( reco::ClusterParametersList &  clusterParametersList) const
pure virtual

Given the results of running DBScan, format the clusters so that they can be easily transferred back to the larsoft world.

Parameters
hitPairClusterMapmap between view and a list of 3D hits
clusterParametersLista container for our candidate 3D clusters
rejectionFractionUsed for determine "hit purity" when rejecting clusters 
                          The last two parameters are passed through to the IClusterParamsBuilder method

Implemented in lar_cluster3d::ClusterParamsBuilder.

virtual void lar_cluster3d::IClusterParametersBuilder::configure ( const fhicl::ParameterSet &  )
pure virtual

Implemented in lar_cluster3d::ClusterParamsBuilder.

virtual void lar_cluster3d::IClusterParametersBuilder::FillClusterParams ( reco::ClusterParameters &  ,
reco::Hit2DToClusterMap &  ,
double  minUniqueFrac = 0.,
double  maxLostFrac = 1. 
) const
pure virtual

Fill the cluster parameters (expose to outside world for case of splitting/merging clusters)

Parameters
ClusterParametersThe cluster parameters container to be modified
Hit2DToClusterMapMap to keep track of 2D hit to cluster association
doubleminimum fraction of unique hits
doublemaximum fraction of "lost" hits

Implemented in lar_cluster3d::ClusterParamsBuilder.

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