LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
geo::TPCID Struct Reference

The data type to uniquely identify a TPC. More...

#include "geo_types.h"

Inheritance diagram for geo::TPCID:
geo::CryostatID geo::PlaneID geo::WireID

Public Types

using TPCID_t = unsigned int
 Type for the ID number. More...
 
using ThisID_t = TPCID
 Type of this ID. More...
 
using ParentID_t = CryostatID
 Type of the parent ID. More...
 
template<std::size_t L>
using ID_t = details::AbsIDtype< L, ThisID_t >
 Type of the ID with the specified level L. More...
 
template<std::size_t A>
using UpperID_t = details::RelIDtype< A, ThisID_t >
 Type of the ID A levels above this one. More...
 
using CryostatID_t = unsigned int
 Type for the ID number. More...
 

Public Member Functions

constexpr TPCID ()=default
 Default constructor: an invalid TPC ID. More...
 
constexpr TPCID (CryostatID const &cryoid, TPCID_t t)
 Constructor: TPC with index t in the cryostat identified by cryoid. More...
 
constexpr TPCID (CryostatID_t c, TPCID_t t)
 Constructor: TPC with index t in the cryostat index c. More...
 
constexpr auto const & deepestIndex () const
 Returns the value of the deepest ID available (TPC's). More...
 
auto & deepestIndex ()
 Returns the deepest ID available (TPC's). More...
 
constexpr ParentID_t const & parentID () const
 Return the parent ID of this one (a cryostat ID). More...
 
ParentID_tparentID ()
 Return the parent ID of this one (a cryostat ID). More...
 
template<std::size_t Index = 0U>
constexpr auto getIndex () const
 Returns the index level Index of this type. More...
 
template<std::size_t Index = 0U>
auto & writeIndex ()
 Returns the index level Index of this type. More...
 
template<std::size_t Above>
constexpr auto getRelIndex () const
 Returns the index Above levels higher than Level. More...
 
constexpr TPCID const & asTPCID () const
 Conversion to TPCID (for convenience of notation). More...
 
TPCIDasTPCID ()
 Conversion to TPCID (for convenience of notation). More...
 
constexpr TPCID const & asConstTPCID ()
 Conversion to TPCID (for convenience of notation). More...
 
constexpr int cmp (TPCID const &other) const
 Returns < 0 if this is smaller than other, 0 if equal, > 0 if larger. More...
 
constexpr int cmp (CryostatID const &other) const
 Returns < 0 if this is smaller than other, 0 if equal, > 0 if larger. More...
 
constexpr CryostatID const & asCryostatID () const
 Conversion to CryostatID (for convenience of notation). More...
 
CryostatIDasCryostatID ()
 Conversion to CryostatID (for convenience of notation). More...
 
constexpr CryostatID const & asConstCryostatID ()
 Conversion to CryostatID (for convenience of notation). More...
 
std::string toString () const
 Human-readable representation of the TPC ID. More...
 
 operator std::string () const
 Human-readable representation of the TPC ID. More...
 
ID validity
constexpr operator bool () const
 Returns true if the ID is valid. More...
 
constexpr bool operator! () const
 Returns true if the ID is not valid. More...
 
void setValidity (bool valid)
 Sets the validity of the ID. More...
 
void markValid ()
 Sets the ID as valid. More...
 
void markInvalid ()
 Sets the ID as invalid. More...
 

Static Public Member Functions

static constexpr TPCID_t getInvalidID ()
 Return the value of the invalid TPC ID as a r-value. More...
 
template<typename T >
static constexpr int ThreeWayComparison (T a, T b)
 Returns < 0 if a < b, 0 if a == b, > 0 if a > b. More...
 

Public Attributes

TPCID_t TPC = InvalidID
 Index of the TPC within its cryostat. More...
 
bool isValid = false
 Whether this ID points to a valid element. More...
 
CryostatID_t Cryostat = InvalidID
 Index of cryostat. More...
 

Static Public Attributes

static constexpr TPCID_t InvalidID = std::numeric_limits<TPCID_t>::max()
 Special code for an invalid ID. More...
 
static constexpr auto Level = geo::ElementLevel::TPC
 Level of this element. More...
 

Detailed Description

The data type to uniquely identify a TPC.

Definition at line 381 of file geo_types.h.

Member Typedef Documentation

using geo::CryostatID::CryostatID_t = unsigned int
inherited

Type for the ID number.

Definition at line 193 of file geo_types.h.

template<std::size_t L>
using geo::TPCID::ID_t = details::AbsIDtype<L, ThisID_t>

Type of the ID with the specified level L.

Definition at line 389 of file geo_types.h.

Type of the parent ID.

Definition at line 385 of file geo_types.h.

Type of this ID.

Definition at line 384 of file geo_types.h.

using geo::TPCID::TPCID_t = unsigned int

Type for the ID number.

Definition at line 382 of file geo_types.h.

template<std::size_t A>
using geo::TPCID::UpperID_t = details::RelIDtype<A, ThisID_t>

Type of the ID A levels above this one.

Definition at line 393 of file geo_types.h.

Constructor & Destructor Documentation

constexpr geo::TPCID::TPCID ( )
default

Default constructor: an invalid TPC ID.

Referenced by tca::MakePFParticles(), and tca::PFPVertexCheck().

constexpr geo::TPCID::TPCID ( CryostatID const &  cryoid,
TPCID_t  t 
)
inline

Constructor: TPC with index t in the cryostat identified by cryoid.

Definition at line 405 of file geo_types.h.

405 : CryostatID(cryoid), TPC(t) {}
constexpr CryostatID()=default
Default constructor: an invalid cryostat.
TPCID_t TPC
Index of the TPC within its cryostat.
Definition: geo_types.h:399
constexpr geo::TPCID::TPCID ( CryostatID_t  c,
TPCID_t  t 
)
inline

Constructor: TPC with index t in the cryostat index c.

Definition at line 408 of file geo_types.h.

References geo::details::writeToString().

408 : CryostatID(c), TPC(t) {}
constexpr CryostatID()=default
Default constructor: an invalid cryostat.
TPCID_t TPC
Index of the TPC within its cryostat.
Definition: geo_types.h:399

Member Function Documentation

constexpr CryostatID const& geo::CryostatID::asConstCryostatID ( )
inlineinherited

Conversion to CryostatID (for convenience of notation).

Definition at line 279 of file geo_types.h.

279 { return *this; }
constexpr TPCID const& geo::TPCID::asConstTPCID ( )
inline

Conversion to TPCID (for convenience of notation).

Definition at line 442 of file geo_types.h.

442 { return *this; }
constexpr CryostatID const& geo::CryostatID::asCryostatID ( ) const
inlineinherited

Conversion to CryostatID (for convenience of notation).

Definition at line 275 of file geo_types.h.

Referenced by readout::operator!=(), geo::operator!=(), readout::operator<(), geo::operator<(), readout::operator<<(), geo::operator<<(), readout::operator==(), and geo::operator==().

275 { return *this; }
CryostatID& geo::CryostatID::asCryostatID ( )
inlineinherited

Conversion to CryostatID (for convenience of notation).

Definition at line 277 of file geo_types.h.

277 { return *this; }
TPCID& geo::TPCID::asTPCID ( )
inline

Conversion to TPCID (for convenience of notation).

Definition at line 440 of file geo_types.h.

440 { return *this; }
constexpr int geo::CryostatID::cmp ( CryostatID const &  other) const
inlineinherited

Returns < 0 if this is smaller than other, 0 if equal, > 0 if larger.

Definition at line 269 of file geo_types.h.

References geo::CryostatID::deepestIndex().

Referenced by readout::TPCsetID::cmp(), geo::OpDetID::cmp(), cmp(), readout::operator<(), and geo::operator<().

270  {
271  return ThreeWayComparison(deepestIndex(), other.deepestIndex());
272  }
static constexpr int ThreeWayComparison(T a, T b)
Returns < 0 if a < b, 0 if a == b, > 0 if a > b.
Definition: geo_types.h:289
constexpr auto const & deepestIndex() const
Returns the value of the deepest ID available (cryostat&#39;s).
Definition: geo_types.h:251
constexpr int geo::TPCID::cmp ( TPCID const &  other) const
inline

Returns < 0 if this is smaller than other, 0 if equal, > 0 if larger.

Definition at line 445 of file geo_types.h.

References geo::CryostatID::cmp(), and deepestIndex().

Referenced by geo::PlaneID::cmp().

446  {
447  int cmp_res = CryostatID::cmp(other);
448  if (cmp_res == 0) // same cryostat: compare TPC
449  return ThreeWayComparison(deepestIndex(), other.deepestIndex());
450  else // return the order of cryostats
451  return cmp_res;
452  } // cmp()
static constexpr int ThreeWayComparison(T a, T b)
Returns < 0 if a < b, 0 if a == b, > 0 if a > b.
Definition: geo_types.h:289
constexpr auto const & deepestIndex() const
Returns the value of the deepest ID available (TPC&#39;s).
Definition: geo_types.h:420
constexpr int cmp(CryostatID const &other) const
Returns < 0 if this is smaller than other, 0 if equal, > 0 if larger.
Definition: geo_types.h:269
constexpr auto const& geo::TPCID::deepestIndex ( ) const
inline

Returns the value of the deepest ID available (TPC's).

Definition at line 420 of file geo_types.h.

Referenced by cmp().

420 { return TPC; }
TPCID_t TPC
Index of the TPC within its cryostat.
Definition: geo_types.h:399
auto& geo::TPCID::deepestIndex ( )
inline

Returns the deepest ID available (TPC's).

Definition at line 422 of file geo_types.h.

422 { return TPC; }
TPCID_t TPC
Index of the TPC within its cryostat.
Definition: geo_types.h:399
template<std::size_t Index>
constexpr auto geo::TPCID::getIndex ( ) const

Returns the index level Index of this type.

Definition at line 903 of file geo_types.h.

904 {
905  static_assert(Index <= Level, "This ID type does not have the requested Index level.");
906  return details::getAbsIDindex<Index>(*this);
907 } // geo::TPCID::getIndex() const
static constexpr auto Level
Level of this element.
Definition: geo_types.h:455
static constexpr TPCID_t geo::TPCID::getInvalidID ( )
inlinestatic

Return the value of the invalid TPC ID as a r-value.

Definition at line 458 of file geo_types.h.

References InvalidID.

Referenced by detsim::SimDriftElectrons::produce().

458 { return TPCID::InvalidID; }
static constexpr TPCID_t InvalidID
Special code for an invalid ID.
Definition: geo_types.h:397
template<std::size_t Above>
constexpr auto geo::TPCID::getRelIndex ( ) const

Returns the index Above levels higher than Level.

Definition at line 917 of file geo_types.h.

918 {
919  static_assert(Above <= Level, "This ID type does not have the requested Index level.");
920  return getIndex<Level - Above>();
921 } // geo::TPCID::getRelIndex()
static constexpr auto Level
Level of this element.
Definition: geo_types.h:455
constexpr auto getIndex() const
Returns the index level Index of this type.
Definition: geo_types.h:903
void geo::CryostatID::markInvalid ( )
inlineinherited

Sets the ID as invalid.

Definition at line 238 of file geo_types.h.

References geo::details::writeToString().

Referenced by geo::PlaneGeo::ClosestWireID(), geo::GeometryCore::FindTPCAtPosition(), geo::GeometryCore::GetEndPlaneID(), geo::GeometryCore::GetEndTPCID(), and geo::GeometryCore::GetEndWireID().

238 { setValidity(false); }
void setValidity(bool valid)
Sets the validity of the ID.
Definition: geo_types.h:232
void geo::CryostatID::markValid ( )
inlineinherited

Sets the ID as valid.

Definition at line 235 of file geo_types.h.

235 { setValidity(true); }
void setValidity(bool valid)
Sets the validity of the ID.
Definition: geo_types.h:232
constexpr geo::CryostatID::operator bool ( ) const
inlineexplicitinherited

Returns true if the ID is valid.

Definition at line 226 of file geo_types.h.

226 { return isValid; }
bool isValid
Whether this ID points to a valid element.
Definition: geo_types.h:210
geo::TPCID::operator std::string ( ) const
inlineexplicit

Human-readable representation of the TPC ID.

Definition at line 415 of file geo_types.h.

415 { return toString(); }
std::string toString() const
Human-readable representation of the TPC ID.
Definition: geo_types.h:414
constexpr bool geo::CryostatID::operator! ( ) const
inlineinherited

Returns true if the ID is not valid.

Definition at line 229 of file geo_types.h.

229 { return !isValid; }
bool isValid
Whether this ID points to a valid element.
Definition: geo_types.h:210
constexpr ParentID_t const& geo::TPCID::parentID ( ) const
inline

Return the parent ID of this one (a cryostat ID).

Definition at line 424 of file geo_types.h.

424 { return *this; }
ParentID_t& geo::TPCID::parentID ( )
inline

Return the parent ID of this one (a cryostat ID).

Definition at line 426 of file geo_types.h.

426 { return *this; }
void geo::CryostatID::setValidity ( bool  valid)
inlineinherited

Sets the validity of the ID.

Definition at line 232 of file geo_types.h.

232 { isValid = valid; }
bool isValid
Whether this ID points to a valid element.
Definition: geo_types.h:210
template<typename T >
static constexpr int geo::CryostatID::ThreeWayComparison ( a,
b 
)
inlinestaticinherited

Returns < 0 if a < b, 0 if a == b, > 0 if a > b.

Definition at line 289 of file geo_types.h.

290  {
291  return (a == b) ? 0 : ((a < b) ? -1 : +1);
292  }
std::string geo::TPCID::toString ( ) const
inline

Human-readable representation of the TPC ID.

Definition at line 414 of file geo_types.h.

414 { return details::writeToString(*this); }
std::string writeToString(T const &value)
Write the argument into a string.
Definition: geo_types.h:842
template<std::size_t Index>
auto & geo::TPCID::writeIndex ( )

Returns the index level Index of this type.

Definition at line 910 of file geo_types.h.

911 {
912  static_assert(Index <= Level, "This ID type does not have the requested Index level.");
913  return details::getAbsIDindex<Index>(*this);
914 } // geo::TPCID::writeIndex()
static constexpr auto Level
Level of this element.
Definition: geo_types.h:455

Member Data Documentation

CryostatID_t geo::CryostatID::Cryostat = InvalidID
inherited

Index of cryostat.

Definition at line 211 of file geo_types.h.

Referenced by detsim::WienerFilterAna::analyze(), trkf::SpacePointAna::analyze(), pma::ProjectionMatchingAlg::buildShowerSeg(), mvapid::MVAAlg::CalcSegmentdEdxDist(), tca::ChgFracBetween(), tca::ChgFracNearEnd(), lar_cluster3d::StandardHit3DBuilder::CollectArtHits(), lar_cluster3d::SnippetHit3DBuilder::CollectArtHits(), trkf::SpacePointAlg::compatible(), tca::CompleteIncomplete3DVerticesInGaps(), ems::MultiEMShowers::convCluster(), geo::ChannelMapStandardAlg::ConvertROPtoWirePlane(), detinfo::DetectorPropertiesData::ConvertTicksToX(), geo::ChannelMapStandardAlg::ConvertTPCsetToTPC(), geo::ChannelMapStandardAlg::ConvertTPCtoTPCset(), geo::ChannelMapStandardAlg::ConvertWirePlaneToROP(), detinfo::DetectorPropertiesData::ConvertXToTicks(), geo::GeometryCore::Cryostat(), geo::GeometryCore::CryostatPtr(), cluster::ClusterCrawlerAlg::EncodeCTP(), tca::EncodeCTP(), ems::EndPoint::EndPoint(), trkf::SpacePointAlg::fillComplexSpacePoint(), tca::FillmAllTraj(), lar_pandora::PFParticleHitDumper::FillRecoWires(), trkf::SpacePointAlg::fillSpacePoint(), tca::FillWireHitRange(), tca::FillWireIntersections(), tca::Find3DVertices(), apa::DisambigAlg::FindChanTimeEndPts(), hit::HitCheater::FindHitsOnChannel(), larg4::LArVoxelReadoutGeometry::FindNestedVolume(), tca::FindParent(), tca::FindShowers3D(), geo::GeometryCore::FindTPCAtPosition(), tca::FitTP3Ds(), ems::EMShower3D::GetCloseHits(), geo::GeometryCore::GetClosestOpDet(), geo::GeometryCore::GetEndTPCID(), geo::GeometryCore::GetEndTPCsetID(), nnet::TrainingDataAlg::getProjection(), pma::Track3D::GetUnconstrainedProj3D(), detinfo::DetectorPropertiesData::GetXTicksOffset(), cluster::MergeClusterAlg::GlobalWire(), cluster::BlurredClusteringAlg::GlobalWire(), shower::EMShowerAlg::GlobalWire_(), geo::GeometryCore::HasCryostat(), tss::Hit2D::Hit2D(), ems::Hit2D::Hit2D(), pma::Hit3D::Hit3D(), lar_cluster3d::SpacePointHit3DBuilder::Hit3DBuilder(), hit::DisambigCheater::InitHitToWids(), trkf::KHitWireLine::KHitWireLine(), trkf::KHitWireX::KHitWireX(), lar_cluster3d::StandardHit3DBuilder::makeDeadChannelPair(), lar_cluster3d::SnippetHit3DBuilder::makeDeadChannelPair(), lar_cluster3d::StandardHit3DBuilder::makeHitPair(), lar_cluster3d::SnippetHit3DBuilder::makeHitPair(), lar_cluster3d::StandardHit3DBuilder::makeHitTriplet(), lar_cluster3d::SnippetHit3DBuilder::makeHitTriplet(), tca::MakePFPTjs(), trkf::SpacePointAlg::makeSpacePoints(), trkf::CosmicTrackerAlg::MakeSPT(), tca::Match2Planes(), evd::SimulationDrawer::MCTruthOrtho(), geo::ChannelMapStandardAlg::NTPCsets(), geo::operator!=(), geo::operator<(), anab::operator<<(), recob::operator<<(), geo::operator<<(), geo::operator==(), lar_cluster3d::PrincipalComponentsAlg::PCAAnalysis_2D(), tca::Print3S(), tca::Print3V(), tca::PrintAllTraj(), tca::PrintTP3Ds(), cluster::LineCluster::produce(), cluster::TrajCluster::produce(), hit::DPRawHitFinder::produce(), calo::Calorimetry::produce(), detsim::SimDriftElectrons::produce(), calo::GnocchiCalorimetry::produce(), trkf::SpacePointAlg::separation(), tca::SignalAtTp(), cheat::BackTracker::SpacePointHitsToWeightedXYZ(), apa::DisambigAlg::TrivialDisambig(), tca::ValidTwoPlaneMatch(), trkf::VertexFitAlg::VertexFit(), cluster::ClusterCrawlerAlg::Vtx3ClusterMatch(), cluster::ClusterCrawlerAlg::Vtx3ClusterSplit(), cluster::ClusterCrawlerAlg::VtxMatch(), tca::WireHitRangeOK(), and lar_cluster3d::SnippetHit3DBuilder::WireIDsIntersect().

constexpr TPCID_t geo::TPCID::InvalidID = std::numeric_limits<TPCID_t>::max()
static

Special code for an invalid ID.

Definition at line 397 of file geo_types.h.

Referenced by geo::GeometryCore::ChannelsIntersect(), and getInvalidID().

constexpr auto geo::TPCID::Level = geo::ElementLevel::TPC
static

Level of this element.

Definition at line 455 of file geo_types.h.

TPCID_t geo::TPCID::TPC = InvalidID

Index of the TPC within its cryostat.

Definition at line 399 of file geo_types.h.

Referenced by ClusteringValidation::ClusterAnalyser::Analyse(), detsim::WienerFilterAna::analyze(), trkf::SpacePointAna::analyze(), trkf::TrajectoryMCSFitter::breakTrajInSegments(), pma::ProjectionMatchingAlg::buildShowerSeg(), mvapid::MVAAlg::CalcSegmentdEdxDist(), ShowerRecoTools::ShowerTrajPointdEdx::CalculateElement(), geo::GeometryCore::ChannelsIntersect(), tca::ChgFracBetween(), tca::ChgFracNearEnd(), lar_cluster3d::StandardHit3DBuilder::CollectArtHits(), lar_cluster3d::SnippetHit3DBuilder::CollectArtHits(), trkf::SpacePointAlg::compatible(), tca::CompleteIncomplete3DVerticesInGaps(), ems::MultiEMShowers::convCluster(), detinfo::DetectorPropertiesData::ConvertTicksToX(), geo::ChannelMapStandardAlg::ConvertTPCtoTPCset(), geo::ChannelMapStandardAlg::ConvertWirePlaneToROP(), detinfo::DetectorPropertiesData::ConvertXToTicks(), cluster::ClusterCrawlerAlg::EncodeCTP(), tca::EncodeCTP(), ems::EndPoint::EndPoint(), trkf::SpacePointAlg::fillComplexSpacePoint(), tca::FillmAllTraj(), lar_pandora::PFParticleHitDumper::FillRecoWires(), trkf::SpacePointAlg::fillSpacePoint(), tca::FillWireHitRange(), tca::FillWireIntersections(), tca::Find3DVertices(), apa::DisambigAlg::FindChanTimeEndPts(), hit::HitCheater::FindHitsOnChannel(), shower::EMShowerAlg::FindInitialTrackHits(), larg4::LArVoxelReadoutGeometry::FindNestedVolume(), tca::FindParent(), tca::FindShowers3D(), tca::FitTP3Ds(), ems::EMShower3D::GetCloseHits(), cluster::TrajCluster::GetHits(), calo::Calorimetry::GetPitch(), nnet::TrainingDataAlg::getProjection(), pma::Track3D::GetUnconstrainedProj3D(), detinfo::DetectorPropertiesData::GetXTicksOffset(), cluster::MergeClusterAlg::GlobalWire(), cluster::BlurredClusteringAlg::GlobalWire(), shower::EMShowerAlg::GlobalWire_(), geo::CryostatGeo::HasTPC(), tss::Hit2D::Hit2D(), pma::Hit3D::Hit3D(), lar_cluster3d::SpacePointHit3DBuilder::Hit3DBuilder(), apa::APAGeometryAlg::Init(), hit::DisambigCheater::InitHitToWids(), trkf::KHitWireLine::KHitWireLine(), trkf::KHitWireX::KHitWireX(), trkf::TrajectoryMCSFitter::linearRegression(), apa::DisambigAlg::MakeCloseHits(), lar_cluster3d::StandardHit3DBuilder::makeDeadChannelPair(), lar_cluster3d::SnippetHit3DBuilder::makeDeadChannelPair(), lar_cluster3d::StandardHit3DBuilder::makeHitPair(), lar_cluster3d::SnippetHit3DBuilder::makeHitPair(), lar_cluster3d::StandardHit3DBuilder::makeHitTriplet(), lar_cluster3d::SnippetHit3DBuilder::makeHitTriplet(), tca::MakePFPTjs(), trkf::SpacePointAlg::makeSpacePoints(), trkf::CosmicTrackerAlg::MakeSPT(), tca::Match2Planes(), tca::Match3PlanesSpt(), evd::SimulationDrawer::MCTruthOrtho(), tca::NearbySrcHit(), geo::operator!=(), geo::operator<(), anab::operator<<(), recob::operator<<(), geo::operator<<(), geo::operator==(), shower::EMShowerAlg::OrderShowerHits_(), lar_cluster3d::PrincipalComponentsAlg::PCAAnalysis_2D(), tca::Print3S(), tca::Print3V(), tca::PrintAllTraj(), tca::PrintTP3Ds(), cluster::LineCluster::produce(), sce::SCECorrection::produce(), cluster::TrajCluster::produce(), hit::DPRawHitFinder::produce(), calo::Calorimetry::produce(), detsim::SimDriftElectrons::produce(), calo::GnocchiCalorimetry::produce(), shower::EMShowerAlg::Project3DPointOntoPlane_(), trkf::SpacePointAlg::separation(), tca::SignalAtTp(), cheat::BackTracker::SpacePointHitsToWeightedXYZ(), geo::CryostatGeo::TPC(), geo::CryostatGeo::TPCPtr(), apa::DisambigAlg::TrivialDisambig(), tca::ValidTwoPlaneMatch(), trkf::VertexFitAlg::VertexFit(), cluster::ClusterCrawlerAlg::Vtx3ClusterMatch(), cluster::ClusterCrawlerAlg::Vtx3ClusterSplit(), cluster::ClusterCrawlerAlg::VtxMatch(), tca::WireHitRangeOK(), lar_cluster3d::SnippetHit3DBuilder::WireIDsIntersect(), and calo::GnocchiCalorimetry::WireToTrajectoryPosition().


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