readout::TPCsetID Struct Reference

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

#include "readout_types.h"

Inheritance diagram for readout::TPCsetID:

Public Types
using	TPCsetID_t = unsigned short
	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	TPCsetID ()=default
	Default constructor: an invalid TPC set ID. More...
constexpr	TPCsetID (CryostatID const &cryoid, TPCsetID_t s)
	Constructor: TPC set with index s in the cryostat identified by cryoid. More...
constexpr	TPCsetID (CryostatID_t c, TPCsetID_t s)
	Constructor: TPC set with index s in the cryostat index c. More...
constexpr auto const &	deepestIndex () const
	Returns the value of the deepest ID available (TPC set's). More...
auto &	deepestIndex ()
	Returns the deepest ID available (TPC set'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 TPCsetID (for convenience of notation). More...
constexpr CryostatID &	asCryostatID ()
std::string	toString () const
	Human-readable representation of the TPC set ID. More...
	operator std::string () const
	Human-readable representation of the TPC set 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 auto	first ()
static constexpr auto	first (CryostatID const &id)
static constexpr TPCsetID_t	getInvalidID ()
	Return the value of the invalid TPC ID as a r-value. More...

Public Attributes
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 TPCsetID_t	InvalidID = std::numeric_limits<TPCsetID_t>::max()
	Special code for an invalid ID. More...
static constexpr auto	Level = geo::details::index_for<TPCsetID>()
	Level of this element. 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 54 of file readout_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 readout::TPCsetID::ParentID_t = CryostatID

Type of the parent ID.

Definition at line 57 of file readout_types.h.

using readout::TPCsetID::TPCsetID_t = unsigned short

Type for the ID number.

Definition at line 55 of file readout_types.h.

Constructor & Destructor Documentation

constexpr readout::TPCsetID::TPCsetID ( )

default

Default constructor: an invalid TPC set ID.

constexpr readout::TPCsetID::TPCsetID ( CryostatID const &  cryoid, TPCsetID_t  s  )

inline

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

Definition at line 69 of file readout_types.h.

: CryostatID(cryoid), TPCset(s) {}

constexpr readout::TPCsetID::TPCsetID ( CryostatID_t  c, TPCsetID_t  s  )

inline

Constructor: TPC set with index s in the cryostat index c.

Definition at line 72 of file readout_types.h.

: CryostatID(c), TPCset(s) {}

Member Function Documentation

constexpr CryostatID const& readout::TPCsetID::asCryostatID ( ) const

inline

Conversion to TPCsetID (for convenience of notation).

Definition at line 98 of file readout_types.h.

Referenced by readout::operator<<().

{ return parentID(); }

constexpr CryostatID& readout::TPCsetID::asCryostatID ( )

inline

Definition at line 99 of file readout_types.h.

{ return parentID(); }

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

inline

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

Definition at line 87 of file readout_types.h.

{ return TPCset; }

auto& readout::TPCsetID::deepestIndex ( )

inline

Returns the deepest ID available (TPC set's).

Definition at line 89 of file readout_types.h.

{ return TPCset; }

static constexpr auto readout::TPCsetID::first ( )

inlinestatic

Definition at line 74 of file readout_types.h.

References geo::CryostatID::first().

Referenced by readout::ROPID::first().

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

static constexpr auto readout::TPCsetID::first ( CryostatID const &  id )

inlinestatic

Definition at line 75 of file readout_types.h.

References readout::details::writeToString().

{ return TPCsetID{id, 0}; }

template<std::size_t Index>

constexpr auto readout::TPCsetID::getIndex

(

)

const

Returns the index level Index of this type.

Definition at line 196 of file readout_types.h.

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

static constexpr TPCsetID_t readout::TPCsetID::getInvalidID ( )

inlinestatic

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

Definition at line 105 of file readout_types.h.

References InvalidID.

{ return TPCsetID::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; }

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

inlineexplicit

Human-readable representation of the TPC set ID.

Definition at line 82 of file readout_types.h.

{ return toString(); }

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

inline

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

Definition at line 91 of file readout_types.h.

{ return *this; }

constexpr ParentID_t& readout::TPCsetID::parentID ( )

inline

Definition at line 92 of file readout_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 readout::TPCsetID::toString ( ) const

inline

Human-readable representation of the TPC set ID.

Definition at line 81 of file readout_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 TPCsetID_t readout::TPCsetID::InvalidID = std::numeric_limits<TPCsetID_t>::max()

static

Special code for an invalid ID.

Definition at line 60 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 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 readout::TPCsetID::Level = geo::details::index_for<TPCsetID>()

static

Level of this element.

Definition at line 102 of file readout_types.h.

TPCsetID_t readout::TPCsetID::TPCset = InvalidID

Index of the TPC set within its cryostat.

Definition at line 63 of file readout_types.h.

Referenced by geo::WireReadoutStandardGeom::HasTPCset(), and readout::operator<<().

---

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

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