geo::DriftPartitions Class Reference

Set of drift volumes. More...

#include "DriftPartitions.h"

Classes
struct	DriftVolume_t
	Data associated to a single drift volume. More...

Public Types
using	TPCPartition_t = geo::part::Partition< geo::TPCGeo const >
	Type of TPC collection for the partition of a single drift volume. More...
using	Range_t = lar::util::simple_geo::Range< double >
	Type for description of drift range. More...
using	Position_t = geo::Point_t
	Type representing a position in 3D space. More...
using	Direction_t = geo::Vector_t
	Type representing a direction in 3D space (norm is not constrained). More...
using	Projection_t = ROOT::Math::DisplacementVector2D< ROOT::Math::Cartesian2D< double >>
	Type representing a position in the 2D space. More...
using	DriftDir_t = Direction_t
	Type representing the drift direction (assumed to have norm 1). More...
using	Decomposer_t = geo::Decomposer< Direction_t, Position_t, Projection_t >
	Object used to compute projections on drift volume readout plane. More...

Public Member Functions
	DriftPartitions (Decomposer_t const &decomp)
	Constructor: no partition, but sets the main "drift" direction. More...
template<typename Stream >
void	print (Stream &&out) const
	Printout of the drift volume information. More...
void	addPartition (std::unique_ptr< TPCPartition_t > &&part)
	Adds the specified partition as a new drift volume. More...
Drift volume lookup.
double	driftCoord (Position_t const &pos) const
	Returns drift coordinate (in the drift-volume-specific frame) of pos. More...
DriftVolume_t const *	driftVolumeAt (Position_t const &pos) const
DriftVolume_t const *	driftVolumeAt (double drift) const
	Returns which volume contains the specified drift (nullptr if none). More...
geo::TPCGeo const *	TPCat (Position_t const &pos) const
	Returns which TPC contains the specified position (nullptr if none). More...

Public Attributes
std::vector< DriftVolume_t >	volumes
	All drift volumes, sorted by position. More...
Decomposer_t	decomposer
	Decomposition on drift, width and depth axes. More...

Private Member Functions
std::vector< DriftVolume_t >::iterator	volumeAfter (double pos)
	Returns an iterator to the drift volume starting after pos. More...
std::vector< DriftVolume_t >::const_iterator	volumeAfter (double pos) const
	Returns an iterator to the drift volume starting after pos. More...
Range_t	computeCoverage (TPCPartition_t const &TPCpart) const
	Computes the coverage of the specified partition in the drift direction. More...

Detailed Description

Set of drift volumes.

A drift volume is a set of TPCs whose readout planes lie on the same geometric plane.

Definition at line 81 of file DriftPartitions.h.

Member Typedef Documentation

using geo::DriftPartitions::Decomposer_t = geo::Decomposer<Direction_t, Position_t, Projection_t>

Object used to compute projections on drift volume readout plane.

Definition at line 131 of file DriftPartitions.h.

using geo::DriftPartitions::Direction_t = geo::Vector_t

Type representing a direction in 3D space (norm is not constrained).

Definition at line 121 of file DriftPartitions.h.

using geo::DriftPartitions::DriftDir_t = Direction_t

Type representing the drift direction (assumed to have norm 1).

Definition at line 128 of file DriftPartitions.h.

using geo::DriftPartitions::Position_t = geo::Point_t

Type representing a position in 3D space.

Definition at line 118 of file DriftPartitions.h.

using geo::DriftPartitions::Projection_t = ROOT::Math::DisplacementVector2D<ROOT::Math::Cartesian2D<double>>

Type representing a position in the 2D space.

Definition at line 125 of file DriftPartitions.h.

using geo::DriftPartitions::Range_t = lar::util::simple_geo::Range<double>

Type for description of drift range.

Definition at line 88 of file DriftPartitions.h.

using geo::DriftPartitions::TPCPartition_t = geo::part::Partition<geo::TPCGeo const>

Type of TPC collection for the partition of a single drift volume.

Definition at line 85 of file DriftPartitions.h.

Constructor & Destructor Documentation

geo::DriftPartitions::DriftPartitions ( Decomposer_t const &  decomp )

inlineexplicit

Constructor: no partition, but sets the main "drift" direction.

Definition at line 139 of file DriftPartitions.h.

: decomposer(decomp) {}

Member Function Documentation

void geo::DriftPartitions::addPartition

(

std::unique_ptr< TPCPartition_t > &&

part

)

Adds the specified partition as a new drift volume.

Definition at line 103 of file DriftPartitions.cxx.

References computeCoverage(), part, volumeAfter(), and volumes.

Referenced by geo::buildDriftVolumes().

{
  auto const range = computeCoverage(*part);
  auto iVol = volumeAfter(range.lower);
  volumes.emplace(iVol, std::move(part), range);
} // geo::DriftPartitions::addPartition()

auto geo::DriftPartitions::computeCoverage ( TPCPartition_t const &  TPCpart ) const

private

Computes the coverage of the specified partition in the drift direction.

Definition at line 113 of file DriftPartitions.cxx.

References geo::part::Partition< Data >::data(), decomposer, driftCoord(), lar::util::simple_geo::Range< Data >::extendToInclude(), geo::TPCGeo::GetCathodeCenter(), geo::PlaneGeo::GetCenter(), geo::TPCGeo::LastPlane(), geo::Decomposer< Vector, Point, ProjVector >::PointNormalComponent(), and geo::part::Partition< Data >::walk().

Referenced by addPartition().

{
  /*
   * Computes the range of drift covered by the TPCs in the specified partition.
   * The range is currently defined to include any drift distance covered by
   * any single TPC.
   * The drift distance is computed in "absolute" coordinates, meaning that the
   * origin of the drift is at the origin of the global coordinate system.
   * The drift direction is the one stored in this object.
   */
  
  struct CoverageExtractor {
    Range_t coverage;
    
    CoverageExtractor(DriftPartitions::Decomposer_t const& decomp)
      : decomp(decomp) {}
    
    void operator() (TPCPartition_t const& TPCpart)
      {
        geo::TPCGeo const* TPC = TPCpart.data();
        if (!TPC) return;
        includePoint(TPC->GetCathodeCenter<Position_t>());
        includePoint(TPC->LastPlane().GetCenter<Position_t>());
      }
    
      private:
    DriftPartitions::Decomposer_t const& decomp;
    
    double driftCoord(Position_t const& pos) const
      { return decomp.PointNormalComponent(pos); }
    void includePoint(Position_t const& pos)
      { coverage.extendToInclude(driftCoord(pos)); }
  }; // struct CoverageExtractor
  
  CoverageExtractor extractor(decomposer);
  TPCpart.walk(extractor);
  return extractor.coverage;
  
} // DriftPartitions::computeCoverage()

double geo::DriftPartitions::driftCoord ( Position_t const &  pos ) const

inline

Returns drift coordinate (in the drift-volume-specific frame) of pos.

Definition at line 145 of file DriftPartitions.h.

References geo::Decomposer< Vector, Point, ProjVector >::PointNormalComponent().

Referenced by checkTPCcoords(), computeCoverage(), and sortTPCsByDriftCoord().

      { return decomposer.PointNormalComponent(pos); }

DriftVolume_t const* geo::DriftPartitions::driftVolumeAt ( Position_t const &  pos ) const

inline

Returns which partition contains the specified position.

Returns

volume containing the specified position (nullptr if none)

Definition at line 150 of file DriftPartitions.h.

References geo::buildDriftVolumes(), and part.

Referenced by TPCat().

      { return driftVolumeAt(driftCoord(pos)); }

geo::DriftPartitions::DriftVolume_t const * geo::DriftPartitions::driftVolumeAt

(

double

drift

)

const

Returns which volume contains the specified drift (nullptr if none).

Definition at line 83 of file DriftPartitions.cxx.

{
  auto iVol = volumeAfter(drift); // points to partition after the good one
  if (iVol == volumes.cbegin()) return nullptr;
  if (!(--iVol)->coversDrift(drift)) return nullptr; // maybe not that good?
  return &*iVol;
} // geo::DriftPartitions::driftVolumeAt()

template<typename Stream >

void geo::DriftPartitions::print

(

Stream &&

out

)

const

Printout of the drift volume information.

Definition at line 288 of file DriftPartitions.h.

                                                 {
  
  out << volumes.size() << " drift volume partitions:";
  for (auto const& driftVol: volumes) {
    out << "\n[" << driftVol.driftCoverage.lower
      << " -- " << driftVol.driftCoverage.upper << "]: "
      << driftVol.partition->describe("  ", "");
  } // for
  out << "\n";
} // geo::DriftPartitions::print()

geo::TPCGeo const * geo::DriftPartitions::TPCat

(

Position_t const &

pos

)

const

Returns which TPC contains the specified position (nullptr if none).

Definition at line 93 of file DriftPartitions.cxx.

References geo::Decomposer< Vector, Point, ProjVector >::DecomposePoint(), decomposer, and driftVolumeAt().

                                                                      {
  auto comp = decomposer.DecomposePoint(pos);
  auto volume = driftVolumeAt(comp.distance);
  return (volume && volume->partition)
    ? volume->partition->atPoint(comp.projection.X(), comp.projection.Y())
    : nullptr;
} // geo::DriftPartitions::TPCat()

auto geo::DriftPartitions::volumeAfter ( double  pos )

inlineprivate

Returns an iterator to the drift volume starting after pos.

Definition at line 271 of file DriftPartitions.h.

Referenced by addPartition().

{
  return std::upper_bound
    (volumes.begin(), volumes.end(), pos, DriftVolume_t::Comparer_t());
} // geo::DriftPartitions::volumeAfter()

auto geo::DriftPartitions::volumeAfter ( double  pos ) const

inlineprivate

Returns an iterator to the drift volume starting after pos.

Definition at line 278 of file DriftPartitions.h.

{
  return std::upper_bound
    (volumes.begin(), volumes.end(), pos, DriftVolume_t::Comparer_t());
} // geo::DriftPartitions::volumeAfter()

Member Data Documentation

Decomposer_t geo::DriftPartitions::decomposer

Decomposition on drift, width and depth axes.

Definition at line 136 of file DriftPartitions.h.

Referenced by geo::buildDriftVolumes(), computeCoverage(), and TPCat().

std::vector<DriftVolume_t> geo::DriftPartitions::volumes

All drift volumes, sorted by position.

Definition at line 135 of file DriftPartitions.h.

Referenced by addPartition().

---

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

• larcorealg/v1_24_01/source/larcorealg/Geometry/DriftPartitions.h
• larcorealg/v1_24_01/source/larcorealg/Geometry/DriftPartitions.cxx