icarus::PMTsorterStandard Class Reference

Sorter sorting PMT to follow the same order as TPC (standard). More...

#include <PMTsorting.h>

Classes
struct	Config
struct	OpDetGeoCenterCoordComparer

Public Member Functions
	PMTsorterStandard (Config const &config)
	Constructor: passes the configuration to the base class. More...
void	sort (std::vector< geo::OpDetGeo > &opDets) const
	Sorts the specified optical detectors. More...
void	operator() (std::vector< geo::OpDetGeo > &opDets) const

Private Types
using	OpDetList_t = std::vector< geo::OpDetGeo >
	List of optical detector pointers for sorting. More...
using	OpDetSpan_t = util::span< OpDetList_t::iterator >
	Part of list of optical detector pointers for sorting. More...

Private Member Functions
void	sortInPlane (OpDetSpan_t const &opDets) const
	Sorts the geo::OpDetGeo assuming they belong to the same plane. More...

Private Attributes
OpDetGeoCenterCoordComparer <&geo::Point_t::X > const	fSmallerCenterX
	Sorting criterium according to x coordinate of geo::OpDetGeo center. More...
OpDetGeoCenterCoordComparer <&geo::Point_t::Y > const	fSmallerCenterY
	Sorting criterium according to y coordinate of geo::OpDetGeo center. More...
OpDetGeoCenterCoordComparer <&geo::Point_t::Z > const	fSmallerCenterZ
	Sorting criterium according to z coordinate of geo::OpDetGeo center. More...

Detailed Description

Sorter sorting PMT to follow the same order as TPC (standard).

This class sorts the elements of the LArSoft detector description. The "standard" algorithm (geo::GeoObjectSorterStandard) arranges TPC elements with x, then z, then y. The PMT are arranged so that their channels mimic the order of the TPC channels.

The algorithm for assigning channels to the PMT follows the criteria:

• PMT are ordered by increasing x (related to drift direction);
• channels are assigned value ranges increasing with x coordinate;
• within a wire plane, PMT number increases with its z (beam direction) coordinate;
• in case of same z (in ICARUS all PMT are in 2- or 3-PMT "towers"), an increasing y order (geographical vertical, toward the sky) is chosen.

PMT channels are assigned by a fixed LArSoft algorithm, cryostat by cryostat with increasing cryostat number (first C:0, then C:1, ...).

Configuration parameters

This sorter supports the following parameters:

• ToleranceX, ToleranceY, ToleranceZ (double, default: 1.0): rounding used for sorting optical detector position, in centimeters; if the coordinate of two optical detectors are closer than the tolerance for that coordinate (absolute), they two detectors are considered to be at the same position in that coordinate (note that the default value is very generous).

Definition at line 63 of file PMTsorting.h.

Member Typedef Documentation

using icarus::PMTsorterStandard::OpDetList_t = std::vector<geo::OpDetGeo>

private

List of optical detector pointers for sorting.

Definition at line 66 of file PMTsorting.h.

using icarus::PMTsorterStandard::OpDetSpan_t = util::span<OpDetList_t::iterator>

private

Part of list of optical detector pointers for sorting.

Definition at line 69 of file PMTsorting.h.

Constructor & Destructor Documentation

icarus::PMTsorterStandard::PMTsorterStandard ( Config const &  config )

inline

Constructor: passes the configuration to the base class.

Definition at line 100 of file PMTsorting.h.

    : fSmallerCenterX{ config.ToleranceX() }
    , fSmallerCenterY{ config.ToleranceY() }
    , fSmallerCenterZ{ config.ToleranceZ() }
    {}

Member Function Documentation

void icarus::PMTsorterStandard::operator() ( std::vector< geo::OpDetGeo > &  opDets ) const

inline

Definition at line 124 of file PMTsorting.h.

{ sort(opDets); }

void icarus::PMTsorterStandard::sort

(

std::vector< geo::OpDetGeo > &

opDets

)

const

Sorts the specified optical detectors.

Parameters

opDets

collection of pointers to all optical detectors in a cryostat

The collection opDets of optical detectors is sorted in place. Sorting criteria are documented in icarus::GeoObjectSorterPMTasTPC class documentation.

This algorithm requires all optical detectors to have their center defined (geo::OpDetGeo::GetCenter()). No other information is used.

Note

The current implementation is very sensitive to rounding errors!

Definition at line 24 of file PMTsorting.cxx.

                                                                       {
  assert(opDets.size() % 2 == 0); // must be even!
  
  /*
   * 1. sort all optical detectors by _x_
   * 2. split them by plane
   * 3. sort the detectors within each plane.
   */
  
  //
  // 1. sort all optical detectors by _x_
  //
  std::sort(begin(opDets), end(opDets), fSmallerCenterX);
  
  //
  // 2. split them by plane: we take a horrible shortcut here...
  //
  
  std::vector<OpDetSpan_t> OpDetsPerPlane;
  
  // just split the list in two
  auto const middle = std::next(opDets.begin(), opDets.size() / 2U);
  assert(fSmallerCenterX(*std::prev(middle), *middle));
  
  OpDetsPerPlane.emplace_back(opDets.begin(), middle);
  OpDetsPerPlane.emplace_back(middle, opDets.end());
  assert(OpDetsPerPlane[0].size() == OpDetsPerPlane[1].size());
  
  //
  // 3. sort the detectors within each plane.
  //
  for (auto const& planeOpDets: OpDetsPerPlane)
    sortInPlane(util::make_span(planeOpDets));
  
  // all done in place, no return
  
} // icarus::PMTsorterStandard::sort()

void icarus::PMTsorterStandard::sortInPlane ( OpDetSpan_t const &  opDets ) const

private

Sorts the geo::OpDetGeo assuming they belong to the same plane.

Definition at line 64 of file PMTsorting.cxx.

                                                                         {
  /*
   * 0. assume it's already sorted by _x_
   * 1. sort by vertical coordinate (_y_)
   * 2. stable sort by beam coordinate (_z_)
   */
  
  // 1. sort by vertical coordinate (_y_)
  std::stable_sort(begin(opDets), end(opDets), fSmallerCenterY);
  
  // 2. stable sort by beam coordinate (_z_)
  std::stable_sort(begin(opDets), end(opDets), fSmallerCenterZ);
  
} // icarus::PMTsorterStandard::sortInPlane()

Member Data Documentation

OpDetGeoCenterCoordComparer<&geo::Point_t::X> const icarus::PMTsorterStandard::fSmallerCenterX

private

Sorting criterium according to x coordinate of geo::OpDetGeo center.

Definition at line 152 of file PMTsorting.h.

OpDetGeoCenterCoordComparer<&geo::Point_t::Y> const icarus::PMTsorterStandard::fSmallerCenterY

private

Sorting criterium according to y coordinate of geo::OpDetGeo center.

Definition at line 155 of file PMTsorting.h.

OpDetGeoCenterCoordComparer<&geo::Point_t::Z> const icarus::PMTsorterStandard::fSmallerCenterZ

private

Sorting criterium according to z coordinate of geo::OpDetGeo center.

Definition at line 158 of file PMTsorting.h.

---

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

• PMTsorting.h
• PMTsorting.cxx