lar::example::SpacePointIsolationAlg Class Reference

Algorithm to detect isolated space points. More...

#include <SpacePointIsolationAlg.h>

Classes
struct	Config
	Algorithm configuration. More...

Public Types
using	Coord_t = std::decay_t< decltype(recob::SpacePoint().XYZ()[0])>
	Type of coordinate in recob::SpacePoint (double in LArSoft 5) More...

Public Member Functions
void	initialize ()
	Initialises the algorithm with the current configuration and setup. More...
void	fillAlgConfigFromGeometry (PointIsolationAlg_t::Configuration_t &config)
	Detects the boundaries of the volume to be sorted from the geometry. More...
Construction and configuration
	SpacePointIsolationAlg (Config const &config)
	Constructor with configuration validation. More...
	SpacePointIsolationAlg (fhicl::ParameterSet const &pset)
	Constructor with configuration validation. More...

Public Attributes
geo::GeometryCore const *	geom = nullptr
	Pointer to the geometry to be used. More...
Coord_t	radius2
	square of isolation radius [cm^2] More...
std::unique_ptr < PointIsolationAlg_t >	isolationAlg
	the actual generic algorithm More...

Detailed Description

Algorithm to detect isolated space points.

See Also

RemoveIsolatedSpacePoints example overview

This algorithm applies the isolation algorithm implemented in PointIsolationAlg to a collection of recob::SpacePoint objects.

Usage example

//
// preparation
//

// get the algorithm configuration; in art:
fhicl::ParameterSet config
  = pset.get<fhicl::ParameterSet>("isolation");

// get the geometry service provider; in art:
geo::GeometryCore const* geom = lar::providerFrom<geo::Geometry>();

// get the input data; in art:
std::vector<recob::SpacePoint> const& points
  = *(event.getValidHandle<std::vector<recob::SpacePoint>>("sps"));

//
// algorithm execution
//

// construct and configure
lar::examples::SpacePointIsolationAlg algo(config);

// set up
// (might be needed again if geometry changed, e.g. between runs)
algo.Setup(*geom);

// execution
std::vector<size_t> nonIsolatedPointIndices
  = algo.removeIsolatedPoints(points);

//
// use of results
//

// e.g. create a collection of pointers to non-isolated points
std::vector<recob::SpacePoint const*> nonIsolatedPoints;
nonIsolatedPoints.reserve(nonIsolatedPointIndices.size());
recob::SpacePoint const* basePoint = &(points.front());
for (size_t index: nonIsolatedPointIndices)
  nonIsolatedPoints.push_back(basePoint + index);

Configuration parameters

• radius (real, mandatory): isolation radius [cm]

Definition at line 104 of file SpacePointIsolationAlg.h.

Member Typedef Documentation

using lar::example::SpacePointIsolationAlg::Coord_t = std::decay_t<decltype(recob::SpacePoint().XYZ()[0])>

Type of coordinate in recob::SpacePoint (double in LArSoft 5)

Definition at line 108 of file SpacePointIsolationAlg.h.

Constructor & Destructor Documentation

lar::example::SpacePointIsolationAlg::SpacePointIsolationAlg ( Config const &  config )

inline

Constructor with configuration validation.

Parameters

config

configuration parameter structure

For the configuration, see SpacePointIsolationAlg documentation.

Definition at line 134 of file SpacePointIsolationAlg.h.

        : radius2(cet::square(config.radius()))
        {}

lar::example::SpacePointIsolationAlg::SpacePointIsolationAlg ( fhicl::ParameterSet const &  pset )

inline

Constructor with configuration validation.

Parameters

pset	FHiCL configuration parameter set

See Also

SpacePointIsolationAlg(Config const&)

Translates the parameter set into a configuration object and uses the validating constructor to initialise the object.

For the configuration, see SpacePointIsolationAlg documentation.

Definition at line 148 of file SpacePointIsolationAlg.h.

        : SpacePointIsolationAlg(fhicl::Table<Config>(pset, {})())

Member Function Documentation

void lar::example::SpacePointIsolationAlg::fillAlgConfigFromGeometry

(

PointIsolationAlg_t::Configuration_t &

config

)

Detects the boundaries of the volume to be sorted from the geometry.

Definition at line 51 of file SpacePointIsolationAlg.cxx.

{
  // merge the volumes from all TPCs
  auto iTPC = geom->begin_TPC(), tpcend = geom->end_TPC();

  // a TPC is (also) a bounded box:
  geo::BoxBoundedGeo box = (geo::BoxBoundedGeo) *iTPC;

  while (++iTPC != tpcend) box.ExtendToInclude(*iTPC);

  // convert the box into the configuration structure
  config.rangeX = { box.MinX(), box.MaxX() };
  config.rangeY = { box.MinY(), box.MaxY() };
  config.rangeZ = { box.MinZ(), box.MaxZ() };

} // lar::example::SpacePointIsolationAlg::fillAlgConfigFromGeometry()

void lar::example::SpacePointIsolationAlg::initialize

(

)

Initialises the algorithm with the current configuration and setup.

Definition at line 28 of file SpacePointIsolationAlg.cxx.

                                                  {

  PointIsolationAlg_t::Configuration_t config;

  config.radius2 = radius2; // square of isolation radius [cm^2]
  fillAlgConfigFromGeometry(config);

  // proceed to validate the configuration we are going to use
  try {
    PointIsolationAlg_t::validateConfiguration(config);
  }
  catch (std::runtime_error const& e) {
    throw cet::exception("SpacePointIsolationAlg")
      << "Error in PointIsolationAlg configuration: " << e.what() << "\n";
  }

  if (isolationAlg) isolationAlg->reconfigure(config);
  else isolationAlg = std::make_unique<PointIsolationAlg_t>(config);

} // lar::example::SpacePointIsolationAlg::initialize()

Member Data Documentation

geo::GeometryCore const* lar::example::SpacePointIsolationAlg::geom = nullptr

Pointer to the geometry to be used.

Definition at line 210 of file SpacePointIsolationAlg.h.

std::unique_ptr<PointIsolationAlg_t> lar::example::SpacePointIsolationAlg::isolationAlg

the actual generic algorithm

Definition at line 215 of file SpacePointIsolationAlg.h.

Coord_t lar::example::SpacePointIsolationAlg::radius2

square of isolation radius [cm^2]

Definition at line 212 of file SpacePointIsolationAlg.h.

---

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

• SpacePointIsolationAlg.h
• SpacePointIsolationAlg.cxx