LArSoft  v06_85_00
Liquid Argon Software toolkit - http://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

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

 TPCsetID ()
 Default constructor: an invalid TPC set ID. More...
 
 TPCsetID (CryostatID const &cryoid, TPCsetID_t s)
 Constructor: TPC set with index g in the cryostat identified by cryoid. More...
 
 TPCsetID (CryostatID_t c, TPCsetID_t s)
 Constructor: TPC with index t in the cryostat index c. More...
 
 operator std::string () const
 Human-readable representation of the TPC set ID. More...
 
TPCsetID const & asTPCsetID () const
 Conversion to TPCsetID (for convenience of notation). More...
 
TPCsetIDasTPCsetID ()
 Conversion to TPCsetID (for convenience of notation). More...
 
TPCsetID const & asConstTPCsetID ()
 Conversion to TPCsetID (for convenience of notation). More...
 
int cmp (TPCsetID 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...
 
int cmp (CryostatID const &other) const
 Returns < 0 if this is smaller than other, 0 if equal, > 0 if larger. More...
 
CryostatID const & asCryostatID () const
 Conversion to CryostatID (for convenience of notation). More...
 
CryostatIDasCryostatID ()
 Conversion to CryostatID (for convenience of notation). More...
 
CryostatID const & asConstCryostatID ()
 Conversion to CryostatID (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 TPCsetID_t getInvalidID ()
 Return the value of the invalid TPC 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

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 TPCsetID_t InvalidID = USHRT_MAX
 Special code for an invalid ID. 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 41 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 short readout::TPCsetID::TPCsetID_t

type for the ID number

Definition at line 42 of file readout_types.h.

Constructor & Destructor Documentation

readout::TPCsetID::TPCsetID ( )
inline

Default constructor: an invalid TPC set ID.

Definition at line 54 of file readout_types.h.

CryostatID()=default
Default constructor: an invalid cryostat.
static const TPCsetID_t InvalidID
Special code for an invalid ID.
Definition: readout_types.h:49
TPCsetID_t TPCset
index of the TPC set within its cryostat
Definition: readout_types.h:51
readout::TPCsetID::TPCsetID ( CryostatID const &  cryoid,
TPCsetID_t  s 
)
inline

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

Definition at line 57 of file readout_types.h.

57  :
58  CryostatID(cryoid), TPCset(s) {}
Float_t s
Definition: plot.C:23
CryostatID()=default
Default constructor: an invalid cryostat.
TPCsetID_t TPCset
index of the TPC set within its cryostat
Definition: readout_types.h:51
readout::TPCsetID::TPCsetID ( CryostatID_t  c,
TPCsetID_t  s 
)
inline

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

Definition at line 61 of file readout_types.h.

61 : CryostatID(c), TPCset(s) {}
Float_t s
Definition: plot.C:23
CryostatID()=default
Default constructor: an invalid cryostat.
TPCsetID_t TPCset
index of the TPC set within its cryostat
Definition: readout_types.h:51

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.

181 { return *this; }
TPCsetID const& readout::TPCsetID::asConstTPCsetID ( )
inline

Conversion to TPCsetID (for convenience of notation).

Definition at line 74 of file readout_types.h.

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

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

Conversion to CryostatID (for convenience of notation).

Definition at line 179 of file geo_types.h.

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

Conversion to TPCsetID (for convenience of notation).

Definition at line 70 of file readout_types.h.

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

Conversion to TPCsetID (for convenience of notation).

Definition at line 72 of file readout_types.h.

72 { return *this; }
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 77 of file readout_types.h.

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

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

78  {
79  int cmp_res = CryostatID::cmp(other);
80  if (cmp_res == 0) // same cryostat: compare TPC set
81  return ThreeWayComparison(TPCset, other.TPCset);
82  else // return the order of cryostats
83  return cmp_res;
84  } // cmp()
static int ThreeWayComparison(T a, T b)
Returns < 0 if a < b, 0 if a == b, > 0 if a > b.
Definition: geo_types.h:188
TPCsetID_t TPCset
index of the TPC set within its cryostat
Definition: readout_types.h:51
int cmp(CryostatID const &other) const
Returns < 0 if this is smaller than other, 0 if equal, > 0 if larger.
Definition: geo_types.h:173
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 cmp(), geo::TPCID::cmp(), and readout::operator<().

174  { return ThreeWayComparison(deepestIndex(), other.deepestIndex()); }
auto const & deepestIndex() const
Returns the value of the deepest ID available (cryostat&#39;s).
Definition: geo_types.h:168
static int ThreeWayComparison(T a, T b)
Returns < 0 if a < b, 0 if a == b, > 0 if a > b.
Definition: geo_types.h:188
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().

168 { return Cryostat; }
CryostatID_t Cryostat
Index of cryostat.
Definition: geo_types.h:130
auto& geo::CryostatID::deepestIndex ( )
inlineinherited

Returns the deepest ID available (cryostat's).

Definition at line 170 of file geo_types.h.

170 { return Cryostat; }
CryostatID_t Cryostat
Index of cryostat.
Definition: geo_types.h:130
static TPCsetID_t readout::TPCsetID::getInvalidID ( )
inlinestatic

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

Definition at line 87 of file readout_types.h.

References InvalidID.

87 { return TPCsetID::InvalidID; }
static const TPCsetID_t InvalidID
Special code for an invalid ID.
Definition: readout_types.h:49
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().

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

Sets the ID as valid.

Definition at line 154 of file geo_types.h.

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

Returns true if the ID is valid.

Definition at line 145 of file geo_types.h.

145 { return isValid; }
bool isValid
Whether this ID points to a valid element.
Definition: geo_types.h:129
readout::TPCsetID::operator std::string ( ) const
inlineexplicit

Human-readable representation of the TPC set ID.

Definition at line 66 of file readout_types.h.

References readout::details::writeToString().

67  { return readout::details::writeToString(*this); }
std::string writeToString(T const &value)
Definition: readout_types.h:23
bool geo::CryostatID::operator! ( ) const
inlineinherited

Returns true if the ID is not valid.

Definition at line 148 of file geo_types.h.

148 { return !isValid; }
bool isValid
Whether this ID points to a valid element.
Definition: geo_types.h:129
void geo::CryostatID::setValidity ( bool  valid)
inlineinherited

Sets the validity of the ID.

Definition at line 151 of file geo_types.h.

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

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

Definition at line 188 of file geo_types.h.

189  { 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(), cluster::BlurredClusteringAlg::ConvertRecobHitsToVector(), 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(), tca::DefineTjParents(), 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(), tca::GetOrigin(), 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(), tca::KillPoorVertices(), lar_cluster3d::PCASeedFinderAlg::LineFit2DHits(), lar_cluster3d::HoughSeedFinderAlg::LineFit2DHits(), geo::details::cryostat_id_iterator_base< GEOID >::localID(), tca::MCParticleListUtils::MakeCheatShower(), apa::DisambigAlg::MakeCloseHits(), lar_cluster3d::StandardHit3DBuilder::makeDeadChannelPair(), lar_cluster3d::StandardHit3DBuilder::makeHitPair(), trkf::SpacePointAlg::makeSpacePoints(), trkf::CosmicTrackerAlg::MakeSPT(), tca::Match2DShowers(), tca::TruthMatcher::MatchAndSum(), tca::TruthMatcher::MatchTruth(), tca::MCParticleListUtils::MCParticleStartTjID(), 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::MCParticleListUtils::PrimaryElectronPFPID(), tca::PrintAllTraj(), cluster::LineCluster::produce(), cluster::TrajCluster::produce(), cluster::ClusterCheater::produce(), cluster::SmallClusterFinder::produce(), calo::Calorimetry::produce(), hit::DPRawHitFinder::produce(), evd::GraphCluster::produce(), tca::TruthMatcher::PutMCPHitsInVector(), tca::Reconcile3D(), tca::ScoreVertices(), trkf::SpacePointAlg::separation(), cheat::BackTracker::SpacePointHitsToWeightedXYZ(), tca::TrajClusterAlg::StepCrawl(), lar::util::TrackPitchInView(), apa::DisambigAlg::TrivialDisambig(), cluster::ClusterCrawlerAlg::Vtx3ClusterMatch(), cluster::ClusterCrawlerAlg::Vtx3ClusterSplit(), cluster::ClusterCrawlerAlg::VtxMatch(), geo::ChannelMapAlg::WireCoordinate(), and tca::WireHitRangeOK().

const TPCsetID_t readout::TPCsetID::InvalidID = USHRT_MAX
static

Special code for an invalid ID.

Definition at line 49 of file readout_types.h.

Referenced by getInvalidID().


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