icarus::ICARUSsplitInductionChannelMapSetupTool Class Reference

Interface for a tool creating the standard ICARUS channel mapper. More...

Inheritance diagram for icarus::ICARUSsplitInductionChannelMapSetupTool:

Public Types
using	Parameters = art::ToolConfigTable< Mapper_t::Config >

Public Member Functions
	ICARUSsplitInductionChannelMapSetupTool (Parameters const &config)
	Constructor: passes all parameters to the channel mapping algorithm. More...
Public Member Functions inherited from geo::ChannelMapSetupTool
virtual	~ChannelMapSetupTool () noexcept=default
std::unique_ptr < geo::ChannelMapAlg >	setupChannelMap ()
	Returns a new instance of the channel mapping. More...

Protected Member Functions
std::unique_ptr< Mapper_t >	makeChannelMap (Mapper_t::Config const &config) const
	Creates and returns the channel mapping algorithm. More...
Virtual interface
virtual std::unique_ptr < geo::ChannelMapAlg >	doChannelMap () override
	Returns a pointer to the channel mapping. More...
Virtual interface

Protected Attributes
std::unique_ptr< Mapper_t >	fChannelMap

Private Types
using	Mapper_t = icarus::ICARUSChannelMapAlg
	Type of channel mapping algorithm being created. More...

Detailed Description

Interface for a tool creating the standard ICARUS channel mapper.

This tool creates a icarus::ICARUSChannelMapAlg mapper.

Definition at line 35 of file ICARUSsplitInductionChannelMapSetupTool_tool.cc.

Member Typedef Documentation

using icarus::ICARUSsplitInductionChannelMapSetupTool::Mapper_t = icarus::ICARUSChannelMapAlg

private

Type of channel mapping algorithm being created.

Definition at line 40 of file ICARUSsplitInductionChannelMapSetupTool_tool.cc.

using icarus::ICARUSsplitInductionChannelMapSetupTool::Parameters = art::ToolConfigTable<Mapper_t::Config>

Definition at line 44 of file ICARUSsplitInductionChannelMapSetupTool_tool.cc.

Constructor & Destructor Documentation

icarus::ICARUSsplitInductionChannelMapSetupTool::ICARUSsplitInductionChannelMapSetupTool

(

Parameters const &

config

)

Constructor: passes all parameters to the channel mapping algorithm.

Definition at line 79 of file ICARUSsplitInductionChannelMapSetupTool_tool.cc.

  : fChannelMap(makeChannelMap(config()))
{}

Member Function Documentation

virtual std::unique_ptr<geo::ChannelMapAlg> icarus::ICARUSsplitInductionChannelMapSetupTool::doChannelMap ( )

inlineoverrideprotectedvirtual

Returns a pointer to the channel mapping.

Implements geo::ChannelMapSetupTool.

Definition at line 61 of file ICARUSsplitInductionChannelMapSetupTool_tool.cc.

    { return std::move(fChannelMap); }

auto icarus::ICARUSsplitInductionChannelMapSetupTool::makeChannelMap ( Mapper_t::Config const &  config ) const

protected

Creates and returns the channel mapping algorithm.

Definition at line 86 of file ICARUSsplitInductionChannelMapSetupTool_tool.cc.

{
  return std::make_unique<Mapper_t>(config);
} // icarus::ICARUSsplitInductionChannelMapSetupTool::makeChannelMap()

Member Data Documentation

std::unique_ptr<Mapper_t> icarus::ICARUSsplitInductionChannelMapSetupTool::fChannelMap

protected

Definition at line 53 of file ICARUSsplitInductionChannelMapSetupTool_tool.cc.

---

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

• ICARUSsplitInductionChannelMapSetupTool_tool.cc