LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
readout::TPCsetID Struct Reference

Class identifying a set of TPC sharing readout channels. More...

#include "readout_types.h"

Inheritance diagram for readout::TPCsetID:
geo::CryostatID readout::ROPID

Public Types

using TPCsetID_t = unsigned short
 Type for the ID number. More...
 
using ThisID_t = TPCsetID
 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 TPCsetID ()=default
 Default constructor: an invalid TPC set ID. More...
 
constexpr TPCsetID (CryostatID const &cryoid, TPCsetID_t s)
 
constexpr TPCsetID (CryostatID_t c, TPCsetID_t s)
 Constructor: TPC set with index s in the cryostat index c. More...
 
constexpr auto const & deepestIndex () const
 Returns the value of the deepest ID available (TPC set's). More...
 
auto & deepestIndex ()
 Returns the deepest ID available (TPC set'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 TPCsetID const & asTPCsetID () const
 Conversion to TPCsetID (for convenience of notation). More...
 
TPCsetIDasTPCsetID ()
 Conversion to TPCsetID (for convenience of notation). More...
 
constexpr TPCsetID const & asConstTPCsetID ()
 Conversion to TPCsetID (for convenience of notation). More...
 
constexpr int cmp (TPCsetID 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 set ID. More...
 
 operator std::string () const
 Human-readable representation of the TPC set 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 TPCsetID_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

TPCsetID_t TPCset = InvalidID
 Index of the TPC set 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 TPCsetID_t InvalidID = std::numeric_limits<TPCsetID_t>::max()
 Special code for an invalid ID. More...
 
static constexpr auto Level = readout::ElementLevel::TPCset
 Level of this element. More...
 

Detailed Description

Class identifying a set of TPC sharing readout channels.

This identifier provides the cryostat location and a number representing the set of TPCs. This set is defined by not sharing readout channels with any other TPC outside the set.

Definition at line 72 of file readout_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 readout::TPCsetID::ID_t = details::AbsIDtype<L, ThisID_t>

Type of the ID with the specified level L.

Definition at line 80 of file readout_types.h.

Type of the parent ID.

Definition at line 76 of file readout_types.h.

Type of this ID.

Definition at line 75 of file readout_types.h.

using readout::TPCsetID::TPCsetID_t = unsigned short

Type for the ID number.

Definition at line 73 of file readout_types.h.

template<std::size_t A>
using readout::TPCsetID::UpperID_t = details::RelIDtype<A, ThisID_t>

Type of the ID A levels above this one.

Definition at line 84 of file readout_types.h.

Constructor & Destructor Documentation

constexpr readout::TPCsetID::TPCsetID ( )
default

Default constructor: an invalid TPC set ID.

constexpr readout::TPCsetID::TPCsetID ( CryostatID const &  cryoid,
TPCsetID_t  s 
)
inline

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

Definition at line 97 of file readout_types.h.

97 : CryostatID(cryoid), TPCset(s) {}
constexpr CryostatID()=default
Default constructor: an invalid cryostat.
TPCsetID_t TPCset
Index of the TPC set within its cryostat.
Definition: readout_types.h:90
constexpr readout::TPCsetID::TPCsetID ( CryostatID_t  c,
TPCsetID_t  s 
)
inline

Constructor: TPC set with index s in the cryostat index c.

Definition at line 100 of file readout_types.h.

References readout::details::writeToString().

100 : CryostatID(c), TPCset(s) {}
constexpr CryostatID()=default
Default constructor: an invalid cryostat.
TPCsetID_t TPCset
Index of the TPC set within its cryostat.
Definition: readout_types.h:90

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 TPCsetID const& readout::TPCsetID::asConstTPCsetID ( )
inline

Conversion to TPCsetID (for convenience of notation).

Definition at line 134 of file readout_types.h.

134 { 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; }
constexpr TPCsetID const& readout::TPCsetID::asTPCsetID ( ) const
inline

Conversion to TPCsetID (for convenience of notation).

Definition at line 130 of file readout_types.h.

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

130 { return *this; }
TPCsetID& readout::TPCsetID::asTPCsetID ( )
inline

Conversion to TPCsetID (for convenience of notation).

Definition at line 132 of file readout_types.h.

132 { return *this; }
constexpr int readout::TPCsetID::cmp ( TPCsetID const &  other) const
inline

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

Definition at line 137 of file readout_types.h.

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

Referenced by readout::ROPID::cmp(), and readout::operator<().

138  {
139  int cmp_res = CryostatID::cmp(other);
140  if (cmp_res == 0) // same cryostat: compare TPC set
141  return ThreeWayComparison(TPCset, other.TPCset);
142  else // return the order of cryostats
143  return cmp_res;
144  } // 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
TPCsetID_t TPCset
Index of the TPC set within its cryostat.
Definition: readout_types.h:90
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 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 cmp(), geo::OpDetID::cmp(), geo::TPCID::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 auto const& readout::TPCsetID::deepestIndex ( ) const
inline

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

Definition at line 112 of file readout_types.h.

112 { return TPCset; }
TPCsetID_t TPCset
Index of the TPC set within its cryostat.
Definition: readout_types.h:90
auto& readout::TPCsetID::deepestIndex ( )
inline

Returns the deepest ID available (TPC set's).

Definition at line 114 of file readout_types.h.

114 { return TPCset; }
TPCsetID_t TPCset
Index of the TPC set within its cryostat.
Definition: readout_types.h:90
template<std::size_t Index>
constexpr auto readout::TPCsetID::getIndex ( ) const

Returns the index level Index of this type.

Definition at line 322 of file readout_types.h.

323 {
324  static_assert(Index <= Level, "This ID type does not have the requested Index level.");
325  return details::getAbsIDindex<Index>(*this);
326 } // readout::TPCsetID::getIndex() const
static constexpr auto Level
Level of this element.
static constexpr TPCsetID_t readout::TPCsetID::getInvalidID ( )
inlinestatic

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

Definition at line 150 of file readout_types.h.

References InvalidID.

150 { return TPCsetID::InvalidID; }
static constexpr TPCsetID_t InvalidID
Special code for an invalid ID.
Definition: readout_types.h:87
template<std::size_t Above>
constexpr auto readout::TPCsetID::getRelIndex ( ) const

Returns the index Above levels higher than Level.

Definition at line 336 of file readout_types.h.

337 {
338  static_assert(Above <= Level, "This ID type does not have the requested Index level.");
339  return getIndex<Level - Above>();
340 } // readout::TPCsetID::getRelIndex()
constexpr auto getIndex() const
Returns the index level Index of this type.
static constexpr auto Level
Level of this element.
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
readout::TPCsetID::operator std::string ( ) const
inlineexplicit

Human-readable representation of the TPC set ID.

Definition at line 107 of file readout_types.h.

107 { return toString(); }
std::string toString() const
Human-readable representation of the TPC set ID.
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& readout::TPCsetID::parentID ( ) const
inline

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

Definition at line 116 of file readout_types.h.

116 { return *this; }
ParentID_t& readout::TPCsetID::parentID ( )
inline

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

Definition at line 118 of file readout_types.h.

118 { 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 readout::TPCsetID::toString ( ) const
inline

Human-readable representation of the TPC set ID.

Definition at line 106 of file readout_types.h.

106 { return details::writeToString(*this); }
std::string writeToString(T const &value)
Definition: readout_types.h:22
template<std::size_t Index>
auto & readout::TPCsetID::writeIndex ( )

Returns the index level Index of this type.

Definition at line 329 of file readout_types.h.

330 {
331  static_assert(Index <= Level, "This ID type does not have the requested Index level.");
332  return details::getAbsIDindex<Index>(*this);
333 } // readout::TPCsetID::writeIndex()
static constexpr auto Level
Level of this element.

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 TPCsetID_t readout::TPCsetID::InvalidID = std::numeric_limits<TPCsetID_t>::max()
static

Special code for an invalid ID.

Definition at line 87 of file readout_types.h.

Referenced by getInvalidID().

constexpr auto readout::TPCsetID::Level = readout::ElementLevel::TPCset
static

Level of this element.

Definition at line 147 of file readout_types.h.


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