geo::OpDetID Struct Reference

The data type to uniquely identify a optical detector. More...

#include "geo_types.h"

Inheritance diagram for geo::OpDetID:

Public Types
using	OpDetID_t = unsigned int
	Type for the ID number. More...
using	ParentID_t = CryostatID
	Type of the parent ID. More...
using	CryostatID_t = unsigned int
	Type for the ID number. More...

Public Member Functions
constexpr	OpDetID ()=default
	Default constructor: an invalid optical detector ID. More...
constexpr	OpDetID (CryostatID const &cryoid, OpDetID_t o)
constexpr	OpDetID (CryostatID_t c, OpDetID_t o)
	Constructor: opdtical detector with index o in the cryostat index c More...
constexpr auto const &	deepestIndex () const
	Returns the value of the deepest ID available (OpDet's). More...
auto &	deepestIndex ()
	Returns the deepest ID available (OpDet's). More...
constexpr ParentID_t const &	parentID () const
	Return the parent ID of this one (a cryostat ID). More...
constexpr ParentID_t &	parentID ()
template<std::size_t Index>
constexpr auto	getIndex () const
	Returns the index level Index of this type. More...
constexpr CryostatID const &	asCryostatID () const
	Conversion to CryostatID (for convenience of notation). More...
constexpr CryostatID &	asCryostatID ()
std::string	toString () const
	Human-readable representation of the optical detector ID. More...
	operator std::string () const
	Human-readable representation of the optical detector ID. More...
ID validity
constexpr	operator bool () const
	Returns true if the ID is 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 OpDetID	first ()
static constexpr OpDetID_t	getInvalidID ()
	Return the value of the invalid optical detector ID as a r-value. More...

Public Attributes
OpDetID_t	OpDet = InvalidID
	Index of the optical detector 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 OpDetID_t	InvalidID = std::numeric_limits<OpDetID_t>::max()
	Special code for an invalid ID. More...
static constexpr auto	Level = details::index_for<OpDetID>()
	Level of this element. More...

Detailed Description

The data type to uniquely identify a optical detector.

Definition at line 249 of file geo_types.h.

Member Typedef Documentation

using geo::CryostatID::CryostatID_t = unsigned int

inherited

Type for the ID number.

Definition at line 188 of file geo_types.h.

using geo::OpDetID::OpDetID_t = unsigned int

Type for the ID number.

Definition at line 250 of file geo_types.h.

using geo::OpDetID::ParentID_t = CryostatID

Type of the parent ID.

Definition at line 252 of file geo_types.h.

Constructor & Destructor Documentation

constexpr geo::OpDetID::OpDetID ( )

default

Default constructor: an invalid optical detector ID.

constexpr geo::OpDetID::OpDetID ( CryostatID const &  cryoid, OpDetID_t  o  )

inline

Constructor: optical detector with index o in the cryostat identified by cryoid

Definition at line 266 of file geo_types.h.

: CryostatID(cryoid), OpDet(o) {}

constexpr geo::OpDetID::OpDetID ( CryostatID_t  c, OpDetID_t  o  )

inline

Constructor: opdtical detector with index o in the cryostat index c

Definition at line 269 of file geo_types.h.

: CryostatID(c), OpDet(o) {}

Member Function Documentation

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

inline

Conversion to CryostatID (for convenience of notation).

Definition at line 294 of file geo_types.h.

{ return parentID(); }

constexpr CryostatID& geo::OpDetID::asCryostatID ( )

inline

Definition at line 295 of file geo_types.h.

{ return parentID(); }

constexpr auto const& geo::OpDetID::deepestIndex ( ) const

inline

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

Definition at line 283 of file geo_types.h.

{ return OpDet; }

auto& geo::OpDetID::deepestIndex ( )

inline

Returns the deepest ID available (OpDet's).

Definition at line 285 of file geo_types.h.

{ return OpDet; }

static constexpr OpDetID geo::OpDetID::first ( )

inlinestatic

Definition at line 271 of file geo_types.h.

References geo::CryostatID::first(), and geo::details::writeToString().

{ return OpDetID{CryostatID::first(), 0}; }

template<std::size_t Index>

constexpr auto geo::OpDetID::getIndex

(

)

const

Returns the index level Index of this type.

Definition at line 650 of file geo_types.h.

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

static constexpr OpDetID_t geo::OpDetID::getInvalidID ( )

inlinestatic

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

Definition at line 301 of file geo_types.h.

References InvalidID.

{ return OpDetID::InvalidID; }

void geo::CryostatID::markInvalid ( )

inlineinherited

Sets the ID as invalid.

Definition at line 220 of file geo_types.h.

References geo::details::writeToString().

{ setValidity(false); }

void geo::CryostatID::markValid ( )

inlineinherited

Sets the ID as valid.

Definition at line 217 of file geo_types.h.

{ setValidity(true); }

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

inlineexplicitinherited

Returns true if the ID is valid.

Definition at line 211 of file geo_types.h.

{ return isValid; }

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

inlineexplicit

Human-readable representation of the optical detector ID.

Definition at line 278 of file geo_types.h.

{ return toString(); }

constexpr ParentID_t const& geo::OpDetID::parentID ( ) const

inline

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

Definition at line 287 of file geo_types.h.

Referenced by geo::operator<<().

{ return *this; }

constexpr ParentID_t& geo::OpDetID::parentID ( )

inline

Definition at line 288 of file geo_types.h.

{ return *this; }

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

inlineinherited

Sets the validity of the ID.

Definition at line 214 of file geo_types.h.

{ isValid = valid; }

std::string geo::OpDetID::toString ( ) const

inline

Human-readable representation of the optical detector ID.

Definition at line 277 of file geo_types.h.

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

Member Data Documentation

CryostatID_t geo::CryostatID::Cryostat = InvalidID

inherited

Index of cryostat.

Definition at line 195 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(), detinfo::DetectorPropertiesData::ConvertTicksToX(), 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::FitTP3Ds(), ems::EMShower3D::GetCloseHits(), geo::GeometryCore::GetClosestOpDet(), calo::GnocchiCalorimetry::GetPitch(), pma::Track3D::GetUnconstrainedProj3D(), detinfo::DetectorPropertiesData::GetXTicksOffset(), cluster::MergeClusterAlg::GlobalWire(), cluster::BlurredClusteringAlg::GlobalWire(), shower::EMShowerAlg::GlobalWire_(), geo::GeometryCore::HasCryostat(), tss::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(), apa::APAGeometryAlg::NearestWireIDOnChan(), geo::WireReadoutStandardGeom::NTPCsets(), 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(), detsim::SimDriftElectrons::produce(), calo::Calorimetry::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 OpDetID_t geo::OpDetID::InvalidID = std::numeric_limits<OpDetID_t>::max()

static

Special code for an invalid ID.

Definition at line 256 of file geo_types.h.

Referenced by getInvalidID().

bool geo::CryostatID::isValid = false

inherited

Whether this ID points to a valid element.

Definition at line 194 of file geo_types.h.

Referenced by trkf::TrajectoryMCSFitter::breakTrajInSegments(), hit::HitCheater::FindHitsOnChannel(), shower::EMShowerAlg::FindInitialTrackHits(), geo::WireReadoutStandardGeom::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::WireReadoutStandardGeom::NTPCsets(), shower::EMShowerAlg::OrderShowerHits_(), calo::ShowerCalorimetry::produce(), calo::Calorimetry::produce(), calo::GnocchiCalorimetry::produce(), shower::EMShowerAlg::Project3DPointOntoPlane_(), geo::WireReadoutStandardGeom::ROPtoTPCs(), geo::WireReadoutStandardGeom::ROPtoWirePlanes(), filt::LArG4ParticleFilter::StartInTPCCheck(), filt::LArG4ParticleFilter::StopInTPCCheck(), geo::WireReadoutStandardGeom::TPCsetToTPCs(), and filt::LArG4ParticleFilter::TPCTrajLengthCheck().

constexpr auto geo::OpDetID::Level = details::index_for<OpDetID>()

static

Level of this element.

Definition at line 298 of file geo_types.h.

OpDetID_t geo::OpDetID::OpDet = InvalidID

Index of the optical detector within its cryostat.

Definition at line 259 of file geo_types.h.

Referenced by geo::operator<<().

---

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

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