geo::CryostatID Struct Reference

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

#include "geo_types.h"

Inheritance diagram for geo::CryostatID:

Public Types
typedef unsigned int	CryostatID_t
	Type for the ID number. More...

Public Member Functions
	CryostatID ()=default
	Default constructor: an invalid cryostat. More...
	CryostatID (CryostatID_t c)
	Constructor: valid ID of cryostat with index c. More...
	CryostatID (CryostatID_t c, bool valid)
	Constructor: valid ID of cryostat with index c. More...
	operator std::string () const
	Human-readable representation of the cryostat ID. 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...
CryostatID &	asCryostatID ()
	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 CryostatID_t	getInvalidID ()
	Return the value of the invalid 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
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 CryostatID_t	InvalidID = std::numeric_limits<CryostatID_t>::max()
	Special code for an invalid ID. More...

Detailed Description

The data type to uniquely identify a cryostat.

Definition at line 120 of file geo_types.h.

Member Typedef Documentation

typedef unsigned int geo::CryostatID::CryostatID_t

Type for the ID number.

Definition at line 121 of file geo_types.h.

Constructor & Destructor Documentation

geo::CryostatID::CryostatID ( )

default

Default constructor: an invalid cryostat.

geo::CryostatID::CryostatID ( CryostatID_t  c )

inlineexplicit

Constructor: valid ID of cryostat with index c.

Definition at line 136 of file geo_types.h.

: isValid(true), Cryostat(c) {}

geo::CryostatID::CryostatID ( CryostatID_t  c, bool  valid  )

inline

Constructor: valid ID of cryostat with index c.

Definition at line 139 of file geo_types.h.

: isValid(valid), Cryostat(c) {}

Member Function Documentation

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

inline

Conversion to CryostatID (for convenience of notation).

Definition at line 181 of file geo_types.h.

{ return *this; }

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

inline

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

inline

Conversion to CryostatID (for convenience of notation).

Definition at line 179 of file geo_types.h.

{ return *this; }

int geo::CryostatID::cmp ( CryostatID const &  other ) const

inline

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

Definition at line 173 of file geo_types.h.

References deepestIndex().

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

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

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

inline

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

Definition at line 168 of file geo_types.h.

Referenced by cmp().

{ return Cryostat; }

auto& geo::CryostatID::deepestIndex ( )

inline

Returns the deepest ID available (cryostat's).

Definition at line 170 of file geo_types.h.

{ return Cryostat; }

static CryostatID_t geo::CryostatID::getInvalidID ( )

inlinestatic

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

Definition at line 184 of file geo_types.h.

References InvalidID.

{ return CryostatID::InvalidID; }

void geo::CryostatID::markInvalid ( )

inline

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

inline

Sets the ID as valid.

Definition at line 154 of file geo_types.h.

{ setValidity(true); }

geo::CryostatID::operator bool ( ) const

inlineexplicit

Returns true if the ID is valid.

Definition at line 145 of file geo_types.h.

{ return isValid; }

geo::CryostatID::operator std::string ( ) const

inlineexplicit

Human-readable representation of the cryostat ID.

Definition at line 163 of file geo_types.h.

References geo::details::writeToString().

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

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

inline

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 )

inline

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  )

inlinestatic

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

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(), hit::DPRawHitFinder::produce(), calo::Calorimetry::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 CryostatID_t geo::CryostatID::InvalidID = std::numeric_limits<CryostatID_t>::max()

static

Special code for an invalid ID.

Definition at line 126 of file geo_types.h.

Referenced by geo::GeometryCore::FindCryostatAtPosition(), getInvalidID(), and geo::GeometryCore::PositionToCryostat().

bool geo::CryostatID::isValid = false

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

---

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

• larcoreobj/v1_24_01/source/larcoreobj/SimpleTypesAndConstants/geo_types.h