readout::ROPID Struct Reference

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

#include "readout_types.h"

Inheritance diagram for readout::ROPID:

Public Types
using	ROPID_t = unsigned int
	Type for the ID number. More...
using	ThisID_t = ROPID
	Type of this ID. More...
using	ParentID_t = TPCsetID
	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	TPCsetID_t = unsigned short
	Type for the ID number. More...
using	CryostatID_t = unsigned int
	Type for the ID number. More...

Public Member Functions
constexpr	ROPID ()=default
	Default constructor: an invalid plane ID. More...
constexpr	ROPID (TPCsetID const &tpcsetid, ROPID_t r)
constexpr	ROPID (CryostatID_t c, TPCsetID_t s, ROPID_t r)
constexpr auto const &	deepestIndex () const
	Returns the value of the deepest ID available (readout plane's). More...
auto &	deepestIndex ()
	Returns the deepest ID available (readout plane's). More...
constexpr ParentID_t const &	parentID () const
	Return the parent ID of this one (a TPC set ID). More...
ParentID_t &	parentID ()
	Return the parent ID of this one (a TPC set 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 ROPID const &	asROPID () const
	Conversion to ROPID (for convenience of notation). More...
ROPID &	asROPID ()
	Conversion to ROPID (for convenience of notation). More...
constexpr ROPID const &	asConstROPID ()
	Conversion to ROPID (for convenience of notation). More...
constexpr int	cmp (ROPID const &other) const
	Returns < 0 if this is smaller than other, 0 if equal, > 0 if larger. More...
constexpr TPCsetID const &	asTPCsetID () const
	Conversion to TPCsetID (for convenience of notation). More...
TPCsetID &	asTPCsetID ()
	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...
CryostatID &	asCryostatID ()
	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 ROP ID. More...
	operator std::string () const
	Human-readable representation of the ROP 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 ROPID_t	getInvalidID ()
	Return the value of the invalid ROP 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
ROPID_t	ROP = InvalidID
	Index of the readout plane within its TPC set. More...
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 ROPID_t	InvalidID = std::numeric_limits<ROPID_t>::max()
	Special code for an invalid ID. More...
static constexpr auto	Level = readout::ElementLevel::ReadoutPlane
	Level of this element. More...

Detailed Description

Class identifying a set of planes sharing readout channels.

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

The name stands for "readout plane".

Definition at line 164 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::ROPID::ID_t = details::AbsIDtype<L, ThisID_t>

Type of the ID with the specified level L.

Definition at line 172 of file readout_types.h.

using readout::ROPID::ParentID_t = TPCsetID

Type of the parent ID.

Definition at line 168 of file readout_types.h.

using readout::ROPID::ROPID_t = unsigned int

Type for the ID number.

Definition at line 165 of file readout_types.h.

using readout::ROPID::ThisID_t = ROPID

Type of this ID.

Definition at line 167 of file readout_types.h.

using readout::TPCsetID::TPCsetID_t = unsigned short

inherited

Type for the ID number.

Definition at line 73 of file readout_types.h.

template<std::size_t A>

using readout::ROPID::UpperID_t = details::RelIDtype<A, ThisID_t>

Type of the ID A levels above this one.

Definition at line 176 of file readout_types.h.

Constructor & Destructor Documentation

constexpr readout::ROPID::ROPID ( )

default

Default constructor: an invalid plane ID.

constexpr readout::ROPID::ROPID ( TPCsetID const &  tpcsetid, ROPID_t  r  )

inline

Constructor: readout plane with index r in the TPC set identified by tpcsetid.

Definition at line 188 of file readout_types.h.

: TPCsetID(tpcsetid), ROP(r) {}

constexpr readout::ROPID::ROPID ( CryostatID_t  c, TPCsetID_t  s, ROPID_t  r  )

inline

Constructor: readout plane with index r in the cryostat index c, TPC set index s.

Definition at line 192 of file readout_types.h.

References readout::details::writeToString().

: TPCsetID(c, s), ROP(r) {}

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.

{ return *this; }

constexpr ROPID const& readout::ROPID::asConstROPID ( )

inline

Conversion to ROPID (for convenience of notation).

Definition at line 226 of file readout_types.h.

{ return *this; }

constexpr TPCsetID const& readout::TPCsetID::asConstTPCsetID ( )

inlineinherited

Conversion to TPCsetID (for convenience of notation).

Definition at line 134 of file readout_types.h.

{ 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==().

{ return *this; }

CryostatID& geo::CryostatID::asCryostatID ( )

inlineinherited

Conversion to CryostatID (for convenience of notation).

Definition at line 277 of file geo_types.h.

{ return *this; }

constexpr ROPID const& readout::ROPID::asROPID ( ) const

inline

Conversion to ROPID (for convenience of notation).

Definition at line 222 of file readout_types.h.

{ return *this; }

ROPID& readout::ROPID::asROPID ( )

inline

Conversion to ROPID (for convenience of notation).

Definition at line 224 of file readout_types.h.

{ return *this; }

constexpr TPCsetID const& readout::TPCsetID::asTPCsetID ( ) const

inlineinherited

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().

{ return *this; }

TPCsetID& readout::TPCsetID::asTPCsetID ( )

inlineinherited

Conversion to TPCsetID (for convenience of notation).

Definition at line 132 of file readout_types.h.

{ return *this; }

constexpr int readout::TPCsetID::cmp ( TPCsetID const &  other ) const

inlineinherited

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 readout::TPCsetID::TPCset.

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

    {
      int cmp_res = CryostatID::cmp(other);
      if (cmp_res == 0) // same cryostat: compare TPC set
        return ThreeWayComparison(TPCset, other.TPCset);
      else // return the order of cryostats
        return cmp_res;
    } // cmp()

constexpr int readout::ROPID::cmp ( ROPID const &  other ) const

inline

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

Definition at line 229 of file readout_types.h.

References readout::TPCsetID::cmp(), and ROP.

    {
      int cmp_res = TPCsetID::cmp(other);
      if (cmp_res == 0) // same TPC set: compare plane
        return ThreeWayComparison(ROP, other.ROP);
      else // return the order of TPC set
        return cmp_res;
    } // cmp()

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(), geo::TPCID::cmp(), readout::operator<(), and geo::operator<().

    {
      return ThreeWayComparison(deepestIndex(), other.deepestIndex());
    }

constexpr auto const& readout::ROPID::deepestIndex ( ) const

inline

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

Definition at line 204 of file readout_types.h.

{ return ROP; }

auto& readout::ROPID::deepestIndex ( )

inline

Returns the deepest ID available (readout plane's).

Definition at line 206 of file readout_types.h.

{ return ROP; }

template<std::size_t Index>

constexpr auto readout::ROPID::getIndex

(

)

const

Returns the index level Index of this type.

Definition at line 344 of file readout_types.h.

{
  static_assert(Index <= Level, "This ID type does not have the requested Index level.");
  return details::getAbsIDindex<Index>(*this);
} // readout::ROPID::getIndex() const

static constexpr ROPID_t readout::ROPID::getInvalidID ( )

inlinestatic

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

Definition at line 242 of file readout_types.h.

References InvalidID.

{ return ROPID::InvalidID; }

template<std::size_t Above>

constexpr auto readout::ROPID::getRelIndex

(

)

const

Returns the index Above levels higher than Level.

Definition at line 358 of file readout_types.h.

{
  static_assert(Above <= Level, "This ID type does not have the requested Index level.");
  return getIndex<Level - Above>();
} // readout::ROPID::getRelIndex()

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().

{ setValidity(false); }

void geo::CryostatID::markValid ( )

inlineinherited

Sets the ID as valid.

Definition at line 235 of file geo_types.h.

{ setValidity(true); }

constexpr geo::CryostatID::operator bool ( ) const

inlineexplicitinherited

Returns true if the ID is valid.

Definition at line 226 of file geo_types.h.

{ return isValid; }

readout::ROPID::operator std::string ( ) const

inlineexplicit

Human-readable representation of the ROP ID.

Definition at line 199 of file readout_types.h.

{ return toString(); }

constexpr bool geo::CryostatID::operator! ( ) const

inlineinherited

Returns true if the ID is not valid.

Definition at line 229 of file geo_types.h.

{ return !isValid; }

constexpr ParentID_t const& readout::ROPID::parentID ( ) const

inline

Return the parent ID of this one (a TPC set ID).

Definition at line 208 of file readout_types.h.

{ return *this; }

ParentID_t& readout::ROPID::parentID ( )

inline

Return the parent ID of this one (a TPC set ID).

Definition at line 210 of file readout_types.h.

{ return *this; }

void geo::CryostatID::setValidity ( bool  valid )

inlineinherited

Sets the validity of the ID.

Definition at line 232 of file geo_types.h.

{ isValid = valid; }

template<typename T >

static constexpr int geo::CryostatID::ThreeWayComparison ( T  a, T  b  )

inlinestaticinherited

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

Definition at line 289 of file geo_types.h.

    {
      return (a == b) ? 0 : ((a < b) ? -1 : +1);
    }

std::string readout::ROPID::toString ( ) const

inline

Human-readable representation of the ROP ID.

Definition at line 198 of file readout_types.h.

{ return details::writeToString(*this); }

template<std::size_t Index>

auto & readout::ROPID::writeIndex

(

)

Returns the index level Index of this type.

Definition at line 351 of file readout_types.h.

{
  static_assert(Index <= Level, "This ID type does not have the requested Index level.");
  return details::getAbsIDindex<Index>(*this);
} // readout::ROPID::writeIndex()

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 ROPID_t readout::ROPID::InvalidID = std::numeric_limits<ROPID_t>::max()

static

Special code for an invalid ID.

Definition at line 179 of file readout_types.h.

Referenced by getInvalidID().

bool geo::CryostatID::isValid = false

inherited

Whether this ID points to a valid element.

Definition at line 210 of file geo_types.h.

Referenced by trkf::TrajectoryMCSFitter::breakTrajInSegments(), geo::ChannelMapStandardAlg::ConvertROPtoWirePlane(), geo::ChannelMapStandardAlg::ConvertTPCsetToTPC(), geo::ChannelMapStandardAlg::ConvertTPCtoTPCset(), geo::ChannelMapStandardAlg::ConvertWirePlaneToROP(), hit::HitCheater::FindHitsOnChannel(), shower::EMShowerAlg::FindInitialTrackHits(), geo::ChannelMapStandardAlg::FirstChannelInROP(), opdet::GetHitGeometryInfo(), nnet::TrainingDataAlg::getProjection(), lar_pandora::LArPandoraInput::GetTrueStartAndEndPoints(), geo::InvalidWireError::hasPlane(), recob::Cluster::hasPlane(), hit::DisambigCheater::InitHitToWids(), trkf::TrajectoryMCSFitter::linearRegression(), hit::DisambigCheater::MakeDisambigHit(), apa::DisambigAlg::MakeDisambigHit(), evd::SimulationDrawer::MCTruthOrtho(), geo::ChannelMapStandardAlg::NTPCsets(), shower::EMShowerAlg::OrderShowerHits_(), calo::ShowerCalorimetry::produce(), calo::Calorimetry::produce(), calo::GnocchiCalorimetry::produce(), shower::EMShowerAlg::Project3DPointOntoPlane_(), geo::ChannelMapStandardAlg::ROPtoTPCs(), geo::ChannelMapStandardAlg::ROPtoWirePlanes(), filt::LArG4ParticleFilter::StartInTPCCheck(), filt::LArG4ParticleFilter::StopInTPCCheck(), geo::ChannelMapStandardAlg::TPCsetToTPCs(), and filt::LArG4ParticleFilter::TPCTrajLengthCheck().

constexpr auto readout::ROPID::Level = readout::ElementLevel::ReadoutPlane

static

Level of this element.

Definition at line 239 of file readout_types.h.

ROPID_t readout::ROPID::ROP = InvalidID

Index of the readout plane within its TPC set.

Definition at line 181 of file readout_types.h.

Referenced by cmp(), geo::ChannelMapStandardAlg::ConvertROPtoWirePlane(), geo::ChannelMapStandardAlg::HasROP(), readout::operator!=(), readout::operator<(), readout::operator<<(), and readout::operator==().

TPCsetID_t readout::TPCsetID::TPCset = InvalidID

inherited

Index of the TPC set within its cryostat.

Definition at line 90 of file readout_types.h.

Referenced by readout::TPCsetID::cmp(), geo::ChannelMapStandardAlg::ConvertROPtoWirePlane(), geo::ChannelMapStandardAlg::ConvertTPCsetToTPC(), geo::ChannelMapStandardAlg::HasTPCset(), readout::operator!=(), readout::operator<(), readout::operator<<(), and readout::operator==().

---

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

• larcoreobj/v09_10_01/source/larcoreobj/SimpleTypesAndConstants/readout_types.h