LArSoft  v07_13_02
Liquid Argon Software toolkit - http://larsoft.org/
geo::StandardGeometryHelper Class Reference

Simple implementation of channel mapping. More...

#include "StandardGeometryHelper.h"

Inheritance diagram for geo::StandardGeometryHelper:
geo::ExptGeoHelperInterface

Public Types

using ChannelMapAlgPtr_t = std::shared_ptr< const ChannelMapAlg >
 

Public Member Functions

 StandardGeometryHelper (fhicl::ParameterSet const &pset, art::ActivityRegistry &reg)
 Constructor; follows the standard art service signature. More...
 
void ConfigureChannelMapAlg (fhicl::ParameterSet const &sortingParameters, geo::GeometryCore *geom)
 Configure and initialize the channel map. More...
 
ChannelMapAlgPtr_t GetChannelMapAlg () const
 

Private Member Functions

virtual void doConfigureChannelMapAlg (fhicl::ParameterSet const &sortingParameters, geo::GeometryCore *geom) override
 Implementation of ConfigureChannelMapAlg (pure virtual) More...
 
virtual ChannelMapAlgPtr_t doGetChannelMapAlg () const override
 Returns the ChannelMapAlg. More...
 

Private Attributes

fhicl::ParameterSet fPset
 copy of configuration parameter set More...
 
std::shared_ptr< geo::ChannelMapAlgfChannelMap
 channel map algorithm More...
 

Detailed Description

Simple implementation of channel mapping.

This ExptGeoHelperInterface implementation serves a ChannelMapStandardAlg for experiments that are known to work well with it.

Definition at line 30 of file StandardGeometryHelper.h.

Member Typedef Documentation

using geo::ExptGeoHelperInterface::ChannelMapAlgPtr_t = std::shared_ptr<const ChannelMapAlg>
inherited

Definition at line 64 of file ExptGeoHelperInterface.h.

Constructor & Destructor Documentation

geo::StandardGeometryHelper::StandardGeometryHelper ( fhicl::ParameterSet const &  pset,
art::ActivityRegistry reg 
)

Constructor; follows the standard art service signature.

Definition at line 23 of file StandardGeometryHelper_service.cc.

References doConfigureChannelMapAlg().

24  : fPset( pset )
25  , fChannelMap()
26  {}
fhicl::ParameterSet fPset
copy of configuration parameter set
std::shared_ptr< geo::ChannelMapAlg > fChannelMap
channel map algorithm

Member Function Documentation

void geo::ExptGeoHelperInterface::ConfigureChannelMapAlg ( fhicl::ParameterSet const &  sortingParameters,
geo::GeometryCore geom 
)
inlineinherited

Configure and initialize the channel map.

Parameters
sortingParametersparameters for the channel map algorithm
geompointer to a geometry description object
Returns
a (shared) pointer to the channel mapping algorithm

This method creates a new ChannelMapAlg according to the geometry and specified configuration, then it configures the geometry itself according to the channel map (usually, it resorts the data).

Definition at line 107 of file ExptGeoHelperInterface.h.

References geo::ExptGeoHelperInterface::doConfigureChannelMapAlg().

108  {
109  doConfigureChannelMapAlg(sortingParameters, geom);
110  }
virtual void doConfigureChannelMapAlg(fhicl::ParameterSet const &sortingParameters, geo::GeometryCore *geom)=0
Implementation of ConfigureChannelMapAlg (pure virtual)
void geo::StandardGeometryHelper::doConfigureChannelMapAlg ( fhicl::ParameterSet const &  sortingParameters,
geo::GeometryCore geom 
)
overrideprivatevirtual

Implementation of ConfigureChannelMapAlg (pure virtual)

Implements geo::ExptGeoHelperInterface.

Definition at line 31 of file StandardGeometryHelper_service.cc.

References geo::GeometryCore::ApplyChannelMap().

Referenced by StandardGeometryHelper().

32  {
33  mf::LogInfo("StandardGeometryHelper")
34  << "Loading channel mapping: ChannelMapStandardAlg";
36  = std::make_shared<geo::ChannelMapStandardAlg>(sortingParameters);
38 
39  } // StandardGeometryHelper::doConfigureChannelMapAlg()
MaybeLogger_< ELseverityLevel::ELsev_info, false > LogInfo
void ApplyChannelMap(std::shared_ptr< geo::ChannelMapAlg > pChannelMap)
Initializes the geometry to work with this channel map.
std::shared_ptr< geo::ChannelMapAlg > fChannelMap
channel map algorithm
StandardGeometryHelper::ChannelMapAlgPtr_t geo::StandardGeometryHelper::doGetChannelMapAlg ( ) const
overrideprivatevirtual

Returns the ChannelMapAlg.

Implements geo::ExptGeoHelperInterface.

Definition at line 44 of file StandardGeometryHelper_service.cc.

References DEFINE_ART_SERVICE_INTERFACE_IMPL, and fChannelMap.

45  {
46  return fChannelMap;
47  }
std::shared_ptr< geo::ChannelMapAlg > fChannelMap
channel map algorithm
ExptGeoHelperInterface::ChannelMapAlgPtr_t geo::ExptGeoHelperInterface::GetChannelMapAlg ( ) const
inlineinherited

Returns null pointer if the initialization failed NOTE: the sub-class owns the ChannelMapAlg object

Definition at line 114 of file ExptGeoHelperInterface.h.

References DECLARE_ART_SERVICE_INTERFACE, and geo::ExptGeoHelperInterface::doGetChannelMapAlg().

115  {
116  return doGetChannelMapAlg();
117  }
virtual ChannelMapAlgPtr_t doGetChannelMapAlg() const =0
Returns the ChannelMapAlg.

Member Data Documentation

std::shared_ptr<geo::ChannelMapAlg> geo::StandardGeometryHelper::fChannelMap
private

channel map algorithm

Definition at line 60 of file StandardGeometryHelper.h.

Referenced by doGetChannelMapAlg().

fhicl::ParameterSet geo::StandardGeometryHelper::fPset
private

copy of configuration parameter set

Definition at line 59 of file StandardGeometryHelper.h.


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