geo::StandardGeometryHelper Class Reference

Simple implementation of channel mapping. More...

#include "StandardGeometryHelper.h"

Inheritance diagram for geo::StandardGeometryHelper:

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::ChannelMapAlg >	fChannelMap
	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().

    : fPset( pset )
    , fChannelMap()
    {}

Member Function Documentation

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

inlineinherited

Configure and initialize the channel map.

Parameters

sortingParameters	parameters for the channel map algorithm
geom	pointer 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().

  {
    doConfigureChannelMapAlg(sortingParameters, geom);
  }

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().

  {
    mf::LogInfo("StandardGeometryHelper")
      << "Loading channel mapping: ChannelMapStandardAlg"; 
    fChannelMap
      = std::make_shared<geo::ChannelMapStandardAlg>(sortingParameters);
    geom->ApplyChannelMap(fChannelMap);
    
  } // StandardGeometryHelper::doConfigureChannelMapAlg()

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.

  {
    return fChannelMap;
  }

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().

  {
    return doGetChannelMapAlg();
  }

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:

• larcore/v06_21_02/source/larcore/Geometry/StandardGeometryHelper.h
• larcore/v06_21_02/source/larcore/Geometry/StandardGeometryHelper_service.cc