icarus::trigger::PMTverticalSlicingAlg Class Reference

Algorithm clustering PMT according to their position. More...

#include <PMTverticalSlicingAlg.h>

Public Types
using	PMTlist_t = std::vector< geo::OpDetGeo const * >
	Type of optical detector list. More...
using	PMTtower_t = PMTlist_t
	Type of optical detector list in a PMT tower. More...
using	PMTtowerOnPlane_t = std::vector< PMTtower_t >
	Type of list of PMT towers on a single optical detector plane. More...
using	Slices_t = std::vector< PMTtowerOnPlane_t >
	Type of PMT towers, per plane. More...

Public Member Functions
	PMTverticalSlicingAlg (std::string logCategory="PMTverticalSlicingAlg")
	Constructor: no configuration parameters so far. More...
void	appendCryoSlices (Slices_t &slices, geo::CryostatGeo const &cryo) const
	Computes slices from all PMT in cryo and appends them to slices. More...
std::vector< std::pair< double, PMTlist_t > >	PMTwalls (geo::CryostatGeo const &cryo) const
	Groups optical detectors under the specified cryostat into walls. More...
std::vector< std::pair< double, PMTlist_t > >	PMTwalls (geo::GeometryCore const &geom) const
	Groups optical detectors in all the detector into walls. More...

Private Member Functions
void	appendSlices (Slices_t &slices, PMTlist_t const &PMTs, geo::Vector_t const &planeNorm, geo::Vector_t const &clusterDir) const
	Computes slices and appends them to an existing list. More...
std::vector< std::pair< double, PMTlist_t > >	PMTwalls (PMTlist_t const &PMTs, geo::Vector_t const &dir) const
	Groups the specifies optical detectors into walls. More...

Static Private Member Functions
static double	PMTwallPosition (PMTlist_t const &PMTs, geo::Vector_t const &dir)
	Returns an (arbitrary) coordinate along dir representing the PMT list. More...
template<typename TPCCont >
static geo::Vector_t	determineDriftDir (TPCCont const &TPCcont)
template<typename TPCCont >
static geo::Vector_t	determineLengthDir (TPCCont const &TPCcont)
static std::vector< PMTlist_t >	clusterPMTby (PMTlist_t const &PMTs, geo::Vector_t const &dir)
	Clusters the PMTs along the specified direction. More...
static PMTlist_t	getCryoPMTs (geo::CryostatGeo const &cryo)
	Returns a list of all geo::OpDetGeo in cryostat cryo. More...
static PMTlist_t	getPMTs (geo::GeometryCore const &geom)
	Returns a list of all geo::OpDetGeo in the whole geometry. More...
static bool	areParallel (geo::Vector_t const &a, geo::Vector_t const &b)
	Returns whether a and b are parallel. More...

Private Attributes
std::string	fLogCategory
	Category for message streaming. More...

Detailed Description

Algorithm clustering PMT according to their position.

The algorithm groups the provided PMT by plane (determined from the drift direction of the TPC) and by the beam-like direction (the one that is not the vertical, i.e. TPC "width" direction).

Definition at line 45 of file PMTverticalSlicingAlg.h.

Member Typedef Documentation

using icarus::trigger::PMTverticalSlicingAlg::PMTlist_t = std::vector<geo::OpDetGeo const*>

Type of optical detector list.

Definition at line 50 of file PMTverticalSlicingAlg.h.

using icarus::trigger::PMTverticalSlicingAlg::PMTtower_t = PMTlist_t

Type of optical detector list in a PMT tower.

Definition at line 53 of file PMTverticalSlicingAlg.h.

using icarus::trigger::PMTverticalSlicingAlg::PMTtowerOnPlane_t = std::vector<PMTtower_t>

Type of list of PMT towers on a single optical detector plane.

Definition at line 56 of file PMTverticalSlicingAlg.h.

using icarus::trigger::PMTverticalSlicingAlg::Slices_t = std::vector<PMTtowerOnPlane_t>

Type of PMT towers, per plane.

Definition at line 59 of file PMTverticalSlicingAlg.h.

Constructor & Destructor Documentation

icarus::trigger::PMTverticalSlicingAlg::PMTverticalSlicingAlg

(

std::string

logCategory = "PMTverticalSlicingAlg"

)

Constructor: no configuration parameters so far.

Definition at line 75 of file PMTverticalSlicingAlg.cxx.

 : fLogCategory(std::move(logCategory))
 {}

Member Function Documentation

void icarus::trigger::PMTverticalSlicingAlg::appendCryoSlices	(	Slices_t &	slices,
		geo::CryostatGeo const &	cryo
	)		const

Computes slices from all PMT in cryo and appends them to slices.

Definition at line 82 of file PMTverticalSlicingAlg.cxx.

{
  geo::Vector_t const& driftDir = determineDriftDir(cryo.IterateTPCs());
  geo::Vector_t const& widthDir = determineLengthDir(cryo.IterateTPCs());
  appendSlices(slices, getCryoPMTs(cryo), driftDir, widthDir);
} // icarus::trigger::PMTverticalSlicingAlg::appendCryoSlices()

void icarus::trigger::PMTverticalSlicingAlg::appendSlices ( Slices_t &  slices, PMTlist_t const &  PMTs, geo::Vector_t const &  planeNorm, geo::Vector_t const &  clusterDir  ) const

private

Computes slices and appends them to an existing list.

Definition at line 109 of file PMTverticalSlicingAlg.cxx.

{

  /*
   * 1. group PMT by plane (cluster on drift direction)
   * 2. group PMT in each plane by width coordinate (cluster by width direction)
   */

  //
  // 1. group PMT by plane (cluster on drift direction)
  //
  
  std::vector<PMTlist_t> const PMTplanes = clusterPMTby(PMTs, planeNorm);

  // BEGIN debug
  {
    mf::LogTrace log { fLogCategory };
    log << PMTs.size() << " PMTs grouped into " << PMTplanes.size()
      << " planes in direction " << planeNorm << ":";
    for (auto&& [ iPlane, PMTplane ]: util::enumerate(PMTplanes)) {
      log << "\n [#" << iPlane << "] " << PMTplane.size() << " PMT:";
      for (geo::OpDetGeo const* opDet: PMTplane)
        log << " <" << opDet->ID() << ">";
    } // for
  }
  // END debug

  //
  // 2. group PMT in each plane by width coordinate (cluster by width direction)
  //
  unsigned int NClusteredPMTs [[maybe_unused]] = 0U;
  for (auto const& PMTplane: PMTplanes) {
    slices.push_back(clusterPMTby(PMTplane, clusterDir));

    // BEGIN debug
    auto const& planeSlices = slices.back();
    mf::LogTrace log { fLogCategory };
    log << PMTplane.size() << " PMTs in the plane grouped into "
      << planeSlices.size() << " towers in direction " << clusterDir << ":";
    for (auto&& [ iSlice, slice ]: util::enumerate(planeSlices)) {
      NClusteredPMTs += slice.size();
      log << "\n [#" << iSlice << "] " << slice.size() << " PMT:";
      for (geo::OpDetGeo const* opDet: slice) log << " <" << opDet->ID() << ">";
    } // for planeSlices
    // END debug

  } // for planes
  
  assert(NClusteredPMTs == PMTs.size());

} // icarus::trigger::PMTverticalSlicingAlg::appendSlices()

bool icarus::trigger::PMTverticalSlicingAlg::areParallel ( geo::Vector_t const &  a, geo::Vector_t const &  b  )

staticprivate

Returns whether a and b are parallel.

Definition at line 248 of file PMTverticalSlicingAlg.cxx.

{
  lar::util::Vector3DComparison cmp { 1e-4 };
  return cmp.zero(a.Cross(b));
} // icarus::trigger::PMTverticalSlicingAlg::areParallel()

auto icarus::trigger::PMTverticalSlicingAlg::clusterPMTby ( PMTlist_t const &  PMTs, geo::Vector_t const &  dir  )

staticprivate

Clusters the PMTs along the specified direction.

Definition at line 203 of file PMTverticalSlicingAlg.cxx.

{
#if 0
  // use the projection of the PMT center on the specified direction as
  // clustering key; we need a reference point to project... we pick `origin()`.
  auto const PMTcenterProjection = [dir](geo::OpDetGeo const* opDet)
    { return (opDet->GetCenter() - geo::origin()).Dot(dir); };
#endif // 0
  
  PMTprojectorClass const PMTcenterProjection { dir };
  
  // PMTs with a coordinate within 5 cm (kind of) will be clustered together
  constexpr double tol = 5.0; // cm
  auto const closeEnough
    = [](double a, double b){ return std::abs(a - b) < tol; };

  return util::clusterBy(PMTs, PMTcenterProjection, closeEnough, std::less<>());

} // icarus::trigger::PMTverticalSlicingAlg::clusterPMTby()

template<typename TPCCont >

geo::Vector_t icarus::trigger::PMTverticalSlicingAlg::determineDriftDir ( TPCCont const &  TPCcont )

staticprivate

Definition at line 153 of file PMTverticalSlicingAlg.h.

{

  auto iTPC = util::begin(TPCcont);
  auto const tend = util::end(TPCcont);

  if (iTPC == tend) {
    throw cet::exception("PMTverticalSlicingAlg")
      << "determineDriftDir(): no TPC in the specified object!";
  }

  auto const dir = iTPC->template DriftDir<geo::Vector_t>();
  while(++iTPC != tend) {
    if (areParallel(iTPC->template DriftDir<geo::Vector_t>(), dir))
      continue;
    throw cet::exception("PMTverticalSlicingAlg")
      << "determineDriftDir(): TPC " << iTPC->ID()
      << " has a drift direction incompatible with " << dir << ".\n";
  } // while

  return dir;

} // icarus::trigger::PMTverticalSlicingAlg::determineDriftDir()

template<typename TPCCont >

geo::Vector_t icarus::trigger::PMTverticalSlicingAlg::determineLengthDir ( TPCCont const &  TPCcont )

staticprivate

Definition at line 181 of file PMTverticalSlicingAlg.h.

{

  auto iTPC = util::begin(TPCcont);
  auto const tend = util::end(TPCcont);

  if (iTPC == tend) {
    throw cet::exception("PMTverticalSlicingAlg")
      << "determineLengthDir(): no TPC in the specified object!";
  }

  auto const dir = iTPC->template LengthDir<geo::Vector_t>();
  while(++iTPC != tend) {
    if (areParallel(iTPC->template LengthDir<geo::Vector_t>(), dir))
      continue;
    throw cet::exception("PMTverticalSlicingAlg")
      << "determineLengthDir(): TPC " << iTPC->ID()
      << " has a width direction incompatible with " << dir << ".\n";
  } // while

  return dir;

} // icarus::trigger::PMTverticalSlicingAlg::determineLengthDir()

auto icarus::trigger::PMTverticalSlicingAlg::getCryoPMTs ( geo::CryostatGeo const &  cryo )

staticprivate

Returns a list of all geo::OpDetGeo in cryostat cryo.

Definition at line 226 of file PMTverticalSlicingAlg.cxx.

{
  PMTlist_t opDets;
  for (auto iOpDet: util::counter(cryo.NOpDet()))
    opDets.push_back(&cryo.OpDet(iOpDet));
  return opDets;
} // icarus::trigger::PMTverticalSlicingAlg::getCryoPMTs()

auto icarus::trigger::PMTverticalSlicingAlg::getPMTs ( geo::GeometryCore const &  geom )

staticprivate

Returns a list of all geo::OpDetGeo in the whole geometry.

Definition at line 237 of file PMTverticalSlicingAlg.cxx.

{
  PMTlist_t opDets;
  for (geo::CryostatGeo const& cryo: geom.IterateCryostats())
    append(opDets, getCryoPMTs(cryo));
  return opDets;
} // icarus::trigger::PMTverticalSlicingAlg::getCryoPMTs()

double icarus::trigger::PMTverticalSlicingAlg::PMTwallPosition ( PMTlist_t const &  PMTs, geo::Vector_t const &  dir  )

staticprivate

Returns an (arbitrary) coordinate along dir representing the PMT list.

Definition at line 189 of file PMTverticalSlicingAlg.cxx.

{
  if (PMTs.empty()) return std::numeric_limits<double>::lowest(); // arbitrary
  
  PMTprojectorClass const PMTcenterProjection { dir };
  lar::util::StatCollector<double> stats;
  for (geo::OpDetGeo const* PMT: PMTs) stats.add(PMTcenterProjection(PMT));
  return stats.Average();
  
} // icarus::trigger::PMTverticalSlicingAlg::PMTwallPosition()

auto icarus::trigger::PMTverticalSlicingAlg::PMTwalls

(

geo::CryostatGeo const &

cryo

)

const

Groups optical detectors under the specified cryostat into walls.

Parameters

cryo	the cryostat containing the optical detectors

Returns

a list of pairs: each an absolute drift coordinate and PMT list

The algorithm returns a list of walls, with as first element a coordinate representing the wall (drift coordinate) and the second the list of optical detectors in that wall, in no particular order. The walls are sorted by increasing drift coordinate.

Definition at line 92 of file PMTverticalSlicingAlg.cxx.

{
  return PMTwalls(getCryoPMTs(cryo), determineDriftDir(cryo.IterateTPCs()));
} // icarus::trigger::PMTverticalSlicingAlg::PMTwalls(CryostatGeo)

auto icarus::trigger::PMTverticalSlicingAlg::PMTwalls

(

geo::GeometryCore const &

geom

)

const

Groups optical detectors in all the detector into walls.

Parameters

geom	the geometry description of the detector

Returns

a list of pairs: each an absolute drift coordinate and PMT list

See Also

PMTwalls(geo::CryostatGeo const&) const

PMT walls are extracted for each of the cryostats in the detector, and the result is merged into a single collection.

Definition at line 101 of file PMTverticalSlicingAlg.cxx.

{
  return PMTwalls(getPMTs(geom), determineDriftDir(geom.IterateTPCs()));
} // icarus::trigger::PMTverticalSlicingAlg::PMTwalls(GeometryCore)

auto icarus::trigger::PMTverticalSlicingAlg::PMTwalls ( PMTlist_t const &  PMTs, geo::Vector_t const &  dir  ) const

private

Groups the specifies optical detectors into walls.

Parameters

PMTs	the list of PMT to be grouped
dir	the direction normal to the walls

Returns

a list of pairs: each an absolute wall coordinate and PMT list

The algorithm returns a list of walls, with as first element a coordinate representing the wall and the second the list of optical detectors in that wall, in no particular order. The walls are sorted by increasing coordinate.

Definition at line 167 of file PMTverticalSlicingAlg.cxx.

{
  // fill the walls with PMTs
  std::vector<PMTlist_t> walls = clusterPMTby(PMTs, dir);
  
  // determine their coordinate
  std::vector<std::pair<double, PMTlist_t>> posAndWalls;
  posAndWalls.reserve(walls.size());
  for (PMTlist_t& wall: walls)
    posAndWalls.emplace_back(PMTwallPosition(wall, dir), std::move(wall));
  
  // sort by coordinate
  std::sort(posAndWalls.begin(), posAndWalls.end()); // sort by std::pair::first
  
  return posAndWalls;
  
} // icarus::trigger::PMTverticalSlicingAlg::PMTwalls(CryostatGeo)

Member Data Documentation

std::string icarus::trigger::PMTverticalSlicingAlg::fLogCategory

private

Category for message streaming.

Definition at line 97 of file PMTverticalSlicingAlg.h.

---

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

• PMTverticalSlicingAlg.h
• PMTverticalSlicingAlg.cxx