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
typedef unsigned int	ROPID_t
	type for the ID number More...
typedef unsigned short	TPCsetID_t
	type for the ID number More...
typedef unsigned int	CryostatID_t
	Type for the ID number. More...

Public Member Functions
	ROPID ()
	Default constructor: an invalid plane ID. More...
	ROPID (TPCsetID const &tpcsetid, ROPID_t r)
	ROPID (CryostatID_t c, TPCsetID_t s, ROPID_t r)
	Constructor: plane with index p in the cryostat index c, TPC index t. More...
	operator std::string () const
	Human-readable representation of the ROP ID. More...
ROPID const &	asROPID () const
	Conversion to ROPID (for convenience of notation). More...
ROPID &	asROPID ()
	Conversion to ROPID (for convenience of notation). More...
ROPID const &	asConstROPID ()
	Conversion to ROPID (for convenience of notation). More...
int	cmp (ROPID const &other) const
	Returns < 0 if this is smaller than other, 0 if equal, > 0 if larger. More...
int	cmp (TPCsetID const &other) const
	Returns < 0 if this is smaller than other, 0 if equal, > 0 if larger. More...
int	cmp (CryostatID const &other) const
	Returns < 0 if this is smaller than other, 0 if equal, > 0 if larger. More...
auto const &	deepestIndex () const
	Returns the value of the deepest ID available (cryostat's). More...
auto &	deepestIndex ()
	Returns the deepest ID available (cryostat's). More...
CryostatID const &	asCryostatID () const
	Conversion to CryostatID (for convenience of notation). More...
CryostatID &	asCryostatID ()
	Conversion to CryostatID (for convenience of notation). More...
CryostatID const &	asConstCryostatID ()
	Conversion to CryostatID (for convenience of notation). More...
TPCsetID const &	asTPCsetID () const
	Conversion to TPCsetID (for convenience of notation) More...
TPCsetID &	asTPCsetID ()
	Conversion to TPCsetID (for convenience of notation) More...
TPCsetID const &	asConstTPCsetID ()
	Conversion to TPCsetID (for convenience of notation) More...
ID validity
	operator bool () const
	Returns true if the ID is valid. More...
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 ROPID_t	getInvalidID ()
	Return the value of the invalid ROP ID as a r-value. More...
template<typename T >
static 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
	index of the plane within its TPC More...
TPCsetID_t	TPCset
	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 const ROPID_t	InvalidID = USHRT_MAX
	Special code for an invalid ID. 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 103 of file readout_types.h.

Member Typedef Documentation

typedef unsigned int geo::CryostatID::CryostatID_t

inherited

Type for the ID number.

Definition at line 121 of file geo_types.h.

typedef unsigned int readout::ROPID::ROPID_t

type for the ID number

Definition at line 104 of file readout_types.h.

typedef unsigned short readout::TPCsetID::TPCsetID_t

inherited

type for the ID number

Definition at line 42 of file readout_types.h.

Constructor & Destructor Documentation

readout::ROPID::ROPID ( )

inline

Default constructor: an invalid plane ID.

Definition at line 115 of file readout_types.h.

: TPCsetID(), ROP(InvalidID) {}

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 119 of file readout_types.h.

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

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

inline

Constructor: plane with index p in the cryostat index c, TPC index t.

Definition at line 122 of file readout_types.h.

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

Member Function Documentation

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

inlineinherited

Conversion to CryostatID (for convenience of notation).

Definition at line 181 of file geo_types.h.

{ return *this; }

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

inline

Conversion to ROPID (for convenience of notation).

Definition at line 135 of file readout_types.h.

{ return *this; }

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

inline

Conversion to TPCsetID (for convenience of notation)

Definition at line 151 of file readout_types.h.

{ return *this; }

CryostatID const& geo::CryostatID::asCryostatID ( ) const

inlineinherited

Conversion to CryostatID (for convenience of notation).

Definition at line 177 of file geo_types.h.

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

{ return *this; }

CryostatID& geo::CryostatID::asCryostatID ( )

inlineinherited

Conversion to CryostatID (for convenience of notation).

Definition at line 179 of file geo_types.h.

{ return *this; }

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

inline

Conversion to ROPID (for convenience of notation).

Definition at line 131 of file readout_types.h.

{ return *this; }

ROPID& readout::ROPID::asROPID ( )

inline

Conversion to ROPID (for convenience of notation).

Definition at line 133 of file readout_types.h.

{ return *this; }

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

inline

Conversion to TPCsetID (for convenience of notation)

Definition at line 149 of file readout_types.h.

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

{ return *this; }

TPCsetID& readout::ROPID::asTPCsetID ( )

inline

Conversion to TPCsetID (for convenience of notation)

Definition at line 150 of file readout_types.h.

{ return *this; }

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

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

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 173 of file geo_types.h.

References geo::CryostatID::deepestIndex().

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

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

auto const& geo::CryostatID::deepestIndex ( ) const

inlineinherited

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

Definition at line 168 of file geo_types.h.

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

{ return Cryostat; }

auto& geo::CryostatID::deepestIndex ( )

inlineinherited

Returns the deepest ID available (cryostat's).

Definition at line 170 of file geo_types.h.

{ return Cryostat; }

static ROPID_t readout::ROPID::getInvalidID ( )

inlinestatic

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

Definition at line 155 of file readout_types.h.

References InvalidID.

{ return ROPID::InvalidID; }

void geo::CryostatID::markInvalid ( )

inlineinherited

Sets the ID as invalid.

Definition at line 157 of file geo_types.h.

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

{ setValidity(false); }

void geo::CryostatID::markValid ( )

inlineinherited

Sets the ID as valid.

Definition at line 154 of file geo_types.h.

{ setValidity(true); }

geo::CryostatID::operator bool ( ) const

inlineexplicitinherited

Returns true if the ID is valid.

Definition at line 145 of file geo_types.h.

{ return isValid; }

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

inlineexplicit

Human-readable representation of the ROP ID.

Definition at line 127 of file readout_types.h.

References readout::details::writeToString().

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

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

inlineinherited

Returns true if the ID is not valid.

Definition at line 148 of file geo_types.h.

{ return !isValid; }

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

inlineinherited

Sets the validity of the ID.

Definition at line 151 of file geo_types.h.

{ isValid = valid; }

template<typename T >

static 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 188 of file geo_types.h.

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

Member Data Documentation

CryostatID_t geo::CryostatID::Cryostat = InvalidID

inherited

Index of cryostat.

Definition at line 130 of file geo_types.h.

Referenced by detsim::WienerFilterAna::analyze(), hit::GausHitFinderAna::analyze(), mvapid::MVAAlg::CalcSegmentdEdxDist(), tca::TruthMatcher::CanReconstruct(), tca::ChgFracBetween(), tca::ChgFracNearEnd(), trkf::SpacePointAlg::compatible(), tca::CompleteIncomplete3DVerticesInGaps(), geo::ChannelMapStandardAlg::ConvertROPtoWirePlane(), util::DetectorPropertiesServiceArgoNeuT::ConvertTicksToX(), detinfo::DetectorPropertiesStandard::ConvertTicksToX(), geo::ChannelMapStandardAlg::ConvertTPCsetToTPC(), geo::ChannelMapStandardAlg::ConvertTPCtoTPCset(), geo::ChannelMapStandardAlg::ConvertWirePlaneToROP(), util::DetectorPropertiesServiceArgoNeuT::ConvertXToTicks(), detinfo::DetectorPropertiesStandard::ConvertXToTicks(), trkf::SpacePointAlg::correctedTime(), tss::Hit2D::Cryo(), geo::GeometryCore::Cryostat(), geo::GeometryCore::CryostatPtr(), cluster::ClusterCrawlerAlg::EncodeCTP(), tca::EncodeCTP(), cluster::EndPointAlg::EndPoint(), ems::EndPoint::EndPoint(), trkf::SpacePointAlg::fillComplexSpacePoint(), tca::FillmAllTraj(), lar_pandora::PFParticleHitDumper::FillRecoWires(), trkf::SpacePointAlg::fillSpacePoint(), tca::FillWireHitRange(), tca::Find3DVertices(), apa::DisambigAlg::FindChanTimeEndPts(), tca::FindCompleteness(), geo::GeometryCore::FindCryostatAtPosition(), hit::HitCheater::FindHitsOnChannel(), tca::FindMissedTjsInTp3s(), tca::TrajClusterAlg::FindMissedVxTjs(), tca::FindParent(), tca::FindPFParticles(), tca::FindShowers3D(), geo::GeometryCore::FindTPCAtPosition(), tca::FindXMatches(), tca::FitTp3(), tca::FitTp3s(), cluster::ClusterCrawlerAlg::FitVtx(), tca::FollowTp3s(), ems::EMShower3D::GetCloseHits(), trkf::BezierTrack::GetClosestApproach(), trkf::BezierTrack::GetClosestApproaches(), geo::GeometryCore::GetClosestOpDet(), geo::GeometryCore::GetEndTPCID(), geo::GeometryCore::GetEndTPCsetID(), lar_cluster3d::PrincipalComponentsAlg::getHit2DPocaToAxis(), cluster::ClusterCrawlerAlg::GetHitRange(), calo::Calorimetry::GetPitch(), nnet::TrainingDataAlg::getProjection(), lar_pandora::LArPandoraInput::GetTrueStartAndEndPoints(), pma::Track3D::GetUnconstrainedProj3D(), lar_pandora::PFParticleHitDumper::GetUVW(), util::DetectorPropertiesServiceArgoNeuT::GetXTicksCoefficient(), detinfo::DetectorPropertiesStandard::GetXTicksCoefficient(), util::DetectorPropertiesServiceArgoNeuT::GetXTicksOffset(), detinfo::DetectorPropertiesStandard::GetXTicksOffset(), cluster::MergeClusterAlg::GlobalWire(), cluster::BlurredClusteringAlg::GlobalWire(), shower::EMShowerAlg::GlobalWire(), geo::TPCDataContainer< T >::hasCryostat(), geo::PlaneDataContainer< T >::hasCryostat(), geo::GeometryCore::HasCryostat(), ems::Hit2D::Hit2D(), tss::Hit2D::Hit2D(), pma::Hit3D::Hit3D(), hit::DisambigCheater::InitHitToWids(), trkf::KHitWireLine::KHitWireLine(), trkf::KHitWireX::KHitWireX(), lar_cluster3d::PCASeedFinderAlg::LineFit2DHits(), lar_cluster3d::HoughSeedFinderAlg::LineFit2DHits(), geo::details::cryostat_id_iterator_base< GEOID >::localID(), apa::DisambigAlg::MakeCloseHits(), lar_cluster3d::StandardHit3DBuilder::makeDeadChannelPair(), lar_cluster3d::StandardHit3DBuilder::makeHitPair(), trkf::SpacePointAlg::makeSpacePoints(), trkf::CosmicTrackerAlg::MakeSPT(), evd::SimulationDrawer::MCTruth3D(), tca::MergePFPTjs(), geo::ChannelMapAlg::NearestWireID(), geo::ChannelMapStandardAlg::NTPCsets(), geo::operator!=(), geo::operator<(), anab::operator<<(), recob::operator<<(), geo::operator<<(), geo::operator==(), lar_cluster3d::PrincipalComponentsAlg::PCAAnalysis_2D(), geo::ChannelMapAlg::PlaneWireToChannel(), tca::PosInPlane(), geo::GeometryCore::PositionToCryostat(), geo::GeometryCore::PositionToTPC(), tca::Print3S(), tca::Print3V(), tca::PrintAllTraj(), cluster::LineCluster::produce(), cluster::ClusterCheater::produce(), cluster::TrajCluster::produce(), cluster::SmallClusterFinder::produce(), hit::DPRawHitFinder::produce(), calo::Calorimetry::produce(), evd::GraphCluster::produce(), trkf::SpacePointAlg::separation(), cheat::BackTracker::SpacePointHitsToWeightedXYZ(), lar::util::TrackPitchInView(), apa::DisambigAlg::TrivialDisambig(), cluster::ClusterCrawlerAlg::Vtx3ClusterMatch(), cluster::ClusterCrawlerAlg::Vtx3ClusterSplit(), cluster::ClusterCrawlerAlg::VtxMatch(), geo::ChannelMapAlg::WireCoordinate(), and tca::WireHitRangeOK().

const ROPID_t readout::ROPID::InvalidID = USHRT_MAX

static

Special code for an invalid ID.

Definition at line 110 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 129 of file geo_types.h.

Referenced by 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(), hit::DisambigCheater::MakeDisambigHit(), apa::DisambigAlg::MakeDisambigHit(), evd::SimulationDrawer::MCTruthOrtho(), geo::ChannelMapStandardAlg::NTPCsets(), shower::EMShowerAlg::OrderShowerHits(), calo::Calorimetry::produce(), shower::EMShowerAlg::Project3DPointOntoPlane(), geo::ChannelMapStandardAlg::ROPtoTPCs(), geo::ChannelMapStandardAlg::ROPtoWirePlanes(), filt::LArG4ParticleFilter::StartInTPCCheck(), filt::LArG4ParticleFilter::StopInTPCCheck(), geo::ChannelMapStandardAlg::TPCsetToTPCs(), filt::LArG4ParticleFilter::TPCTrajLengthCheck(), and lar::util::TrackPitchInView().

ROPID_t readout::ROPID::ROP

index of the plane within its TPC

Definition at line 112 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

inherited

index of the TPC set within its cryostat

Definition at line 51 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:

• /cvmfs/larsoft.opensciencegrid.org/products/larcoreobj/v07_00_01/source/larcoreobj/SimpleTypesAndConstants/readout_types.h