lar::example::tests::SpacePointMaker Class Reference

Creates a collection of space points. More...

Inheritance diagram for lar::example::tests::SpacePointMaker:

Classes
struct	Config

Public Types
using	Parameters = art::EDProducer::Table< Config >
Public Types inherited from art::EDProducer
using	ModuleType = EDProducer
using	WorkerType = WorkerT< EDProducer >
Public Types inherited from art::detail::Producer
template<typename UserConfig , typename KeysToIgnore = void>
using	Table = Modifier::Table< UserConfig, KeysToIgnore >
Public Types inherited from art::Modifier
template<typename UserConfig , typename UserKeysToIgnore = void>
using	Table = ProducerTable< UserConfig, detail::ModuleConfig, UserKeysToIgnore >

Public Member Functions
	SpacePointMaker (Parameters const &config)
	Constructor; see the class documentation for the configuration. More...
virtual void	produce (art::Event &event) override
	Create and add the points on each event (although they are the same) More...
Public Member Functions inherited from art::EDProducer
	EDProducer (fhicl::ParameterSet const &pset)
template<typename Config >
	EDProducer (Table< Config > const &config)
std::string	workerType () const
Public Member Functions inherited from art::detail::Producer
virtual	~Producer () noexcept
	Producer (fhicl::ParameterSet const &)
	Producer (Producer const &)=delete
	Producer (Producer &&)=delete
Producer &	operator= (Producer const &)=delete
Producer &	operator= (Producer &&)=delete
void	doBeginJob (SharedResources const &resources)
void	doEndJob ()
void	doRespondToOpenInputFile (FileBlock const &fb)
void	doRespondToCloseInputFile (FileBlock const &fb)
void	doRespondToOpenOutputFiles (FileBlock const &fb)
void	doRespondToCloseOutputFiles (FileBlock const &fb)
bool	doBeginRun (RunPrincipal &rp, ModuleContext const &mc)
bool	doEndRun (RunPrincipal &rp, ModuleContext const &mc)
bool	doBeginSubRun (SubRunPrincipal &srp, ModuleContext const &mc)
bool	doEndSubRun (SubRunPrincipal &srp, ModuleContext const &mc)
bool	doEvent (EventPrincipal &ep, ModuleContext const &mc, std::atomic< std::size_t > &counts_run, std::atomic< std::size_t > &counts_passed, std::atomic< std::size_t > &counts_failed)
Public Member Functions inherited from art::Modifier
	~Modifier () noexcept
	Modifier ()
	Modifier (Modifier const &)=delete
	Modifier (Modifier &&)=delete
Modifier &	operator= (Modifier const &)=delete
Modifier &	operator= (Modifier &&)=delete
Public Member Functions inherited from art::ModuleBase
virtual	~ModuleBase () noexcept
	ModuleBase ()
ModuleDescription const &	moduleDescription () const
void	setModuleDescription (ModuleDescription const &)
std::array< std::vector< ProductInfo >, NumBranchTypes > const &	getConsumables () const
void	sortConsumables (std::string const &current_process_name)
template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)
template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Private Attributes
double	spacing
	step size [cm] More...

Additional Inherited Members
Static Public Member Functions inherited from art::EDProducer
static void	commitEvent (EventPrincipal &ep, Event &e)
Protected Member Functions inherited from art::ModuleBase
ConsumesCollector &	consumesCollector ()
template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)
template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)
template<typename T , BranchType = InEvent>
void	consumesMany ()
template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)
template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)
template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

Detailed Description

Creates a collection of space points.

A collection of space points is added to the event. The points are spaced by the value of the spacing configuration parameter, in a cubic grid. Each TPC is independently filled, so that the TPC centre hosts a space point.

The space points are not associated to anything.

Configuration parameters

• spacing (real, mandatory): spacing between the points [cm]

Definition at line 49 of file SpacePointMaker_module.cc.

Member Typedef Documentation

using lar::example::tests::SpacePointMaker::Parameters = art::EDProducer::Table<Config>

Definition at line 65 of file SpacePointMaker_module.cc.

Constructor & Destructor Documentation

lar::example::tests::SpacePointMaker::SpacePointMaker ( Parameters const &  config )

explicit

Constructor; see the class documentation for the configuration.

Definition at line 92 of file SpacePointMaker_module.cc.

  : EDProducer{config}
  , spacing(config().spacing())
{
  produces<std::vector<recob::SpacePoint>>();
} // lar::example::tests::SpacePointMaker::SpacePointMaker()

Member Function Documentation

void lar::example::tests::SpacePointMaker::produce ( art::Event &  event )

overridevirtual

Create and add the points on each event (although they are the same)

Implements art::EDProducer.

Definition at line 101 of file SpacePointMaker_module.cc.

                                                            {

  //
  // set up
  //

  // container for the data product
  auto spacePoints = std::make_unique<std::vector<recob::SpacePoint>>();

  // acquire the geometry information
  auto const* geom = lar::providerFrom<geo::Geometry>();

  //
  // creation of the points
  //

  // fill each TPC independently
  for (auto const& TPC: geom->IterateTPCs()) {

    FillSpacePointGrid(*spacePoints, TPC, spacing);

  } // for TPC

  //
  // result storage
  //
  mf::LogInfo("SpacePointMaker")
    << "Created " << spacePoints->size() << " space points using spacing "
    << spacing << " cm";

  event.put(std::move(spacePoints));

} // lar::example::tests::SpacePointMaker::produce()

Member Data Documentation

double lar::example::tests::SpacePointMaker::spacing

private

step size [cm]

Definition at line 75 of file SpacePointMaker_module.cc.

---

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

• larexamples/test/Algorithms/RemoveIsolatedSpacePoints/SpacePointMaker_module.cc