geo::GeometryCore Class Reference

geo::GeometryData_t::auxDets

GeometryData_t fGeoData

The detector description data.

Definition: GeometryCore.h:5508

AuxDetList_t auxDets

The auxiliary detectors.

Definition: GeometryData.h:39

AuxDetList_t const& geo::GeometryCore::AuxDets ( ) const

inlineprotected

Definition at line 5503 of file GeometryCore.h.

5503 { return fGeoData.auxDets; }

geo::GeometryData_t::auxDets

GeometryData_t fGeoData

The detector description data.

Definition: GeometryCore.h:5508

AuxDetList_t auxDets

The auxiliary detectors.

Definition: GeometryData.h:39

cryostat_iterator geo::GeometryCore::begin_cryostat ( ) const

inline

Returns an iterator pointing to the first cryostat.

Definition at line 2162 of file GeometryCore.h.

2163 { return cryostat_iterator(this, cryostat_iterator::begin_pos); }

geo::GeometryCore::cryostat_iterator

geo::cryostat_iterator cryostat_iterator

Forward-iterator browsing all cryostats in the detector.

Definition: GeometryCore.h:1565

static constexpr BeginPos_t begin_pos

Definition: GeometryCore.h:107

cryostat_id_iterator geo::GeometryCore::begin_cryostat_id ( ) const

inline

Returns an iterator pointing to the first cryostat ID.

Definition at line 2154 of file GeometryCore.h.

2155 { return cryostat_id_iterator(this, cryostat_id_iterator::begin_pos); }

geo::GeometryCore::cryostat_id_iterator

static constexpr BeginPos_t begin_pos

Definition: GeometryCore.h:107

geo::cryostat_id_iterator cryostat_id_iterator

Forward-iterator browsing all cryostat IDs in the detector.

Definition: GeometryCore.h:1544

plane_iterator geo::GeometryCore::begin_plane ( ) const

inline

Returns an iterator pointing to the first plane in the detector.

Definition at line 3087 of file GeometryCore.h.

3088 { return plane_iterator(this, plane_iterator::begin_pos); }

static constexpr BeginPos_t begin_pos

Definition: GeometryCore.h:107

geo::plane_iterator plane_iterator

Forward-iterator browsing all planes in the detector.

Definition: GeometryCore.h:1657

plane_iterator geo::GeometryCore::begin_plane ( geo::CryostatID const & ID ) const

inline

Returns an iterator pointing to the first plane in the specified cryostat.

Definition at line 3096 of file GeometryCore.h.

3097 { return plane_iterator(this, GetBeginPlaneID(ID)); }

geo::PlaneID GetBeginPlaneID(geo::CryostatID const &id) const

Returns the ID of the first plane of the specified cryostat.

Definition: GeometryCore.h:3043

geo::plane_iterator plane_iterator

Forward-iterator browsing all planes in the detector.

Definition: GeometryCore.h:1657

plane_iterator geo::GeometryCore::begin_plane ( geo::TPCID const & ID ) const

inline

Returns an iterator pointing to the first plane in the specified TPC.

Definition at line 3105 of file GeometryCore.h.

3106 { return plane_iterator(this, GetBeginPlaneID(ID)); }

geo::PlaneID GetBeginPlaneID(geo::CryostatID const &id) const

Returns the ID of the first plane of the specified cryostat.

Definition: GeometryCore.h:3043

geo::plane_iterator plane_iterator

Forward-iterator browsing all planes in the detector.

Definition: GeometryCore.h:1657

plane_id_iterator geo::GeometryCore::begin_plane_id ( ) const

inline

Returns an iterator pointing to the first plane ID in the detector.

Definition at line 3059 of file GeometryCore.h.

3060 { return plane_id_iterator(this, plane_id_iterator::begin_pos); }

static constexpr BeginPos_t begin_pos

Definition: GeometryCore.h:107

geo::plane_id_iterator plane_id_iterator

Forward-iterator browsing all plane IDs in the detector.

Definition: GeometryCore.h:1635

plane_id_iterator geo::GeometryCore::begin_plane_id ( geo::CryostatID const & ID ) const

inline

Returns an iterator pointing to the first plane ID in the specified cryostat.

Definition at line 3068 of file GeometryCore.h.

3069 { return plane_id_iterator(this, GetBeginPlaneID(ID)); }

geo::PlaneID GetBeginPlaneID(geo::CryostatID const &id) const

Returns the ID of the first plane of the specified cryostat.

Definition: GeometryCore.h:3043

geo::plane_id_iterator plane_id_iterator

Forward-iterator browsing all plane IDs in the detector.

Definition: GeometryCore.h:1635

plane_id_iterator geo::GeometryCore::begin_plane_id ( geo::TPCID const & ID ) const

inline

Returns an iterator pointing to the first plane ID in the specified TPC.

Definition at line 3078 of file GeometryCore.h.

3079 { return plane_id_iterator(this, GetBeginPlaneID(ID)); }

geo::PlaneID GetBeginPlaneID(geo::CryostatID const &id) const

Returns the ID of the first plane of the specified cryostat.

Definition: GeometryCore.h:3043

geo::plane_id_iterator plane_id_iterator

Forward-iterator browsing all plane IDs in the detector.

Definition: GeometryCore.h:1635

ROP_id_iterator geo::GeometryCore::begin_ROP_id ( ) const

inline

Returns an iterator pointing to the first ROP ID in the detector.

Definition at line 5231 of file GeometryCore.h.

5232 { return ROP_id_iterator(this, ROP_id_iterator::begin_pos); }

static constexpr BeginPos_t begin_pos

Definition: GeometryCore.h:107

details::ROP_id_iterator_base< readout::ROPID > ROP_id_iterator

Forward iterator browsing all readout planes in the detector.

Definition: GeometryCore.h:1381

ROP_id_iterator geo::GeometryCore::begin_ROP_id ( geo::CryostatID const & ID ) const

inline

Returns an iterator pointing to the first readout plane ID in the specified cryostat.

Definition at line 5240 of file GeometryCore.h.

5241 { return ROP_id_iterator(this, GetBeginROPID(ID)); }

geo::GeometryCore::GetBeginROPID

details::ROP_id_iterator_base< readout::ROPID > ROP_id_iterator

Forward iterator browsing all readout planes in the detector.

Definition: GeometryCore.h:1381

readout::ROPID GetBeginROPID(geo::CryostatID const &id) const

Returns the ID of the first readout plane of the specified cryostat.

Definition: GeometryCore.h:5213

ROP_id_iterator geo::GeometryCore::begin_ROP_id ( readout::TPCsetID const & ID ) const

inline

Returns an iterator pointing to the first readout plane ID in the specified TPC set.

Definition at line 5250 of file GeometryCore.h.

5251 { return ROP_id_iterator(this, GetBeginROPID(ID)); }

geo::GeometryCore::GetBeginROPID

details::ROP_id_iterator_base< readout::ROPID > ROP_id_iterator

Forward iterator browsing all readout planes in the detector.

Definition: GeometryCore.h:1381

readout::ROPID GetBeginROPID(geo::CryostatID const &id) const

Returns the ID of the first readout plane of the specified cryostat.

Definition: GeometryCore.h:5213

TPC_iterator geo::GeometryCore::begin_TPC ( ) const

inline

Returns an iterator pointing to the first TPC in the detector.

Definition at line 2570 of file GeometryCore.h.

2571 { return TPC_iterator(this, TPC_iterator::begin_pos); }

geo::TPC_iterator TPC_iterator

Forward-iterator browsing all TPCs in the detector.

Definition: GeometryCore.h:1611

static constexpr BeginPos_t begin_pos

Definition: GeometryCore.h:107

TPC_iterator geo::GeometryCore::begin_TPC ( geo::CryostatID const & cid ) const

inline

Returns an iterator pointing to the first TPC in the detector.

Definition at line 2578 of file GeometryCore.h.

2579 { return TPC_iterator(this, GetBeginTPCID(cid)); }

geo::GeometryCore::GetBeginTPCID

geo::TPC_iterator TPC_iterator

Forward-iterator browsing all TPCs in the detector.

Definition: GeometryCore.h:1611

geo::TPCID GetBeginTPCID(geo::CryostatID const &id) const

Returns the ID of the first TPC in the specified cryostat.

Definition: GeometryCore.h:2543

TPC_id_iterator geo::GeometryCore::begin_TPC_id ( ) const

inline

Returns an iterator pointing to the first TPC ID in the detector.

Definition at line 2552 of file GeometryCore.h.

2553 { return TPC_id_iterator(this, TPC_id_iterator::begin_pos); }

static constexpr BeginPos_t begin_pos

Definition: GeometryCore.h:107

geo::TPC_id_iterator TPC_id_iterator

Forward-iterator browsing all TPC IDs in the detector.

Definition: GeometryCore.h:1589

TPC_id_iterator geo::GeometryCore::begin_TPC_id ( geo::CryostatID const & cid ) const

inline

Returns an iterator pointing to the first TPC ID in the specified cryostat.

Definition at line 2561 of file GeometryCore.h.

2562 { return TPC_id_iterator(this, GetBeginTPCID(cid)); }

geo::GeometryCore::GetBeginTPCID

geo::TPC_id_iterator TPC_id_iterator

Forward-iterator browsing all TPC IDs in the detector.

Definition: GeometryCore.h:1589

geo::TPCID GetBeginTPCID(geo::CryostatID const &id) const

Returns the ID of the first TPC in the specified cryostat.

Definition: GeometryCore.h:2543

TPCset_id_iterator geo::GeometryCore::begin_TPCset_id ( ) const

inline

Returns an iterator pointing to the first TPC set ID in the detector.

Definition at line 4996 of file GeometryCore.h.

4997 { return TPCset_id_iterator(this, TPCset_id_iterator::begin_pos); }

static constexpr BeginPos_t begin_pos

Definition: GeometryCore.h:107

geo::GeometryCore::GetBeginTPCsetID

details::TPCset_id_iterator_base< readout::TPCsetID > TPCset_id_iterator

Forward iterator browsing all TPC sets in the detector.

Definition: GeometryCore.h:1360

TPCset_id_iterator geo::GeometryCore::begin_TPCset_id ( geo::CryostatID const & cid ) const

inline

Returns an iterator pointing to the first TPC set ID in the specified cryostat.

Definition at line 5005 of file GeometryCore.h.

5006 { return TPCset_id_iterator(this, GetBeginTPCsetID(cid)); }

readout::TPCsetID GetBeginTPCsetID(geo::CryostatID const &id) const

Returns the ID of the first TPC set in the specified cryostat.

Definition: GeometryCore.h:4986

details::TPCset_id_iterator_base< readout::TPCsetID > TPCset_id_iterator

Forward iterator browsing all TPC sets in the detector.

Definition: GeometryCore.h:1360

wire_iterator geo::GeometryCore::begin_wire ( ) const

inline

Returns an iterator pointing to the first wire in the detector.

Definition at line 3503 of file GeometryCore.h.

3504 { return wire_iterator(this, wire_iterator::begin_pos); }

static constexpr BeginPos_t begin_pos

Definition: GeometryCore.h:107

geo::GeometryCore::begin_wire_id

geo::wire_iterator wire_iterator

Forward-iterator browsing all wires in the detector.

Definition: GeometryCore.h:1703

wire_iterator geo::GeometryCore::begin_wire ( geo::CryostatID const & id ) const

inline

Returns an iterator pointing to the first wire in specified cryostat.

Definition at line 3511 of file GeometryCore.h.

3512 { return wire_iterator(begin_wire_id(id)); }

wire_id_iterator begin_wire_id() const

Returns an iterator pointing to the first wire ID in the detector.

Definition: GeometryCore.h:3470

geo::GeometryCore::begin_wire_id

geo::wire_iterator wire_iterator

Forward-iterator browsing all wires in the detector.

Definition: GeometryCore.h:1703

wire_iterator geo::GeometryCore::begin_wire ( geo::TPCID const & id ) const

inline

Returns an iterator pointing to the first wire in specified TPC.

Definition at line 3519 of file GeometryCore.h.

3520 { return wire_iterator(begin_wire_id(id)); }

wire_id_iterator begin_wire_id() const

Returns an iterator pointing to the first wire ID in the detector.

Definition: GeometryCore.h:3470

geo::GeometryCore::begin_wire_id

geo::wire_iterator wire_iterator

Forward-iterator browsing all wires in the detector.

Definition: GeometryCore.h:1703

wire_iterator geo::GeometryCore::begin_wire ( geo::PlaneID const & id ) const

inline

Returns an iterator pointing to the first wire in specified plane.

Definition at line 3527 of file GeometryCore.h.

3528 { return wire_iterator(begin_wire_id(id)); }

wire_id_iterator begin_wire_id() const

Returns an iterator pointing to the first wire ID in the detector.

Definition: GeometryCore.h:3470

geo::wire_iterator wire_iterator

Forward-iterator browsing all wires in the detector.

Definition: GeometryCore.h:1703

wire_id_iterator geo::GeometryCore::begin_wire_id ( ) const

inline

Returns an iterator pointing to the first wire ID in the detector.

Definition at line 3470 of file GeometryCore.h.

3471 { return wire_id_iterator(this, wire_id_iterator::begin_pos); }

static constexpr BeginPos_t begin_pos

Definition: GeometryCore.h:107

geo::GeometryCore::GetBeginWireID

geo::wire_id_iterator wire_id_iterator

Forward-iterator browsing all wire IDs in the detector.

Definition: GeometryCore.h:1681

wire_id_iterator geo::GeometryCore::begin_wire_id ( geo::CryostatID const & id ) const

inline

Returns an iterator pointing to the first wire ID in specified cryostat.

Definition at line 3478 of file GeometryCore.h.

3479 { return wire_id_iterator(this, GetBeginWireID(id)); }

geo::WireID GetBeginWireID(geo::CryostatID const &id) const

Returns the ID of the first wire in the specified cryostat.

Definition: GeometryCore.h:3446

geo::GeometryCore::GetBeginWireID

geo::wire_id_iterator wire_id_iterator

Forward-iterator browsing all wire IDs in the detector.

Definition: GeometryCore.h:1681

wire_id_iterator geo::GeometryCore::begin_wire_id ( geo::TPCID const & id ) const

inline

Returns an iterator pointing to the first wire ID in specified TPC.

Definition at line 3487 of file GeometryCore.h.

3488 { return wire_id_iterator(this, GetBeginWireID(id)); }

geo::WireID GetBeginWireID(geo::CryostatID const &id) const

Returns the ID of the first wire in the specified cryostat.

Definition: GeometryCore.h:3446

geo::GeometryCore::GetBeginWireID

geo::wire_id_iterator wire_id_iterator

Forward-iterator browsing all wire IDs in the detector.

Definition: GeometryCore.h:1681

wire_id_iterator geo::GeometryCore::begin_wire_id ( geo::PlaneID const & id ) const

inline

Returns an iterator pointing to the first wire ID in specified plane.

Definition at line 3495 of file GeometryCore.h.

3496 { return wire_id_iterator(this, GetBeginWireID(id)); }

geo::WireID GetBeginWireID(geo::CryostatID const &id) const

Returns the ID of the first wire in the specified cryostat.

Definition: GeometryCore.h:3446

geo::GeometryCore::fChannelMapAlg

geo::wire_id_iterator wire_id_iterator

Forward-iterator browsing all wire IDs in the detector.

Definition: GeometryCore.h:1681

void geo::GeometryCore::BuildGeometry ( geo::GeometryBuilder & builder )

private

Parses ROOT geometry nodes and builds LArSoft geometry representation.

Parameters

builder the algorithm to be used

Definition at line 1119 of file GeometryCore.cxx.

   {
     geo::GeoNodePath path{ gGeoManager->GetTopNode() };
     Cryostats() = builder.extractCryostats(path);
     AuxDets() = builder.extractAuxiliaryDetectors(path);
   }

geo::ChannelMapAlg const* geo::GeometryCore::ChannelMap ( ) const

inlineprotected

Returns the object handling the channel map.

Definition at line 5491 of file GeometryCore.h.

5492 { return fChannelMapAlg.get(); }

std::unique_ptr< const geo::ChannelMapAlg > fChannelMapAlg

Object containing the channel to wire mapping.

Definition: GeometryCore.h:5521

bool geo::GeometryCore::ChannelsIntersect	(	raw::ChannelID_t	c1,
		raw::ChannelID_t	c2,
		double &	y,
		double &	z
	)		const

Returns an intersection point of two channels.

Parameters

c1	one channel ID
c2	the other channel ID
y	(output) y coordinate of the intersection
z	(output) z coordinate of the intersection

Returns: whether a intersection point was found

Todo:

what happens for channels from different TPCs?

what happens for channels with multiple intersection points?

Deprecated:: This is clearly not APA-aware

Definition at line 1360 of file GeometryCore.cxx.

   {
 
     // [GP] these errors should be exceptions, and this function is deprecated
     // because it violates interoperability
     std::vector<geo::WireID> chan1wires = ChannelToWire(c1);
     if (chan1wires.empty()) {
       mf::LogError("ChannelsIntersect")
         << "1st channel " << c1 << " maps to no wire (is it a real one?)";
       return false;
     }
     std::vector<geo::WireID> chan2wires = ChannelToWire(c2);
     if (chan2wires.empty()) {
       mf::LogError("ChannelsIntersect")
         << "2nd channel " << c2 << " maps to no wire (is it a real one?)";
       return false;
     }
 
     if (chan1wires.size() > 1) {
       mf::LogWarning("ChannelsIntersect")
         << "1st channel " << c1 << " maps to " << chan2wires.size()
         << " wires; using the first!";
       return false;
     }
     if (chan2wires.size() > 1) {
       mf::LogError("ChannelsIntersect")
         << "2nd channel " << c2 << " maps to " << chan2wires.size()
         << " wires; using the first!";
       return false;
     }
 
     geo::WireIDIntersection widIntersect;
     if (this->WireIDsIntersect(chan1wires[0],chan2wires[0],widIntersect)){
       y = widIntersect.y;
       z = widIntersect.z;
       return true;
     }
     else{
       y = widIntersect.y;
       z = widIntersect.z;
       return false;
     }
   }

std::vector< raw::ChannelID_t > geo::GeometryCore::ChannelsInTPCs ( ) const

Returns an std::vector<ChannelID_t> in all TPCs in a TPCSet.

Definition at line 221 of file GeometryCore.cxx.

   {
     std::vector<raw::ChannelID_t> channels;
     channels.reserve(fChannelMapAlg->Nchannels());
 
     for (const readout::TPCsetID & ts: IterateTPCsetIDs())
     {
       for (auto const t: fChannelMapAlg->TPCsetToTPCs(ts))
       {
         for (auto const & wire: IterateWireIDs(t))
         {
           channels.push_back(fChannelMapAlg->PlaneWireToChannel(wire));
         }
       }
     }
     std::sort(channels.begin(), channels.end());
     auto last = std::unique(channels.begin(), channels.end());
     channels.erase(last, channels.end());
     return channels;
   }

const AuxDetGeo & geo::GeometryCore::ChannelToAuxDet	(	std::string const &	auxDetName,
		uint32_t const &	channel
	)		const

Definition at line 576 of file GeometryCore.cxx.

   {
     size_t adIdx = fChannelMapAlg->ChannelToAuxDet(AuxDets(), auxDetName, channel);
     return this->AuxDet(adIdx);
   }

const AuxDetSensitiveGeo & geo::GeometryCore::ChannelToAuxDetSensitive	(	std::string const &	auxDetName,
		uint32_t const &	channel
	)		const

Definition at line 584 of file GeometryCore.cxx.

   {
     auto idx = fChannelMapAlg->ChannelToSensitiveAuxDet(AuxDets(), auxDetName, channel);
     return this->AuxDet(idx.first).SensitiveVolume(idx.second);
   }

readout::ROPID geo::GeometryCore::ChannelToROP ( raw::ChannelID_t channel ) const

Returns the ID of the ROP the channel belongs to

Exceptions

cet::exception (category: "Geometry") if non-existent channel

Definition at line 1202 of file GeometryCore.cxx.

   {
     return fChannelMapAlg->ChannelToROP(channel);
   } // GeometryCore::ChannelToROP()

std::vector< geo::WireID > geo::GeometryCore::ChannelToWire ( raw::ChannelID_t const channel ) const

Returns a list of wires connected to the specified TPC channel.

Parameters

channel TPC channel ID

Returns: vector containing the ID of all the connected wires

Exceptions

cet::exception (category: "Geometry") if non-existent channel

Definition at line 1196 of file GeometryCore.cxx.

   {
     return fChannelMapAlg->ChannelToWire(channel);
   }

void geo::GeometryCore::CheckIndependentPlanesOnSameTPC	(	geo::PlaneID const &	pid1,
		geo::PlaneID const &	pid2,
		const char *	caller
	)

staticprivate

Throws an exception ("GeometryCore" category) unless pid1 and pid2 are on different planes of the same TPC (ID validity is not checked)

Definition at line 1603 of file GeometryCore.cxx.

   {
     if(pid1.asTPCID() != pid2.asTPCID()) {
       throw cet::exception("GeometryCore")
         << caller << " needs two planes on the same TPC (got "
         << std::string(pid1) << " and " << std::string(pid2) << ")\n";
     }
     if(pid1 == pid2) { // was: return 999;
       throw cet::exception("GeometryCore")
         << caller << " needs two different planes, got "
         << std::string(pid1) << " twice\n";
     }
   } // GeometryCore::CheckIndependentPlanesOnSameTPC()

void geo::GeometryCore::ClearGeometry ( )

private

Deletes the detector geometry structures.

Definition at line 160 of file GeometryCore.cxx.

   {
     Cryostats().clear();
     AuxDets().clear();
   }

double geo::GeometryCore::ComputeThirdPlane_dTdW	(	double	angle1,
		double	pitch1,
		double	dTdW1,
		double	angle2,
		double	pitch2,
		double	dTdW2,
		double	angle_target,
		double	pitch_target
	)

static

Returns the slope on the third plane, given it in the other two.

Parameters

angle1	angle or the wires on the first plane
pitch1	wire pitch on the first plane
dTdW1	slope in dt/dw units as observed on the first plane
angle2	angle or the wires on the second plane
pitch2	wire pitch on the second plane
dTdW2	slope in dt/dw units as observed on the second plane
angle_target	angle or the wires on the target plane
pitch_target	wire pitch on the target plane

Returns: dt/dw slope as measured on the third plane, or 999 if infinity

The input slope must be specified in dt/dw non-homogeneous coordinates.

This function will return a small slope if both input slopes are small.

Definition at line 1721 of file GeometryCore.cxx.

   {
     // we need to convert dt/dw into homogeneous coordinates, and then back;
     // slope = [dT * (TDCperiod / driftVelocity)] / [dW * wirePitch]
     // The coefficient of dT is assumed to be the same for all the planes,
     // and it finally cancels out. Pitches cancel out only if they are all
     // the same.
     return pitch_target * ComputeThirdPlaneSlope
       (angle1, dTdW1 / pitch1, angle2, dTdW2 / pitch2, angle_target);
   } // GeometryCore::ComputeThirdPlane_dTdW()

double geo::GeometryCore::ComputeThirdPlaneSlope	(	double	angle1,
		double	slope1,
		double	angle2,
		double	slope2,
		double	angle_target
	)

static

Returns the slope on the third plane, given it in the other two.

Parameters

angle1	angle or the wires on the first plane
slope1	slope as observed on the first plane
angle2	angle or the wires on the second plane
slope2	slope as observed on the second plane
angle_target	angle or the wires on the target plane

Returns: the slope as measure on the third plane, or 999 if infinity

This function will return a small slope if both input slopes are small.

Definition at line 1696 of file GeometryCore.cxx.

   {
     // note that, if needed, the trigonometric functions can be pre-calculated.
 
     // Can't resolve very small slopes
     if ((std::abs(slope1) < 0.001) && (std::abs(slope2)) < 0.001) return 0.001;
 
     // We need the "wire coordinate direction" for each plane.
     // This is perpendicular to the wire orientation.
     double slope3 = 0.001;
     if (std::abs(slope1) > 0.001 && std::abs(slope2) > 0.001) {
       slope3
         = (
           + (1./slope1)*std::sin(angle3-angle2)
           - (1./slope2)*std::sin(angle3-angle1)
         ) / std::sin(angle1-angle2)
         ;
     }
     if (slope3 != 0.) slope3 = 1./slope3;
     else slope3 = 999.;
 
     return slope3;
   } // GeometryCore::ComputeThirdPlaneSlope()

CryostatGeo const & geo::GeometryCore::Cryostat ( geo::CryostatID const & cryoid ) const

Returns the specified cryostat.

Parameters

cstat	number of cryostat
cryoid	cryostat ID

Returns: a constant reference to the specified cryostat

Exceptions

cet::exception (GeometryCore category) if cryostat not present

The GetElement() method is overloaded and its return depends on the type of ID.

Todo:: Make the cryostat number mandatory (as CryostatID)

Definition at line 321 of file GeometryCore.cxx.

                                                                           {
     CryostatGeo const* pCryo = CryostatPtr(cryoid);
     if(!pCryo) {
       throw cet::exception("GeometryCore") << "Cryostat #"
                                            << cryoid.Cryostat
                                            << " does not exist\n";
     }
     return *pCryo;
   } // GeometryCore::Cryostat(CryostatID)

CryostatGeo const& geo::GeometryCore::Cryostat ( unsigned int const cstat = 0 ) const

inline

Definition at line 2039 of file GeometryCore.h.

2040 { return Cryostat(geo::CryostatID(cstat)); }

geo::GeometryCore::Cryostat

CryostatGeo const & Cryostat(geo::CryostatID const &cryoid) const

Returns the specified cryostat.

Definition: GeometryCore.cxx:321

geo::GeometryCore::CryostatBoundaries

The data type to uniquely identify a cryostat.

Definition: geo_types.h:190

void geo::GeometryCore::CryostatBoundaries	(	double *	boundaries,
		geo::CryostatID const &	cid
	)		const

Returns the boundaries of the specified cryostat.

Parameters

boundaries	(output) pointer to an area of 6 doubles for boundaries
cid	cryostat ID

Exceptions

cet::exception ("GeometryCore" category) if cryostat not present

See Also: CryostatGeo::Boundaries()

The boundaries array is filled with: [0] lower x coordinate [1] upper x coordinate [2] lower y coordinate [3] upper y coordinate [4] lower z coordinate [5] upper z coordinate

Deprecated:: Use CryostatGeo::Boundaries() (from Cryostat(cid)).

Todo:: What happen on invalid cryostat?

Definition at line 812 of file GeometryCore.cxx.

   {
     geo::CryostatGeo const& cryo = Cryostat(cid);
     cryo.Boundaries(boundaries);
   } // GeometryCore::CryostatBoundaries()

void geo::GeometryCore::CryostatBoundaries	(	double *	boundaries,
		unsigned int	cstat = `0`
	)		const

inline

Returns the boundaries of the specified cryostat.

Parameters

boundaries	(output) pointer to an area of 6 doubles for boundaries
cstat	number of cryostat

Exceptions

cet::exception ("GeometryCore" category) if cryostat not present

See Also: CryostatGeo::Boundaries()

The boundaries array is filled with: [0] lower x coordinate [1] upper x coordinate [2] lower y coordinate [3] upper y coordinate [4] lower z coordinate [5] upper z coordinate

Deprecated:: Use CryostatBoundaries(double*, geo::CryostatID const&) or (recommended) CryostatGeo::Boundaries() from Cryostat(cid) instead

Definition at line 2268 of file GeometryCore.h.

2269 { CryostatBoundaries(boundaries, geo::CryostatID(cstat)); }

void CryostatBoundaries(double *boundaries, geo::CryostatID const &cid) const

Returns the boundaries of the specified cryostat.

Definition: GeometryCore.cxx:812

geo::GeometryCore::CryostatHalfHeight

The data type to uniquely identify a cryostat.

Definition: geo_types.h:190

geo::Length_t geo::GeometryCore::CryostatHalfHeight ( geo::CryostatID const & cid ) const

Returns the height of the cryostat (y direction)

Definition at line 799 of file GeometryCore.cxx.

   {
     return Cryostat(cid).HalfHeight();
   }

geo::Length_t geo::GeometryCore::CryostatHalfHeight ( unsigned int cstat = 0 ) const

inline

Definition at line 2222 of file GeometryCore.h.

2223 { return CryostatHalfHeight(geo::CryostatID(cstat)); }

geo::Length_t CryostatHalfHeight(geo::CryostatID const &cid) const

Returns the height of the cryostat (y direction)

Definition: GeometryCore.cxx:799

geo::GeometryCore::CryostatHalfWidth

The data type to uniquely identify a cryostat.

Definition: geo_types.h:190

geo::Length_t geo::GeometryCore::CryostatHalfWidth ( geo::CryostatID const & cid ) const

Returns the half width of the cryostat (x direction)

Definition at line 792 of file GeometryCore.cxx.

   {
     return Cryostat(cid).HalfWidth();
   }

geo::Length_t geo::GeometryCore::CryostatHalfWidth ( unsigned int cstat = 0 ) const

inline

Definition at line 2215 of file GeometryCore.h.

2216 { return CryostatHalfWidth(geo::CryostatID(cstat)); }

geo::Length_t CryostatHalfWidth(geo::CryostatID const &cid) const

Returns the half width of the cryostat (x direction)

Definition: GeometryCore.cxx:792

geo::GeometryCore::CryostatLength

The data type to uniquely identify a cryostat.

Definition: geo_types.h:190

geo::Length_t geo::GeometryCore::CryostatLength ( geo::CryostatID const & cid ) const

Returns the length of the cryostat (z direction)

Definition at line 805 of file GeometryCore.cxx.

   {
     return Cryostat(cid).Length();
   }

geo::Length_t geo::GeometryCore::CryostatLength ( unsigned int cstat = 0 ) const

inline

Definition at line 2229 of file GeometryCore.h.

2230 { return CryostatLength(geo::CryostatID(cstat)); }

geo::Length_t CryostatLength(geo::CryostatID const &cid) const

Returns the length of the cryostat (z direction)

Definition: GeometryCore.cxx:805

geo::GeometryCore::Cryostats

The data type to uniquely identify a cryostat.

Definition: geo_types.h:190

CryostatGeo const* geo::GeometryCore::CryostatPtr ( geo::CryostatID const & cryoid ) const

inline

Returns the specified cryostat.

Parameters

cryoid cryostat ID

Returns: a constant pointer to the specified cryostat, or nullptr if none

The GetElementPtr() method is overloaded and its return depends on the type of ID.

Definition at line 2054 of file GeometryCore.h.

2055 { return HasCryostat(cryoid)? &(Cryostats()[cryoid.Cryostat]): nullptr; }

CryostatList_t & Cryostats()

Return the internal cryostat list.

Definition: GeometryCore.h:5496

geo::GeometryCore::HasCryostat

bool HasCryostat(geo::CryostatID const &cryoid) const

Returns whether we have the specified cryostat.

Definition: GeometryCore.h:2019

CryostatList_t& geo::GeometryCore::Cryostats ( )

inlineprotected

Return the internal cryostat list.

Definition at line 5496 of file GeometryCore.h.

5496 { return fGeoData.cryostats; }

geo::GeometryData_t::cryostats

GeometryData_t fGeoData

The detector description data.

Definition: GeometryCore.h:5508

CryostatList_t cryostats

The detector cryostats.

Definition: GeometryData.h:38

CryostatList_t const& geo::GeometryCore::Cryostats ( ) const

inlineprotected

Definition at line 5497 of file GeometryCore.h.

5497 { return fGeoData.cryostats; }

geo::GeometryData_t::cryostats

GeometryData_t fGeoData

The detector description data.

Definition: GeometryCore.h:5508

CryostatList_t cryostats

The detector cryostats.

Definition: GeometryData.h:38

double geo::GeometryCore::DefaultWiggle ( ) const

inline

Returns the tolerance used in looking for positions.

Returns: the tolerance value

This parameter is used as tolerance ("wiggle") for methods that require it (e.g. geo::CryostatGeo::FindTPCAtPosition()). Typically, it's a additional fraction of tolerance: 0 means no tolerance, 0.1 means 10% tolerance.

Todo:: Confirm the definition of wiggle: this one is taken from other doc

Definition at line 1739 of file GeometryCore.h.

1739 { return fPositionWiggle; }

geo::GeometryCore::fPositionWiggle

double fPositionWiggle

accounting for rounding errors when testing positions

Definition: GeometryCore.h:5516

geo::BoxBoundedGeo geo::GeometryCore::DetectorEnclosureBox ( std::string const & name = "volDetEnclosure" ) const

Returns the absolute coordinates of the detector enclosure volume [cm].

Parameters

name	name of the volume to be sought (default: `volDetEnclosure`)

Exceptions

cet::exception if the specified volume is not found

Definition at line 650 of file GeometryCore.cxx.

   {
     auto const& path = FindDetectorEnclosure(name);
     if (path.empty()) {
       throw cet::exception("GeometryCore")
         << "DetectorEnclosureBox(): can't find enclosure volume '" << name << "'\n";
     }
 
     TGeoVolume const* pEncl = path.back()->GetVolume();
     auto const* pBox = dynamic_cast<TGeoBBox const*>(pEncl->GetShape());
 
     // check that this is indeed a box
     if (!pBox) {
       // at initialisation time we don't know yet our real ID
       throw cet::exception("GeometryCore") << "Detector enclosure '"
         << name << "' is not a box! (it is a " << pEncl->GetShape()->IsA()->GetName()
         << ")\n";
     }
 
     geo::LocalTransformation<TGeoHMatrix> trans(path, path.size() - 1);
     // get the half width, height, etc of the cryostat
     const double halfwidth  = pBox->GetDX();
     const double halfheight = pBox->GetDY();
     const double halflength = pBox->GetDZ();
 
     return {
       trans.LocalToWorld(geo::Point_t{ -halfwidth, -halfheight, -halflength }),
       trans.LocalToWorld(geo::Point_t{ +halfwidth, +halfheight, +halflength })
       };
   } // geo::GeometryCore::DetectorEnclosureBox()

std::string geo::GeometryCore::DetectorName ( ) const

inline

Returns a string with the name of the detector, as configured.

Definition at line 1769 of file GeometryCore.h.

1769 { return fDetectorName; }

geo::GeometryCore::fDetectorName

std::string fDetectorName

Name of the detector.

Definition: GeometryCore.h:5511

geo::Length_t geo::GeometryCore::DetHalfHeight ( geo::TPCID const & tpcid ) const

Returns the half height of the active volume of the specified TPC.

Parameters

tpcid	ID of the TPC
tpc	TPC number within the cryostat
cstat	number of cryostat

Returns: the value of the half height of the specified TPC

Exceptions

cet::exception	(`GeometryCore` category) if cryostat not present
cet::exception	(`TPCOutOfRange` category) if no such TPC

See Also: geo::TPCGeo::ActiveHalfHeight()

See geo::TPCGeo::ActiveHalfHeight() for more details.

Todo:

deprecate this function

rename the function

Definition at line 779 of file GeometryCore.cxx.

   {
     return TPC(tpcid).ActiveHalfHeight();
   }

geo::Length_t geo::GeometryCore::DetHalfHeight	(	unsigned int	tpc = `0`,
		unsigned int	cstat = `0`
	)		const

inline

Definition at line 2744 of file GeometryCore.h.

2745 { return DetHalfHeight(geo::TPCID(cstat, tpc)); }

geo::GeometryCore::DetHalfHeight

geo::Length_t DetHalfHeight(geo::TPCID const &tpcid) const

Returns the half height of the active volume of the specified TPC.

Definition: GeometryCore.cxx:779

geo::GeometryCore::DetHalfWidth

The data type to uniquely identify a TPC.

Definition: geo_types.h:386

geo::Length_t geo::GeometryCore::DetHalfWidth ( geo::TPCID const & tpcid ) const

Returns the half width of the active volume of the specified TPC.

Parameters

tpcid	ID of the TPC
tpc	TPC number within the cryostat
cstat	number of cryostat

Returns: the value of the half width of the specified TPC

Exceptions

cet::exception	(`GeometryCore` category) if cryostat not present
cet::exception	(`TPCOutOfRange` category) if no such TPC

See Also: geo::TPCGeo::ActiveHalfWidth()

Todo:

deprecate this function

rename the function

Definition at line 773 of file GeometryCore.cxx.

   {
     return TPC(tpcid).ActiveHalfWidth();
   }

geo::Length_t geo::GeometryCore::DetHalfWidth	(	unsigned int	tpc = `0`,
		unsigned int	cstat = `0`
	)		const

inline

Definition at line 2722 of file GeometryCore.h.

2723 { return DetHalfWidth(geo::TPCID(cstat, tpc)); }

geo::Length_t DetHalfWidth(geo::TPCID const &tpcid) const

Returns the half width of the active volume of the specified TPC.

Definition: GeometryCore.cxx:773

geo::GeometryCore::DetLength

The data type to uniquely identify a TPC.

Definition: geo_types.h:386

geo::Length_t geo::GeometryCore::DetLength ( geo::TPCID const & tpcid ) const

Returns the length of the active volume of the specified TPC.

Parameters

tpcid	ID of the TPC
tpc	TPC number within the cryostat
cstat	number of cryostat

Returns: the value of the length of the specified TPC

Exceptions

cet::exception	(`GeometryCore` category) if cryostat not present
cet::exception	(`TPCOutOfRange` category) if no such TPC

See Also: geo::TPCGeo::ActiveLength()

See geo::TPCGeo::ActiveLength() for more details.

Todo:

deprecate this function

rename the function

Definition at line 785 of file GeometryCore.cxx.

   {
     return TPC(tpcid).ActiveLength();
   }

geo::Length_t geo::GeometryCore::DetLength	(	unsigned int	tpc = `0`,
		unsigned int	cstat = `0`
	)		const

inline

Definition at line 2765 of file GeometryCore.h.

2766 { return DetLength(geo::TPCID(cstat, tpc)); }

geo::Length_t DetLength(geo::TPCID const &tpcid) const

Returns the length of the active volume of the specified TPC.

Definition: GeometryCore.cxx:785

geo::GeometryCore::cryostat_iterator

The data type to uniquely identify a TPC.

Definition: geo_types.h:386

cryostat_iterator geo::GeometryCore::end_cryostat ( ) const

inline

Returns an iterator pointing after the last cryostat.

Definition at line 2166 of file GeometryCore.h.

2167 { return cryostat_iterator(this, cryostat_iterator::end_pos); }

geo::cryostat_iterator cryostat_iterator

Forward-iterator browsing all cryostats in the detector.

Definition: GeometryCore.h:1565

static constexpr EndPos_t end_pos

Definition: GeometryCore.h:108

cryostat_id_iterator geo::GeometryCore::end_cryostat_id ( ) const

inline

Returns an iterator pointing after the last cryostat ID.

Definition at line 2158 of file GeometryCore.h.

2159 { return cryostat_id_iterator(this, cryostat_id_iterator::end_pos); }

geo::GeometryCore::cryostat_id_iterator

static constexpr EndPos_t end_pos

Definition: GeometryCore.h:108

geo::cryostat_id_iterator cryostat_id_iterator

Forward-iterator browsing all cryostat IDs in the detector.

Definition: GeometryCore.h:1544

plane_iterator geo::GeometryCore::end_plane ( ) const

inline

Returns an iterator pointing after the last plane in the detector.

Definition at line 3091 of file GeometryCore.h.

3092 { return plane_iterator(this, plane_iterator::end_pos); }

static constexpr EndPos_t end_pos

Definition: GeometryCore.h:108

geo::plane_iterator plane_iterator

Forward-iterator browsing all planes in the detector.

Definition: GeometryCore.h:1657

plane_iterator geo::GeometryCore::end_plane ( geo::CryostatID const & ID ) const

inline

Returns an iterator pointing after the last plane in the specified cryostat.

Definition at line 3101 of file GeometryCore.h.

3102 { return plane_iterator(this, GetEndPlaneID(ID)); }

geo::plane_iterator plane_iterator

Forward-iterator browsing all planes in the detector.

Definition: GeometryCore.h:1657

geo::PlaneID GetEndPlaneID(geo::CryostatID const &id) const

Definition: GeometryCore.cxx:831

plane_iterator geo::GeometryCore::end_plane ( geo::TPCID const & ID ) const

inline

Returns an iterator pointing after the last plane in the specified TPC.

Definition at line 3109 of file GeometryCore.h.

3110 { return plane_iterator(this, GetEndPlaneID(ID)); }

geo::plane_iterator plane_iterator

Forward-iterator browsing all planes in the detector.

Definition: GeometryCore.h:1657

geo::PlaneID GetEndPlaneID(geo::CryostatID const &id) const

Definition: GeometryCore.cxx:831

plane_id_iterator geo::GeometryCore::end_plane_id ( ) const

inline

Returns an iterator pointing after the last plane ID in the detector.

Definition at line 3063 of file GeometryCore.h.

3064 { return plane_id_iterator(this, plane_id_iterator::end_pos); }

static constexpr EndPos_t end_pos

Definition: GeometryCore.h:108

geo::plane_id_iterator plane_id_iterator

Forward-iterator browsing all plane IDs in the detector.

Definition: GeometryCore.h:1635

plane_id_iterator geo::GeometryCore::end_plane_id ( geo::CryostatID const & ID ) const

inline

Returns an iterator pointing after the last plane ID in the specified cryostat.

Definition at line 3073 of file GeometryCore.h.

3074 { return plane_id_iterator(this, GetEndPlaneID(ID)); }

geo::plane_id_iterator plane_id_iterator

Forward-iterator browsing all plane IDs in the detector.

Definition: GeometryCore.h:1635

geo::PlaneID GetEndPlaneID(geo::CryostatID const &id) const

Definition: GeometryCore.cxx:831

plane_id_iterator geo::GeometryCore::end_plane_id ( geo::TPCID const & ID ) const

inline

Returns an iterator pointing after the last plane ID in the specified TPC.

Definition at line 3083 of file GeometryCore.h.

3084 { return plane_id_iterator(this, GetEndPlaneID(ID)); }

geo::plane_id_iterator plane_id_iterator

Forward-iterator browsing all plane IDs in the detector.

Definition: GeometryCore.h:1635

geo::PlaneID GetEndPlaneID(geo::CryostatID const &id) const

Definition: GeometryCore.cxx:831

ROP_id_iterator geo::GeometryCore::end_ROP_id ( ) const

inline

Returns an iterator pointing after the last ROP ID in the detector.

Definition at line 5235 of file GeometryCore.h.

5236 { return ROP_id_iterator(this, ROP_id_iterator::end_pos); }

details::ROP_id_iterator_base< readout::ROPID > ROP_id_iterator

Forward iterator browsing all readout planes in the detector.

Definition: GeometryCore.h:1381

geo::GeometryCore::GetEndROPID

static constexpr EndPos_t end_pos

Definition: GeometryCore.h:108

ROP_id_iterator geo::GeometryCore::end_ROP_id ( geo::CryostatID const & ID ) const

inline

Returns an iterator pointing after the last readout plane ID in the specified cryostat.

Definition at line 5245 of file GeometryCore.h.

5246 { return ROP_id_iterator(this, GetEndROPID(ID)); }

readout::ROPID GetEndROPID(geo::CryostatID const &id) const

Definition: GeometryCore.h:5218

geo::GeometryCore::GetEndROPID

details::ROP_id_iterator_base< readout::ROPID > ROP_id_iterator

Forward iterator browsing all readout planes in the detector.

Definition: GeometryCore.h:1381

ROP_id_iterator geo::GeometryCore::end_ROP_id ( readout::TPCsetID const & ID ) const

inline

Returns an iterator pointing after the last readout plane ID in the specified TPC set.

Definition at line 5255 of file GeometryCore.h.

5256 { return ROP_id_iterator(this, GetEndROPID(ID)); }

readout::ROPID GetEndROPID(geo::CryostatID const &id) const

Definition: GeometryCore.h:5218

details::ROP_id_iterator_base< readout::ROPID > ROP_id_iterator

Forward iterator browsing all readout planes in the detector.

Definition: GeometryCore.h:1381

TPC_iterator geo::GeometryCore::end_TPC ( ) const

inline

Returns an iterator pointing after the last TPC in the detector.

Definition at line 2574 of file GeometryCore.h.

2575 { return TPC_iterator(this, TPC_iterator::end_pos); }

geo::TPC_iterator TPC_iterator

Forward-iterator browsing all TPCs in the detector.

Definition: GeometryCore.h:1611

geo::GeometryCore::GetEndTPCID

static constexpr EndPos_t end_pos

Definition: GeometryCore.h:108

TPC_iterator geo::GeometryCore::end_TPC ( geo::CryostatID const & cid ) const

inline

Returns an iterator pointing after the last TPC in the detector.

Definition at line 2582 of file GeometryCore.h.

2583 { return TPC_iterator(this, GetEndTPCID(cid)); }

geo::TPCID GetEndTPCID(geo::CryostatID const &id) const

Definition: GeometryCore.cxx:471

geo::TPC_iterator TPC_iterator

Forward-iterator browsing all TPCs in the detector.

Definition: GeometryCore.h:1611

TPC_id_iterator geo::GeometryCore::end_TPC_id ( ) const

inline

Returns an iterator pointing after the last TPC ID in the detector.

Definition at line 2556 of file GeometryCore.h.

2557 { return TPC_id_iterator(this, TPC_id_iterator::end_pos); }

static constexpr EndPos_t end_pos

Definition: GeometryCore.h:108

geo::GeometryCore::GetEndTPCID

geo::TPC_id_iterator TPC_id_iterator

Forward-iterator browsing all TPC IDs in the detector.

Definition: GeometryCore.h:1589

TPC_id_iterator geo::GeometryCore::end_TPC_id ( geo::CryostatID const & cid ) const

inline

Returns an iterator pointing after the last TPC ID in the specified cryostat.

Definition at line 2566 of file GeometryCore.h.

2567 { return TPC_id_iterator(this, GetEndTPCID(cid)); }

geo::TPCID GetEndTPCID(geo::CryostatID const &id) const

Definition: GeometryCore.cxx:471

geo::TPC_id_iterator TPC_id_iterator

Forward-iterator browsing all TPC IDs in the detector.

Definition: GeometryCore.h:1589

TPCset_id_iterator geo::GeometryCore::end_TPCset_id ( ) const

inline

Returns an iterator pointing after the last TPC set ID in the detector.

Definition at line 5000 of file GeometryCore.h.

5001 { return TPCset_id_iterator(this, TPCset_id_iterator::end_pos); }

static constexpr EndPos_t end_pos

Definition: GeometryCore.h:108

geo::GeometryCore::GetEndTPCsetID

details::TPCset_id_iterator_base< readout::TPCsetID > TPCset_id_iterator

Forward iterator browsing all TPC sets in the detector.

Definition: GeometryCore.h:1360

TPCset_id_iterator geo::GeometryCore::end_TPCset_id ( geo::CryostatID const & cid ) const

inline

Returns an iterator pointing after the last TPC set ID in the specified cryostat.

Definition at line 5010 of file GeometryCore.h.

5011 { return TPCset_id_iterator(this, GetEndTPCsetID(cid)); }

readout::TPCsetID GetEndTPCsetID(geo::CryostatID const &id) const

Definition: GeometryCore.h:4991

details::TPCset_id_iterator_base< readout::TPCsetID > TPCset_id_iterator

Forward iterator browsing all TPC sets in the detector.

Definition: GeometryCore.h:1360

wire_iterator geo::GeometryCore::end_wire ( ) const

inline

Returns an iterator pointing after the last wire in the detector.

Definition at line 3507 of file GeometryCore.h.

3508 { return wire_iterator(this, wire_iterator::end_pos); }

static constexpr EndPos_t end_pos

Definition: GeometryCore.h:108

geo::GeometryCore::end_wire_id

geo::wire_iterator wire_iterator

Forward-iterator browsing all wires in the detector.

Definition: GeometryCore.h:1703

wire_iterator geo::GeometryCore::end_wire ( geo::CryostatID const & id ) const

inline

Returns an iterator pointing after the last wire in specified cryostat.

Definition at line 3515 of file GeometryCore.h.

3516 { return wire_iterator(end_wire_id(id)); }

wire_id_iterator end_wire_id() const

Returns an iterator pointing after the last wire ID in the detector.

Definition: GeometryCore.h:3474

geo::GeometryCore::end_wire_id

geo::wire_iterator wire_iterator

Forward-iterator browsing all wires in the detector.

Definition: GeometryCore.h:1703

wire_iterator geo::GeometryCore::end_wire ( geo::TPCID const & id ) const

inline

Returns an iterator pointing after the last wire in specified TPC.

Definition at line 3523 of file GeometryCore.h.

3524 { return wire_iterator(end_wire_id(id)); }

wire_id_iterator end_wire_id() const

Returns an iterator pointing after the last wire ID in the detector.

Definition: GeometryCore.h:3474

geo::GeometryCore::end_wire_id

geo::wire_iterator wire_iterator

Forward-iterator browsing all wires in the detector.

Definition: GeometryCore.h:1703

wire_iterator geo::GeometryCore::end_wire ( geo::PlaneID const & id ) const

inline

Returns an iterator pointing after the last wire in specified plane.

Definition at line 3531 of file GeometryCore.h.

3532 { return wire_iterator(end_wire_id(id)); }

wire_id_iterator end_wire_id() const

Returns an iterator pointing after the last wire ID in the detector.

Definition: GeometryCore.h:3474

geo::wire_iterator wire_iterator

Forward-iterator browsing all wires in the detector.

Definition: GeometryCore.h:1703

wire_id_iterator geo::GeometryCore::end_wire_id ( ) const

inline

Returns an iterator pointing after the last wire ID in the detector.

Definition at line 3474 of file GeometryCore.h.

3475 { return wire_id_iterator(this, wire_id_iterator::end_pos); }

static constexpr EndPos_t end_pos

Definition: GeometryCore.h:108

geo::GeometryCore::GetEndWireID

geo::wire_id_iterator wire_id_iterator

Forward-iterator browsing all wire IDs in the detector.

Definition: GeometryCore.h:1681

wire_id_iterator geo::GeometryCore::end_wire_id ( geo::CryostatID const & id ) const

inline

Returns an iterator pointing after the last wire ID in specified cryostat.

Definition at line 3483 of file GeometryCore.h.

3484 { return wire_id_iterator(this, GetEndWireID(id)); }

geo::WireID GetEndWireID(geo::CryostatID const &id) const

Definition: GeometryCore.cxx:959

geo::GeometryCore::GetEndWireID

geo::wire_id_iterator wire_id_iterator

Forward-iterator browsing all wire IDs in the detector.

Definition: GeometryCore.h:1681

wire_id_iterator geo::GeometryCore::end_wire_id ( geo::TPCID const & id ) const

inline

Returns an iterator pointing after the last wire ID in specified TPC.

Definition at line 3491 of file GeometryCore.h.

3492 { return wire_id_iterator(this, GetEndWireID(id)); }

geo::WireID GetEndWireID(geo::CryostatID const &id) const

Definition: GeometryCore.cxx:959

geo::GeometryCore::GetEndWireID

geo::wire_id_iterator wire_id_iterator

Forward-iterator browsing all wire IDs in the detector.

Definition: GeometryCore.h:1681

wire_id_iterator geo::GeometryCore::end_wire_id ( geo::PlaneID const & id ) const

inline

Returns an iterator pointing after the last wire ID in specified plane.

Definition at line 3499 of file GeometryCore.h.

3500 { return wire_id_iterator(this, GetEndWireID(id)); }

geo::WireID GetEndWireID(geo::CryostatID const &id) const

Definition: GeometryCore.cxx:959

geo::GeometryCore::FindAuxDetAtPosition

geo::wire_id_iterator wire_id_iterator

Forward-iterator browsing all wire IDs in the detector.

Definition: GeometryCore.h:1681

std::vector< std::vector< TGeoNode const * > > geo::GeometryCore::FindAllVolumePaths ( std::set< std::string > const & vol_names ) const

Returns paths of all nodes with volumes with the specified names.

Parameters

vol_names list of names of volumes

Returns: list paths of the found nodes

All the nodes in the geometry are checked, and the path of all the ones that contain a volume with a name among the ones specified in vol_names is saved in the collection and returned. A node path is a ordered list of all nodes leading to the final one, starting from thetop level (root) down. The node at the back() of the path is the one with name in vol_names. No empty paths are returned.

Definition at line 744 of file GeometryCore.cxx.

   {
     CollectPathsByName path_collector(vol_names);
 
     ROOTGeoNodeForwardIterator iNode(ROOTGeoManager()->GetTopNode());
 
     while (*iNode) {
       path_collector(iNode);
       ++iNode;
     } // while
 
     return path_collector.paths;
   } // GeometryCore::FindAllVolumePaths()

std::vector< TGeoNode const * > geo::GeometryCore::FindAllVolumes ( std::set< std::string > const & vol_names ) const

Returns all the nodes with volumes with any of the specified names.

Parameters

vol_names list of names of volumes

Returns: list of nodes found

All the nodes in the geometry are checked, and all the ones that contain a volume with a name among the ones specified in vol_names are saved in the collection and returned.

Definition at line 727 of file GeometryCore.cxx.

   {
     CollectNodesByName node_collector(vol_names);
 
     ROOTGeoNodeForwardIterator iNode(ROOTGeoManager()->GetTopNode());
     TGeoNode const* pCurrentNode;
 
     while ((pCurrentNode = *iNode)) {
       node_collector(*pCurrentNode);
       ++iNode;
     } // while
 
     return node_collector.nodes;
   } // GeometryCore::FindAllVolumes()

unsigned int geo::GeometryCore::FindAuxDetAtPosition	(	double const	worldLoc[3],
		double	tolerance = `0`
	)		const

Returns the index of the auxiliary detector at specified location.

Parameters

worldLoc	3D coordinates of the point (world reference frame)
tolerance	tolerance (cm) for matches. Default 0

Returns: the index of the detector, or std::numeric_limits<unsigned int>::max() if no detector is there

Bug:: Actually, an exception is thrown.

Deprecated:: Use the version with geo::Point_t.

Definition at line 526 of file GeometryCore.cxx.

527 { return FindAuxDetAtPosition(geo::vect::makePointFromCoords(worldPos), tolerance); }

unsigned int FindAuxDetAtPosition(double const worldLoc[3], double tolerance=0) const

Returns the index of the auxiliary detector at specified location.

Definition: GeometryCore.cxx:526

auto const tolerance

Definition: OpFlashAlg_test.cc:11

geo::GeometryCore::FindAuxDetSensitiveAtPosition

GENVECTOR_CONSTEXPR::geo::Point_t makePointFromCoords(Coords &&coords)

Creates a geo::Point_t from its coordinates (see makeFromCoords()).

Definition: geo_vectors_utils.h:1511

unsigned int geo::GeometryCore::FindAuxDetAtPosition	(	geo::Point_t const &	point,
		double	tolerance = `0`
	)		const

Returns the index of the auxiliary detector at specified location.

Parameters

point	location to be tested
tolerance	tolerance (cm) for matches. Default 0

Returns: the index of the detector, or std::numeric_limits<unsigned int>::max() if no detector is there

Bug:: Actually, an exception is thrown.

Definition at line 517 of file GeometryCore.cxx.

   {
     // BUG the double brace syntax is required to work around clang bug 21629
     // (https://bugs.llvm.org/show_bug.cgi?id=21629)
     std::array<double, 3U> worldPos = {{ point.X(), point.Y(), point.Z() }};
     return fChannelMapAlg->NearestAuxDet(worldPos.data(), AuxDets(), tolerance);
   } // GeometryCore::FindAuxDetAtPosition()

void geo::GeometryCore::FindAuxDetSensitiveAtPosition	(	geo::Point_t const &	point,
		std::size_t &	adg,
		std::size_t &	sv,
		double	tolerance = `0`
	)		const

Fills the indices of the sensitive auxiliary detector at location.

Parameters

point	location to be tested
adg	_(output)_ auxiliary detector index
sv	_(output)_ sensitive volume index
tolerance	tolerance (cm) for matches. Default 0.

Definition at line 546 of file GeometryCore.cxx.

   {
     adg = FindAuxDetAtPosition(point, tolerance);
     // BUG the double brace syntax is required to work around clang bug 21629
     // (https://bugs.llvm.org/show_bug.cgi?id=21629)
     std::array<double, 3U> const worldPos = {{ point.X(), point.Y(), point.Z() }};
     sv  = fChannelMapAlg->NearestSensitiveAuxDet(worldPos.data(), AuxDets(), tolerance);
   } // GeometryCore::FindAuxDetAtPosition()

void geo::GeometryCore::FindAuxDetSensitiveAtPosition	(	double const	worldLoc[3],
		size_t &	adg,
		size_t &	sv,
		double	tolerance = `0`
	)		const

Fills the indices of the sensitive auxiliary detector at location.

Parameters

worldLoc	3D coordinates of the point (world reference frame)
adg	(output) auxiliary detector index
sv	(output) sensitive volume index
tolerance	tolerance (cm) for matches. Default 0.

Deprecated:: Use the version with geo::Point_t.

Definition at line 557 of file GeometryCore.cxx.

558 { return FindAuxDetSensitiveAtPosition(geo::vect::makePointFromCoords(worldPos), adg, sv, tolerance); }

void FindAuxDetSensitiveAtPosition(geo::Point_t const &point, std::size_t &adg, std::size_t &sv, double tolerance=0) const

Fills the indices of the sensitive auxiliary detector at location.

Definition: GeometryCore.cxx:546

auto const tolerance

Definition: OpFlashAlg_test.cc:11

geo::GeometryCore::FindTPCAtPosition

GENVECTOR_CONSTEXPR::geo::Point_t makePointFromCoords(Coords &&coords)

Creates a geo::Point_t from its coordinates (see makeFromCoords()).

Definition: geo_vectors_utils.h:1511

geo::CryostatID::CryostatID_t geo::GeometryCore::FindCryostatAtPosition ( geo::Point_t const & worldLoc ) const

Returns the index of the cryostat at specified location.

Parameters

worldLoc 3D coordinates of the point (world reference frame)

Returns: the index of the cryostat, or UINT_MAX if no cryostat is there

Deprecated:: Use PositionToCryostatID() instead

Definition at line 393 of file GeometryCore.cxx.

   {
     geo::CryostatGeo const* cryo = PositionToCryostatPtr(worldLoc);
     return cryo? cryo->ID().Cryostat: geo::CryostatID::InvalidID;
   } // GeometryCore::FindCryostatAtPosition(Point)

geo::CryostatID::CryostatID_t geo::GeometryCore::FindCryostatAtPosition ( double const worldLoc[3] ) const

Definition at line 402 of file GeometryCore.cxx.

   {
     return FindCryostatAtPosition(geo::vect::makePointFromCoords(worldLoc));
   } // GeometryCore::FindCryostatAtPosition(double[])

std::vector< TGeoNode const * > geo::GeometryCore::FindDetectorEnclosure ( std::string const & name = "volDetEnclosure" ) const

private

Definition at line 1087 of file GeometryCore.cxx.

   {
      std::vector<TGeoNode const*> path { ROOTGeoManager()->GetTopNode() };
      if (!FindFirstVolume(name, path)) path.clear();
      return path;
   } // FindDetectorEnclosure()

bool geo::GeometryCore::FindFirstVolume	(	std::string const &	name,
		std::vector< const TGeoNode * > &	path
	)		const

private

Definition at line 1096 of file GeometryCore.cxx.

   {
     assert(!path.empty());
 
     auto const* pCurrent = path.back();
 
     // first check the current layer
     if (strncmp(name.c_str(), pCurrent->GetName(), name.length()) == 0)
       return true;
 
     //explore the next layer down
     auto const* pCurrentVolume = pCurrent->GetVolume();
     unsigned int nd = pCurrentVolume->GetNdaughters();
     for(unsigned int i = 0; i < nd; ++i) {
       path.push_back(pCurrentVolume->GetNode(i));
       if (FindFirstVolume(name, path)) return true;
       path.pop_back();
     } // for
     return false;
   } // FindFirstVolume()

geo::TPCID geo::GeometryCore::FindTPCAtPosition ( double const worldLoc[3] ) const

inline

Returns the ID of the TPC at specified location.

Parameters

worldLoc 3D coordinates of the point (world reference frame) [cm]

Returns: the TPC ID, or an invalid one if no TPC is there

Definition at line 2462 of file GeometryCore.h.

2463 { return FindTPCAtPosition(geo::vect::makePointFromCoords(worldLoc)); }

geo::TPCID FindTPCAtPosition(double const worldLoc[3]) const

Returns the ID of the TPC at specified location.

Definition: GeometryCore.h:2462

GENVECTOR_CONSTEXPR::geo::Point_t makePointFromCoords(Coords &&coords)

Creates a geo::Point_t from its coordinates (see makeFromCoords()).

Definition: geo_vectors_utils.h:1511

geo::TPCID geo::GeometryCore::FindTPCAtPosition ( geo::Point_t const & point ) const

Returns the ID of the TPC at specified location.

Parameters

worldLoc 3D point (world reference frame, centimeters)

Returns: the TPC ID, or an invalid one if no TPC is there

Definition at line 352 of file GeometryCore.cxx.

                                                                         {
 
     // first find the cryostat
     geo::CryostatGeo const* cryo = PositionToCryostatPtr(point);
     if (!cryo) return {};
 
     // then ask it about the TPC
     geo::TPCID tpcid = cryo->PositionToTPCID(point, 1. + fPositionWiggle);
     if (tpcid) return tpcid;
 
     // return an invalid TPC ID with cryostat information set:
     tpcid.Cryostat = cryo->ID().Cryostat;
     tpcid.markInvalid();
     return tpcid;
 
   } // GeometryCore::FindTPCAtPosition()

geo::TPCID geo::GeometryCore::FindTPCAtPosition ( TVector3 const & point ) const

inline

Definition at line 2472 of file GeometryCore.h.

2473 { return FindTPCAtPosition(geo::vect::toPoint(point)); }

geo::GeometryCore::FindTPCAtPosition

::geo::Point_t toPoint(Point const &p)

Convert the specified point into a geo::Point_t.

Definition: geo_vectors_utils.h:1485

geo::TPCID FindTPCAtPosition(double const worldLoc[3]) const

Returns the ID of the TPC at specified location.

Definition: GeometryCore.h:2462

readout::TPCsetID geo::GeometryCore::FindTPCsetAtPosition ( double const worldLoc[3] ) const

Returns the ID of the TPC set at specified location.

Parameters

worldLoc 3D coordinates of the point (world reference frame)

Returns: the TPC set ID, or an invalid one if no TPC set is there

Definition at line 1780 of file GeometryCore.cxx.

   {
     return TPCtoTPCset(FindTPCAtPosition(worldLoc));
   } // GeometryCore::FindTPCsetAtPosition()

raw::ChannelID_t geo::GeometryCore::FirstChannelInROP ( readout::ROPID const & ropid ) const

Returns the ID of the first channel in the specified readout plane.

Parameters

ropid ID of the readout plane

Returns: ID of first channel, or raw::InvalidChannelID if ID is invalid

Note that this check is performed on the validity of the readout plane ID, that does not necessarily imply that the readout plane specified by the ID actually exists. Check if the ROP exists with HasROP(). The behaviour for non-existing readout planes is undefined.

Definition at line 1847 of file GeometryCore.cxx.

   {
     return fChannelMapAlg->FirstChannelInROP(ropid);
   } // GeometryCore::FirstChannelInROP()

std::string geo::GeometryCore::GDMLFile ( ) const

inline

Returns the full directory path to the GDML file source.

Returns: the full directory path to the GDML file source

This is the full path of the source of the detector geometry handed to the detector simulation (GEANT).

Definition at line 1757 of file GeometryCore.h.

1757 { return fGDMLfile; }

geo::GeometryCore::fGDMLfile

std::string fGDMLfile

path to geometry file used for Geant4 simulation

Definition: GeometryCore.h:5512

template<typename GeoID >

GeoID geo::GeometryCore::GetBeginID ( ) const

inline

Returns the ID of the first element of the detector.

Template Parameters

GeoID type of the ID to be returned

Returns: ID of the first subelement in the detector

Definition at line 1941 of file GeometryCore.h.

1941 { GeoID id; GetBeginID(id); return id; }

geo::GeometryCore::HasCryostat

GeoID GetBeginID() const

Returns the ID of the first element of the detector.

Definition: GeometryCore.h:1941

template<typename GeoID , typename ContextID >

GeoID geo::GeometryCore::GetBeginID ( ContextID const & id ) const

Returns the ID of the first subelement of the specified element.

Template Parameters

GeoID	type of the ID to be returned
ContextID	type of the ID of the containing element

Parameters

id	ID of the containing element

Returns: ID of the first subelement in the specified geometry element

void geo::GeometryCore::GetBeginID ( geo::CryostatID & id ) const

inline

Initializes the specified ID with the ID of the first cryostat.

Definition at line 2142 of file GeometryCore.h.

2143 { id = geo::CryostatID(0, HasCryostat(geo::CryostatID(0))); }

geo::fhicl::CryostatID

IDparameter< geo::CryostatID > CryostatID

Member type of validated geo::CryostatID parameter.

Definition: geo_types_fhicl.h:279

bool HasCryostat(geo::CryostatID const &cryoid) const

Returns whether we have the specified cryostat.

Definition: GeometryCore.h:2019

The data type to uniquely identify a cryostat.

Definition: geo_types.h:190

void geo::GeometryCore::GetBeginID ( geo::TPCID & id ) const

inline

Initializes the specified ID with the ID of the first TPC.

iterators

Definition at line 2532 of file GeometryCore.h.

2533 { GetBeginID(id.asCryostatID()); id.TPC = 0; }

GeoID GetBeginID() const

Returns the ID of the first element of the detector.

Definition: GeometryCore.h:1941

void geo::GeometryCore::GetBeginID ( geo::PlaneID & id ) const

inline

Initializes the specified ID with the ID of the first plane.

Definition at line 3032 of file GeometryCore.h.

3033 { GetBeginID(id.asTPCID()); id.Plane = 0; }

GeoID GetBeginID() const

Returns the ID of the first element of the detector.

Definition: GeometryCore.h:1941

void geo::GeometryCore::GetBeginID ( geo::WireID & id ) const

inline

Initializes the specified ID with the ID of the first wire.

Definition at line 3435 of file GeometryCore.h.

3436 { GetBeginID(id.asPlaneID()); id.Wire = 0; }

GeoID GetBeginID() const

Returns the ID of the first element of the detector.

Definition: GeometryCore.h:1941

void geo::GeometryCore::GetBeginID ( readout::TPCsetID & id ) const

inline

Initializes the specified ID with the ID of the first TPC set.

iterators

Definition at line 4974 of file GeometryCore.h.

4975 { GetBeginID(id.asCryostatID()); id.TPCset = 0; }

GeoID GetBeginID() const

Returns the ID of the first element of the detector.

Definition: GeometryCore.h:1941

void geo::GeometryCore::GetBeginID ( readout::ROPID & id ) const

inline

Initializes the specified ID with the ID of the first readout plane.

iterators

Definition at line 5201 of file GeometryCore.h.

5202 { GetBeginID(id.asTPCsetID()); id.ROP = 0; }

geo::GeometryCore::GetBeginTPCID

GeoID GetBeginID() const

Returns the ID of the first element of the detector.

Definition: GeometryCore.h:1941

geo::PlaneID geo::GeometryCore::GetBeginPlaneID ( geo::CryostatID const & id ) const

inline

Returns the ID of the first plane of the specified cryostat.

Definition at line 3043 of file GeometryCore.h.

3044 { return { GetBeginTPCID(id), 0 }; }

geo::TPCID GetBeginTPCID(geo::CryostatID const &id) const

Returns the ID of the first TPC in the specified cryostat.

Definition: GeometryCore.h:2543

geo::PlaneID geo::GeometryCore::GetBeginPlaneID ( geo::TPCID const & id ) const

inline

Returns the ID of the first plane of the specified TPC.

Definition at line 3051 of file GeometryCore.h.

3052 { return { id, 0 }; }

readout::ROPID geo::GeometryCore::GetBeginROPID ( geo::CryostatID const & id ) const

inline

Returns the ID of the first readout plane of the specified cryostat.

Definition at line 5213 of file GeometryCore.h.

5214 { return { GetBeginTPCsetID(id), 0 }; }

geo::GeometryCore::GetBeginTPCsetID

readout::TPCsetID GetBeginTPCsetID(geo::CryostatID const &id) const

Returns the ID of the first TPC set in the specified cryostat.

Definition: GeometryCore.h:4986

readout::ROPID geo::GeometryCore::GetBeginROPID ( readout::TPCsetID const & id ) const

inline

Returns the ID of the first readout plane of the specified TPC set.

Definition at line 5222 of file GeometryCore.h.

5223 { return { id, 0 }; }

geo::TPCID geo::GeometryCore::GetBeginTPCID ( geo::CryostatID const & id ) const

inline

Returns the ID of the first TPC in the specified cryostat.

Definition at line 2543 of file GeometryCore.h.

2544 { return { id, 0 }; }

readout::TPCsetID geo::GeometryCore::GetBeginTPCsetID ( geo::CryostatID const & id ) const

inline

Returns the ID of the first TPC set in the specified cryostat.

Definition at line 4986 of file GeometryCore.h.

4987 { return { id, 0 }; }

geo::WireID geo::GeometryCore::GetBeginWireID ( geo::CryostatID const & id ) const

inline

Returns the ID of the first wire in the specified cryostat.

Definition at line 3446 of file GeometryCore.h.

3447 { return { GetBeginPlaneID(id), 0 }; }

geo::GeometryCore::GetClosestOpDet

geo::PlaneID GetBeginPlaneID(geo::CryostatID const &id) const

Returns the ID of the first plane of the specified cryostat.

Definition: GeometryCore.h:3043

geo::WireID geo::GeometryCore::GetBeginWireID ( geo::TPCID const & id ) const

inline

Returns the ID of the first wire of the specified TPC.

Definition at line 3454 of file GeometryCore.h.

3455 { return { geo::PlaneID(id, 0), 0 }; }

geo::fhicl::PlaneID

IDparameter< geo::PlaneID > PlaneID

Member type of validated geo::PlaneID parameter.

Definition: geo_types_fhicl.h:375

geo::WireID geo::GeometryCore::GetBeginWireID ( geo::PlaneID const & id ) const

inline

Returns the ID of the first wire of the specified wire plane.

Definition at line 3462 of file GeometryCore.h.

3463 { return { id, 0 }; }

unsigned int geo::GeometryCore::GetClosestOpDet ( geo::Point_t const & point ) const

Find the nearest OpChannel to some point.

Parameters

xyz	point to be queried, in world coordinates

Returns: the nearest OpChannel to the point, or std::numeric_limits<unsigned int>::max() if invalid point

Deprecated:: This method does not tell in which cryostat the detector is; use geo::CryostatGeo::GetClosestOpDet() instead (find the cryostat with PositionToCryostatPtr()).

Definition at line 1956 of file GeometryCore.cxx.

   {
     geo::CryostatGeo const* cryo = PositionToCryostatPtr(point);
     if (!cryo) return std::numeric_limits<unsigned int>::max();
     int o = cryo->GetClosestOpDet(point);
     return OpDetFromCryo(o, cryo->ID().Cryostat);
   }

unsigned int geo::GeometryCore::GetClosestOpDet ( double const * point ) const

Definition at line 1967 of file GeometryCore.cxx.

1968 { return GetClosestOpDet(geo::vect::makePointFromCoords(point)); }

unsigned int GetClosestOpDet(geo::Point_t const &point) const

Find the nearest OpChannel to some point.

Definition: GeometryCore.cxx:1956

geo::GeometryCore::GetCryostatVolumeName

GENVECTOR_CONSTEXPR::geo::Point_t makePointFromCoords(Coords &&coords)

Creates a geo::Point_t from its coordinates (see makeFromCoords()).

Definition: geo_vectors_utils.h:1511

std::string geo::GeometryCore::GetCryostatVolumeName ( geo::CryostatID const & cid ) const

Return the name of LAr TPC volume.

Parameters

cstat index of the cryostat

Returns: the name of the specified TPC

This information is used in the event display.

Todo:

Use a cryostat ID instead

What if it does not exist?

Definition at line 767 of file GeometryCore.cxx.

   {
     return std::string(Cryostat(cid).Volume()->GetName());
   }

std::string geo::GeometryCore::GetCryostatVolumeName ( unsigned int const cstat = 0 ) const

inline

Definition at line 2288 of file GeometryCore.h.

2289 { return GetCryostatVolumeName(geo::CryostatID(cstat)); }

std::string GetCryostatVolumeName(geo::CryostatID const &cid) const

Return the name of LAr TPC volume.

Definition: GeometryCore.cxx:767

geo::GeometryCore::Cryostat

The data type to uniquely identify a cryostat.

Definition: geo_types.h:190

CryostatGeo const& geo::GeometryCore::GetElement ( geo::CryostatID const & cryoid ) const

inline

Definition at line 2041 of file GeometryCore.h.

2042 { return Cryostat(cryoid); }

CryostatGeo const & Cryostat(geo::CryostatID const &cryoid) const

Returns the specified cryostat.

Definition: GeometryCore.cxx:321

TPCGeo const& geo::GeometryCore::GetElement ( geo::TPCID const & tpcid ) const

inline

Definition at line 2435 of file GeometryCore.h.

2436 { return TPC(tpcid); }

geo::GeometryCore::CryostatPtr

TPCGeo const & TPC(unsigned int const tpc=0, unsigned int const cstat=0) const

Returns the specified TPC.

Definition: GeometryCore.h:2431

PlaneGeo const& geo::GeometryCore::GetElement ( geo::PlaneID const & planeid ) const

inline

Definition at line 3005 of file GeometryCore.h.

3006 { return Plane(planeid); }

geo::GeometryCore::Plane

PlaneGeo const & Plane(unsigned int const p, unsigned int const tpc=0, unsigned int const cstat=0) const

Returns the specified wire.

Definition: GeometryCore.h:3000

WireGeo const& geo::GeometryCore::GetElement ( geo::WireID const & wireid ) const

inline

Definition at line 3426 of file GeometryCore.h.

3427 { return Wire(wireid); }

geo::GeometryCore::Wire

WireGeo const & Wire(geo::WireID const &wireid) const

Returns the specified wire.

Definition: GeometryCore.h:3422

CryostatGeo const* geo::GeometryCore::GetElementPtr ( geo::CryostatID const & cryoid ) const

inline

Definition at line 2056 of file GeometryCore.h.

2057 { return CryostatPtr(cryoid); }

CryostatGeo const * CryostatPtr(geo::CryostatID const &cryoid) const

Returns the specified cryostat.

Definition: GeometryCore.h:2054

TPCGeo const* geo::GeometryCore::GetElementPtr ( geo::TPCID const & tpcid ) const

inline

Definition at line 2453 of file GeometryCore.h.

2454 { return TPCPtr(tpcid); }

geo::GeometryCore::TPCPtr

TPCGeo const * TPCPtr(geo::TPCID const &tpcid) const

Returns the specified TPC.

Definition: GeometryCore.h:2448

PlaneGeo const* geo::GeometryCore::GetElementPtr ( geo::PlaneID const & planeid ) const

inline

Definition at line 3023 of file GeometryCore.h.

3024 { return PlanePtr(planeid); }

geo::GeometryCore::PlanePtr

PlaneGeo const * PlanePtr(geo::PlaneID const &planeid) const

Returns the specified plane.

Definition: GeometryCore.h:3018

WireGeo const* geo::GeometryCore::GetElementPtr ( geo::WireID const & wireid ) const

inline

Definition at line 3408 of file GeometryCore.h.

3409 { return WirePtr(wireid); }

geo::GeometryCore::WirePtr

WireGeo const * WirePtr(geo::WireID const &wireid) const

Returns the specified wire.

Definition: GeometryCore.h:3403

template<typename GeoID >

GeoID geo::GeometryCore::GetEndID ( ) const

inline

Returns the (possibly invalid) ID after the last subelement of the detector.

Template Parameters

GeoID type of the ID to be returned

Returns: ID after the last subelement in the specified geometry element

Definition at line 1960 of file GeometryCore.h.

1960 { GeoID id; GetEndID(id); return id; }

geo::GeometryCore::GetEndID

GeoID GetEndID() const

Returns the (possibly invalid) ID after the last subelement of the detector.

Definition: GeometryCore.h:1960

template<typename GeoID , typename ContextID >

GeoID geo::GeometryCore::GetEndID ( ContextID const & id ) const

Returns the (possibly invalid) ID after the last subelement of the specified element.

Template Parameters

GeoID	type of the ID to be returned
ContextID	type of the ID of the containing element

Parameters

id	ID of the containing element

Returns: ID (possibly invalid) after the last subelement in the specified geometry element

void geo::GeometryCore::GetEndID ( geo::CryostatID & id ) const

inline

Initializes the specified ID with the invalid ID after the last cryostat.

Definition at line 2146 of file GeometryCore.h.

2147 { id = geo::CryostatID(Ncryostats(), false); }

geo::fhicl::CryostatID

IDparameter< geo::CryostatID > CryostatID

Member type of validated geo::CryostatID parameter.

Definition: geo_types_fhicl.h:279

geo::GeometryCore::GetEndID

unsigned int Ncryostats() const

Returns the number of cryostats in the detector.

Definition: GeometryCore.h:2002

void geo::GeometryCore::GetEndID ( geo::TPCID & id ) const

Initializes the specified ID with the invalid ID after the last TPC.

Definition at line 459 of file GeometryCore.cxx.

                                                 {
     if (MaxTPCs() == 0) {
       GetBeginID(id);
       id.markInvalid();
     }
     else {
       GetEndID(id.asCryostatID());
       id.TPC = 0;
     }
   } // GeometryCore::GetEndID(geo::TPCID)

void geo::GeometryCore::GetEndID ( geo::PlaneID & id ) const

Initializes the specified ID with the invalid ID after the last plane.

Definition at line 819 of file GeometryCore.cxx.

                                                   {
     if (MaxPlanes() == 0) {
       GetBeginID(id);
       id.markInvalid();
     }
     else {
       GetEndID(id.asTPCID());
       id.Plane = 0;
     }
   } // GeometryCore::GetEndID(PlaneID)

void geo::GeometryCore::GetEndID ( geo::WireID & id ) const

Initializes the specified ID with the invalid ID after the last wire.

Definition at line 947 of file GeometryCore.cxx.

                                                  {
     if (MaxWires() == 0) {
       GetBeginID(id);
       id.markInvalid();
     }
     else {
       GetEndID(id.asPlaneID());
       id.Wire = 0;
     }
   } // GeometryCore::GetEndID(WireID)

void geo::GeometryCore::GetEndID ( readout::TPCsetID & id ) const

inline

Initializes the specified ID with the invalid ID after the last TPC set.

Definition at line 4978 of file GeometryCore.h.

4979 { GetEndID(id.asCryostatID()); id.TPCset = 0; }

GeoID GetEndID() const

Returns the (possibly invalid) ID after the last subelement of the detector.

Definition: GeometryCore.h:1960

void geo::GeometryCore::GetEndID ( readout::ROPID & id ) const

inline

Initializes the specified ID with the invalid ID after the last ROP.

Definition at line 5205 of file GeometryCore.h.

5206 { GetEndID(id.asTPCsetID()); id.ROP = 0; }

geo::GeometryCore::GetEndID

GeoID GetEndID() const

Returns the (possibly invalid) ID after the last subelement of the detector.

Definition: GeometryCore.h:1960

geo::PlaneID geo::GeometryCore::GetEndPlaneID ( geo::CryostatID const & id ) const

Returns the (possibly invalid) ID after the last plane of the specified cryostat.

Definition at line 831 of file GeometryCore.cxx.

                                                                       {
     geo::CryostatGeo const* cryo = CryostatPtr(id);
     return (cryo && cryo->MaxPlanes() > 0)
       ? geo::PlaneID{ GetEndTPCID(id), 0 }: GetBeginPlaneID(id);
   } // GeometryCore::GetEndPlaneID(CryostatID)

geo::PlaneID geo::GeometryCore::GetEndPlaneID ( geo::TPCID const & id ) const

Returns the (possibly invalid) ID after the last plane of the specified TPC.

Definition at line 838 of file GeometryCore.cxx.

                                                                  {
     if (geo::TPCGeo const* TPC = TPCPtr(id); TPC && TPC->Nplanes() > 0)
       return { GetNextID(id), 0 };
     geo::PlaneID pid = GetBeginPlaneID(id);
     pid.markInvalid();
     return pid;
   } // GeometryCore::GetEndPlaneID(TPCID)

readout::ROPID geo::GeometryCore::GetEndROPID ( geo::CryostatID const & id ) const

inline

Returns the (possibly invalid) ID after the last readout plane of the specified cryostat.

Definition at line 5218 of file GeometryCore.h.

5219 { return { GetEndTPCsetID(id), 0 }; }

geo::GeometryCore::GetEndTPCsetID

readout::TPCsetID GetEndTPCsetID(geo::CryostatID const &id) const

Definition: GeometryCore.h:4991

readout::ROPID geo::GeometryCore::GetEndROPID ( readout::TPCsetID const & id ) const

inline

Returns the (possibly invalid) ID after the last readout plane of the specified TPC set.

Definition at line 5227 of file GeometryCore.h.

5228 { return { GetNextID(id), 0 }; }

geo::GeometryCore::GetNextID

GeoID GetNextID(GeoID const &id) const

Returns the ID next to the specified one.

Definition: GeometryCore.h:1950

geo::TPCID geo::GeometryCore::GetEndTPCID ( geo::CryostatID const & id ) const

Returns the (possibly invalid) ID after the last TPC of the specified cryostat.

Definition at line 471 of file GeometryCore.cxx.

                                                                   {
     if (geo::CryostatGeo const* cryo = CryostatPtr(id); cryo && cryo->NTPC() > 0)
       return { id.Cryostat + 1, 0 };
     geo::TPCID tpcid = GetBeginTPCID(id);
     tpcid.markInvalid();
     return tpcid;
   } // GeometryCore::GetEndTPCID()

readout::TPCsetID geo::GeometryCore::GetEndTPCsetID ( geo::CryostatID const & id ) const

inline

Returns the (possibly invalid) ID after the last TPC set of the specified cryostat.

Definition at line 4991 of file GeometryCore.h.

4992 { return { id.Cryostat + 1, 0 }; }

geo::WireID geo::GeometryCore::GetEndWireID ( geo::CryostatID const & id ) const

Returns the (possibly invalid) ID after the last wire in the specified cryostat.

Definition at line 959 of file GeometryCore.cxx.

                                                                     {
     geo::CryostatGeo const* cryo = CryostatPtr(id);
     if (cryo && cryo->MaxWires() > 0) return { GetEndPlaneID(id), 0 };
     geo::WireID wid = GetBeginWireID(id);
     wid.markInvalid();
     return wid;
   } // GeometryCore::GetEndWireID(CryostatID)

geo::WireID geo::GeometryCore::GetEndWireID ( geo::TPCID const & id ) const

Returns the (possibly invalid) ID after the last wire of the specified TPC.

Definition at line 968 of file GeometryCore.cxx.

                                                                {
     geo::TPCGeo const* TPC = TPCPtr(id);
     if (TPC && TPC->MaxWires() > 0) return { GetEndPlaneID(id), 0 };
     geo::WireID wid = GetBeginWireID(id);
     wid.markInvalid();
     return wid;
   } // GeometryCore::GetEndWireID(TPCID)

geo::WireID geo::GeometryCore::GetEndWireID ( geo::PlaneID const & id ) const

Returns the (possibly invalid) ID after the last wire of the specified wire plane.

Definition at line 977 of file GeometryCore.cxx.

                                                                  {
 
     if (geo::PlaneGeo const* plane = PlanePtr(id); plane && plane->Nwires() > 0)
       return { GetNextID(id), 0 };
     geo::WireID wid = GetBeginWireID(id);
     wid.markInvalid();
     return wid;
   } // GeometryCore::GetEndWireID(PlaneID)

std::string geo::GeometryCore::GetLArTPCVolumeName ( geo::TPCID const & tpcid ) const

Return the name of specified LAr TPC volume.

Parameters

tpcid	ID of the TPC
tpc	index of TPC in the cryostat
cstat	index of the cryostat

Returns: the name of the specified TPC

This information is used by Geant4 simulation

Todo:

Use a TPCID instead

What if it does not exist?

Definition at line 761 of file GeometryCore.cxx.

   {
     return std::string(TPC(tpcid).ActiveVolume()->GetName());
   }

std::string geo::GeometryCore::GetLArTPCVolumeName	(	unsigned int const	tpc = `0`,
		unsigned int const	cstat = `0`
	)		const

inline

Definition at line 2830 of file GeometryCore.h.

2831 { return GetLArTPCVolumeName(geo::TPCID(cstat, tpc)); }

geo::GeometryCore::GetLArTPCVolumeName

The data type to uniquely identify a TPC.

Definition: geo_types.h:386

std::string GetLArTPCVolumeName(geo::TPCID const &tpcid) const

Return the name of specified LAr TPC volume.

Definition: GeometryCore.cxx:761

template<typename GeoID >

GeoID geo::GeometryCore::GetNextID ( GeoID const & id ) const

inline

Returns the ID next to the specified one.

Template Parameters

GeoID type of the ID to be returned

Parameters

id	the element ID to be incremented

Returns: ID of the next subelement after id

Definition at line 1950 of file GeometryCore.h.

1951 { auto nextID(id); IncrementID(nextID); return nextID; }

geo::GeometryCore::IncrementID

bool IncrementID(geo::CryostatID &id) const

Definition: GeometryCore.h:5632

template<typename Point >

Point geo::GeometryCore::GetTPCFrontFaceCenter ( geo::TPCID const & tpcid ) const

inline

Returns the center of side of the detector facing the beam.

Template Parameters

Point _(default: DefaultPoint_t)_ return this point type

Parameters

tpcid ID of the TPC

Returns: position of center of TPC face toward the beam, in world coordinates [cm]

Effectively, this is the center of the side of TPC active volume which faces the negative z direction, the first that a beam following the positive z direction crosses.

Definition at line 2783 of file GeometryCore.h.

2784 { return TPC(tpcid).GetFrontFaceCenter<Point>(); }

dcel2d::Point

std::tuple< double, double, const reco::ClusterHit3D * > Point

Definitions used by the VoronoiDiagram algorithm.

Definition: DCEL.h:44

geo::TPCGeo::GetFrontFaceCenter

Point GetFrontFaceCenter() const

Returns the center of the active TPC volume side facing negative z.

Definition: TPCGeo.h:308

TPCGeo const & TPC(unsigned int const tpc=0, unsigned int const cstat=0) const

Returns the specified TPC.

Definition: GeometryCore.h:2431

DefaultPoint_t geo::GeometryCore::GetTPCFrontFaceCenter ( geo::TPCID const & tpcid ) const

inline

Definition at line 2785 of file GeometryCore.h.

2786 { return GetTPCFrontFaceCenter<DefaultPoint_t>(tpcid); }

template<typename Point >

Point geo::GeometryCore::GetTPCFrontFaceCenter	(	unsigned int	tpc = `0`,
		unsigned int	cstat = `0`
	)		const

inline

Returns the center of side of the detector facing the beam.

Template Parameters

Point _(default: DefaultPoint_t)_ return this point type

Parameters

tpc	_(default: `0`)_ TPC number within the cryostat `cstat`
cstat	_(default: `0`)_ number of cryostat

Returns: position of center of TPC face toward the beam, in world coordinates [cm]

See Also: GetTPCFrontFaceCenter(geo::TPCID const&)

Note: Please use GetTPCFrontFaceCenter(geo::TPCID const&) instead.

Definition at line 2803 of file GeometryCore.h.

2804 { return GetTPCFrontFaceCenter<Point>(geo::TPCID(cstat, tpc)); }

geo::fhicl::TPCID

IDparameter< geo::TPCID > TPCID

Member type of validated geo::TPCID parameter.

Definition: geo_types_fhicl.h:311

DefaultPoint_t geo::GeometryCore::GetTPCFrontFaceCenter	(	unsigned int	tpc = `0`,
		unsigned int	cstat = `0`
	)		const

inline

Definition at line 2806 of file GeometryCore.h.

2807 { return GetTPCFrontFaceCenter<DefaultPoint_t>(tpc, cstat); }

const std::string geo::GeometryCore::GetWorldVolumeName ( ) const

Return the name of the world volume (needed by Geant4 simulation)

Definition at line 640 of file GeometryCore.cxx.

   {
     // For now, and possibly forever, this is a constant (given the
     // definition of "nodeNames" above).
     return std::string("volWorld");
   }

unsigned int geo::GeometryCore::HardwareChannelFromOpChannel ( int opChannel ) const

Convert unique channel to hardware channel.

Definition at line 283 of file GeometryCore.cxx.

   {
     return fChannelMapAlg->HardwareChannelFromOpChannel(opChannel);
   }

bool geo::GeometryCore::HasChannel ( raw::ChannelID_t channel ) const

Returns whether the specified channel exists and is valid.

Parameters

channel the ID of the channel

Returns: whether the specified channel exists

A channel is defined as existing and valid if its ID is not invalid and if the channel is physical.

Definition at line 628 of file GeometryCore.cxx.

                                                             {
     return fChannelMapAlg->HasChannel(channel);
   } // GeometryCore::HasChannel()

bool geo::GeometryCore::HasCryostat ( geo::CryostatID const & cryoid ) const

inline

Returns whether we have the specified cryostat.

The HasElement() method is overloaded and its meaning depends on the type of ID.

Definition at line 2019 of file GeometryCore.h.

2020 { return cryoid.Cryostat < Ncryostats(); }

geo::GeometryCore::HasCryostat

unsigned int Ncryostats() const

Returns the number of cryostats in the detector.

Definition: GeometryCore.h:2002

bool geo::GeometryCore::HasElement ( geo::CryostatID const & cryoid ) const

inline

Definition at line 2021 of file GeometryCore.h.

2022 { return HasCryostat(cryoid); }

bool HasCryostat(geo::CryostatID const &cryoid) const

Returns whether we have the specified cryostat.

Definition: GeometryCore.h:2019

bool geo::GeometryCore::HasElement ( geo::TPCID const & tpcid ) const

inline

Returns whether we have the specified TPC.

Definition at line 2412 of file GeometryCore.h.

2412 { return HasTPC(tpcid); }

geo::GeometryCore::HasTPC

bool HasTPC(geo::TPCID const &tpcid) const

Returns whether we have the specified TPC.

Definition: GeometryCore.h:2405

bool geo::GeometryCore::HasElement ( geo::PlaneID const & planeid ) const

inline

Definition at line 2978 of file GeometryCore.h.

2979 { return HasPlane(planeid); }

geo::GeometryCore::HasPlane

bool HasPlane(geo::PlaneID const &planeid) const

Returns whether we have the specified plane.

Definition: GeometryCore.h:2973

bool geo::GeometryCore::HasElement ( geo::WireID const & wireid ) const

inline

Definition at line 3391 of file GeometryCore.h.

3391 { return HasWire(wireid); }

geo::GeometryCore::HasWire

bool HasWire(geo::WireID const &wireid) const

Returns whether we have the specified wire.

Definition: GeometryCore.h:3386

bool geo::GeometryCore::HasElement ( readout::TPCsetID const & tpcsetid ) const

inline

Returns whether we have the specified TPC set.

Definition at line 4938 of file GeometryCore.h.

4939 { return HasTPCset(tpcsetid); }

geo::GeometryCore::HasTPCset

bool HasTPCset(readout::TPCsetID const &tpcsetid) const

Definition: GeometryCore.cxx:1773

bool geo::GeometryCore::HasElement ( readout::ROPID const & ropid ) const

inline

Returns whether we have the specified readout plane

Returns: whether the readout plane is valid and exists

Definition at line 5140 of file GeometryCore.h.

5140 { return HasROP(ropid); }

geo::GeometryCore::HasROP

bool HasROP(readout::ROPID const &ropid) const

Definition: GeometryCore.cxx:1817

bool geo::GeometryCore::HasPlane ( geo::PlaneID const & planeid ) const

inline

Returns whether we have the specified plane.

The HasElement() method is overloaded and its meaning depends on the type of ID.

Definition at line 2973 of file GeometryCore.h.

       {
         geo::TPCGeo const* pTPC = TPCPtr(planeid);
         return pTPC? pTPC->HasPlane(planeid): false;
       }

bool geo::GeometryCore::HasROP ( readout::ROPID const & ropid ) const

Returns whether we have the specified readout plane

Returns: whether the readout plane is valid and exists

Definition at line 1817 of file GeometryCore.cxx.

                                                            {
     return fChannelMapAlg->HasROP(ropid);
   } // GeometryCore::HasROP()

bool geo::GeometryCore::HasTPC ( geo::TPCID const & tpcid ) const

inline

Returns whether we have the specified TPC.

Definition at line 2405 of file GeometryCore.h.

       {
         CryostatGeo const* pCryo = CryostatPtr(tpcid);
         return pCryo? pCryo->HasTPC(tpcid): false;
       }

bool geo::GeometryCore::HasTPCset ( readout::TPCsetID const & tpcsetid ) const

Returns whether we have the specified TPC set

Returns: whether the TPC set is valid and exists

Definition at line 1773 of file GeometryCore.cxx.

                                                                     {
     return fChannelMapAlg->HasTPCset(tpcsetid);
   } // GeometryCore::HasTPCset()

bool geo::GeometryCore::HasWire ( geo::WireID const & wireid ) const

inline

Returns whether we have the specified wire.

The HasElement() method is overloaded and its meaning depends on the type of ID.

Definition at line 3386 of file GeometryCore.h.

       {
         geo::PlaneGeo const* pPlane = PlanePtr(wireid);
         return pPlane? pPlane->HasWire(wireid): false;
       }

bool geo::GeometryCore::IncrementID ( geo::CryostatID & id ) const

inline

Sets the ID to the ID after the specified one.

Returns: whether the ID is actually valid (validity flag is also set)

Definition at line 5632 of file GeometryCore.h.

                                                                 {
   ++id.Cryostat;
   if (id) id.isValid = HasCryostat(id); // if invalid already, it stays so
   return bool(id);
 } // geo::GeometryCore::IncrementID(geo::CryostatID)

bool geo::GeometryCore::IncrementID ( geo::TPCID & id ) const

inline

Sets the ID to the ID after the specified one.

Returns: whether the ID is actually valid (validity flag is also set)

Definition at line 5638 of file GeometryCore.h.

                                                            {
   unsigned int const nTPCsInCryo = NTPC(id);
   if (++id.TPC < nTPCsInCryo) return bool(id); // if was invalid, it stays so
   // no more TPCs in this cryostat
   id.TPC = 0;
   return IncrementID(id.asCryostatID()); // also sets validity
 } // geo::GeometryCore::IncrementID(geo::TPCID)

bool geo::GeometryCore::IncrementID ( geo::PlaneID & id ) const

inline

Sets the ID to the ID after the specified one.

Returns: whether the ID is actually valid (validity flag is also set)

Definition at line 5646 of file GeometryCore.h.

                                                              {
   // this implementation is non-optimal, in that the cryostat lookup is
   // performed both here and, potentially, in IncrementID(TPCID)
   unsigned int const nPlanesInTPC = Nplanes(id);
   if (++id.Plane < nPlanesInTPC) return bool(id); // if was invalid, stays so
   // no more planes in this TPCs
   id.Plane = 0;
   return IncrementID(id.asTPCID()); // also sets validity
 } // geo::GeometryCore::IncrementID(geo::PlaneID)

bool geo::GeometryCore::IncrementID ( geo::WireID & id ) const

inline

Sets the ID to the ID after the specified one.

Returns: whether the ID is actually valid (validity flag is also set)

Definition at line 5656 of file GeometryCore.h.

                                                             {
   // this implementation is non-optimal, in that the TPC lookup is
   // performed both here and, potentially, in IncrementID(PlaneID)
   unsigned int const nWiresInPlane = Nwires(id);
   if (++id.Wire < nWiresInPlane) return bool(id); // if was invalid, stays so
   // no more wires in this plane
   id.Wire = 0;
   return IncrementID(id.asPlaneID()); // also sets validity
 } // geo::GeometryCore::IncrementID(geo::WireID)

bool geo::GeometryCore::IncrementID ( readout::TPCsetID & id ) const

inline

Sets the ID to the ID after the specified one.

Returns: whether the ID is actually valid (validity flag is also set)

Definition at line 5666 of file GeometryCore.h.

                                                                   {
   unsigned int const nTPCsetsInCryo = NTPCsets(id);
   if (++id.TPCset < nTPCsetsInCryo)
     return bool(id); // if was invalid, it stays so
   // no more TPC sets in this cryostat
   id.TPCset = 0;
   return IncrementID(id.asCryostatID()); // also sets validity
 } // geo::GeometryCore::IncrementID(readout::TPCsetID)

bool geo::GeometryCore::IncrementID ( readout::ROPID & id ) const

inline

Sets the ID to the ID after the specified one.

Returns: whether the ID is actually valid (validity flag is also set)

Definition at line 5675 of file GeometryCore.h.

                                                                {
   // this implementation is non-optimal, in that the cryostat lookup is
   // performed both here and, potentially, in IncrementID(TPCsetID)
   unsigned int const nROPinTPC = NROPs(id);
   if (++id.ROP < nROPinTPC) return bool(id); // if was invalid, stays so
   // no more readout planes in this TPC set
   id.ROP = 0;
   return IncrementID(id.asTPCsetID()); // also sets validity
 } // geo::GeometryCore::IncrementID(readout::ROPID)

std::string geo::GeometryCore::Info ( std::string indent = " " ) const

Returns a string with complete geometry information.

See Also: Print()

Definition at line 1187 of file GeometryCore.cxx.

                                                        {
     std::ostringstream sstr;
     Print(sstr, indent);
     return sstr.str();
   } // GeometryCore::Info()

bool geo::GeometryCore::IntersectionPoint	(	geo::WireID const &	wid1,
		geo::WireID const &	wid2,
		double &	y,
		double &	z
	)		const

Returns the intersection point of two wires.

Parameters

wid1	ID of the first wire
wid2	ID of the other wire
y	(output) y coordinate of the intersection point
z	(output) z coordinate of the intersection point

Returns: whether an intersection was found within the TPC

See Also: WireIDsIntersect()

The behaviour of this method reflects the one of WireIDsIntersect(), which supersedes this one.

To test if the result is infinity, use e.g. std::isfinite(y).

Deprecated:: This method uses arbitrary assumptions and should not be used. Use WireIDsIntersect() returning a vector, instead.

Definition at line 1746 of file GeometryCore.cxx.

   {
     geo::WireIDIntersection widIntersect;
     bool const found = WireIDsIntersect(wid1, wid2, widIntersect);
     y = widIntersect.y;
     z = widIntersect.z;
     return found;
   }

bool geo::GeometryCore::IntersectionPoint	(	unsigned int	wire1,
		unsigned int	wire2,
		unsigned int	plane1,
		unsigned int	plane2,
		unsigned int	cstat,
		unsigned int	tpc,
		double &	y,
		double &	z
	)		const

inline

Returns the intersection point of two wires.

Parameters

wire1	wire index of the first wire
wire2	wire index of the other wire
plane1	plane index of the first wire
plane2	plane index of the other wire
cstat	cryostat number
tpc	tpc number within the cryostat where the planes belong
y	(output) y coordinate of the intersection point
z	(output) z coordinate of the intersection point

Returns: whether an intersection was found

No check is performed, not any information provided, about the validity of the result.

Deprecated:: This method uses arbitrary assumptions and should not be used. Use WireIDsIntersect() returning a vector, instead.

Definition at line 4258 of file GeometryCore.h.

       {
         return IntersectionPoint(
           geo::WireID(cstat, tpc, plane1, wire1),
           geo::WireID(cstat, tpc, plane2, wire2),
           y, z
           );
       }

bool geo::GeometryCore::IntersectLines	(	double	A_start_x,
		double	A_start_y,
		double	A_end_x,
		double	A_end_y,
		double	B_start_x,
		double	B_start_y,
		double	B_end_x,
		double	B_end_y,
		double &	x,
		double &	y
	)		const

Computes the intersection between two lines on a plane.

Parameters

A_start_x	x coordinate of one point of the first segment
A_start_y	y coordinate of one point of the first segment
A_end_x	x coordinate of another point of the first segment
A_end_y	y coordinate of another point of the first segment
B_start_x	x coordinate of one point of the second segment
B_start_y	y coordinate of one point of the second segment
B_end_x	x coordinate of another point of the second segment
B_end_y	y coordinate of another point of the second segment
x	_(output)_ variable to store the x coordinate of intersection
y	_(output)_ variable to store the y coordinate of intersection

Returns: whether intersection exists

The order of the ends is not relevant. The return value is false if the two segments are parallel. In that case, x and y variables are not changed. Otherwise, they hold the intersection coordinate, even if the intersection point is beyond one or both the segments.

Definition at line 1409 of file GeometryCore.cxx.

           {
 
     // Equation from http://en.wikipedia.org/wiki/Line%E2%80%93line_intersection
     // T.Yang Nov, 2014
     // Notation: x => coordinate orthogonal to the drift direction and to the beam direction
     //           y => direction orthogonal to the previous and to beam direction
 
     double const denom = (A_start_x - A_end_x)*(B_start_y - B_end_y)
       - (A_start_y - A_end_y)*(B_start_x - B_end_x);
 
     if (coordIs.zero(denom)) return false;
 
     double const A = (A_start_x * A_end_y - A_start_y * A_end_x) / denom;
     double const B = (B_start_x * B_end_y - B_start_y * B_end_x) / denom;
 
     x = (B_start_x - B_end_x) * A - (A_start_x - A_end_x) * B;
     y = (B_start_y - B_end_y) * A - (A_start_y - A_end_y) * B;
 
     return true;
 
   } // GeometryCore::IntersectLines()

bool geo::GeometryCore::IntersectSegments	(	double	A_start_x,
		double	A_start_y,
		double	A_end_x,
		double	A_end_y,
		double	B_start_x,
		double	B_start_y,
		double	B_end_x,
		double	B_end_y,
		double &	x,
		double &	y
	)		const

Computes the intersection between two segments on a plane.

Parameters

A_start_x	x coordinate of the start of the first segment
A_start_y	y coordinate of the start of the first segment
A_end_x	x coordinate of the end of the first segment
A_end_y	y coordinate of the end of the first segment
B_start_x	x coordinate of the start of the second segment
B_start_y	y coordinate of the start of the second segment
B_end_x	x coordinate of the end of the second segment
B_end_y	y coordinate of the end of the second segment
x	_(output)_ variable to store the x coordinate of intersection
y	_(output)_ variable to store the y coordinate of intersection

Returns: whether intersection exists and is on both segments

The order of the ends is not relevant. The return value is false if the two segments are parallel, or if their intersection point is not on both the segments. If the segments are parallel, x and y variables are not changed. Otherwise, they hold the intersection coordinate, even if the intersection point is beyond one or both the segments.

Definition at line 1436 of file GeometryCore.cxx.

           {
 
     bool bCross = IntersectLines(
       A_start_x, A_start_y, A_end_x, A_end_y,
       B_start_x, B_start_y, B_end_x, B_end_y,
       x, y
       );
 
     if (bCross) {
       mf::LogWarning("IntersectSegments") << "The segments are parallel!";
       return false;
     }
 
     return PointWithinSegments(
       A_start_x, A_start_y, A_end_x, A_end_y,
       B_start_x, B_start_y, B_end_x, B_end_y,
       x, y
       );
 
   } // GeometryCore::IntersectSegments()

bool geo::GeometryCore::IsValidOpChannel ( int opChannel ) const

Is this a valid OpChannel number?

Definition at line 290 of file GeometryCore.cxx.

   {
     return fChannelMapAlg->IsValidOpChannel(opChannel, this->NOpDets());
   }

IteratorBox< cryostat_id_iterator, &GeometryCore::begin_cryostat_id, &GeometryCore::end_cryostat_id > geo::GeometryCore::IterateCryostatIDs ( ) const

inline

Enables ranged-for loops on all cryostat IDs of the detector.

Returns: an object suitable for ranged-for loops on all cryostat IDs

Example of usage:

for (geo::CryostatID const& cID: geom->IterateCryostatIDs()) {
  geo::CryostatGeo const& Cryo = geom->Cryostat(cID);

  // useful code here

} // for all cryostats

Definition at line 2187 of file GeometryCore.h.

2187 { return { this }; }

IteratorBox< cryostat_iterator, &GeometryCore::begin_cryostat, &GeometryCore::end_cryostat > geo::GeometryCore::IterateCryostats ( ) const

inline

Enables ranged-for loops on all cryostats of the detector.

Returns: an object suitable for ranged-for loops on all cryostats

Example of usage:

for (geo::CryostatGeo const& Cryo: geom->IterateCryostats()) {

  // useful code here

} // for all cryostats

Definition at line 2206 of file GeometryCore.h.

2206 { return { this }; }

IteratorBox< plane_id_iterator, &GeometryCore::begin_plane_id, &GeometryCore::end_plane_id > geo::GeometryCore::IteratePlaneIDs ( ) const

inline

Enables ranged-for loops on all plane IDs of the detector.

Returns: an object suitable for ranged-for loops on all plane IDs

Example of usage:

for (geo::PlaneID const& pID: geom->IteratePlaneIDs()) {
  geo::PlaneGeo const& Plane = geom->Plane(pID);
  // useful code here
} // for all plane IDs

Definition at line 3130 of file GeometryCore.h.

3130 { return { this }; }

LocalIteratorBox< plane_id_iterator, geo::CryostatID, &GeometryCore::begin_plane_id, &GeometryCore::end_plane_id > geo::GeometryCore::IteratePlaneIDs ( geo::CryostatID const & cid ) const

inline

Enables ranged-for loops on all plane IDs of the specified cryostat.

Parameters

cid	the ID of the cryostat to loop the plane IDs of

Returns: an object suitable for ranged-for loops on plane IDs

If the cryostat ID is invalid, the effect is undefined.

Example of usage:

geo::CryostatID cid{1}; // cryostat #1 (hope it exists!)
for (geo::PlaneID const& pID: geom->IteratePlaneIDs(cid)) {
  geo::PlaneGeo const& plane = geom->Plane(pID);
  // useful code here
} // for all planes in cryostat #1

Definition at line 3155 of file GeometryCore.h.

3155 { return { this, cid }; }

LocalIteratorBox< plane_id_iterator, geo::TPCID, &GeometryCore::begin_plane_id, &GeometryCore::end_plane_id > geo::GeometryCore::IteratePlaneIDs ( geo::TPCID const & tid ) const

inline

Enables ranged-for loops on all plane IDs of the specified TPC.

Parameters

tid	the ID of the TPC to loop the plane IDs of

Returns: an object suitable for ranged-for loops on plane IDs

If the TPC ID is invalid, the effect is undefined.

Example of usage:

geo::TPCID tid{ 0, 1 }; // C:0 T:1 (hope it exists!)
for (geo::PlaneID const& pID: geom->IteratePlaneIDs(tid)) {
  geo::PlaneGeo const& plane = geom->Plane(pID);
  // useful code here
} // for all planes in C:0 T:1

Definition at line 3179 of file GeometryCore.h.

3179 { return { this, tid }; }

void geo::GeometryCore::IteratePlaneIDs ( geo::PlaneID const & pid ) const

delete

IteratePlaneIDs() is not supported on plane IDs.

void geo::GeometryCore::IteratePlaneIDs ( geo::WireID const & pid ) const

delete

IteratePlaneIDs() is not supported on wire IDs.

void geo::GeometryCore::IteratePlaneIDs ( readout::TPCsetID const & ) const

delete

IteratePlaneIDs() is not supported on readout IDs.

void geo::GeometryCore::IteratePlaneIDs ( readout::ROPID const & ) const

delete

IteratePlaneIDs() is not supported on readout IDs.

IteratorBox< plane_iterator, &GeometryCore::begin_plane, &GeometryCore::end_plane > geo::GeometryCore::IteratePlanes ( ) const

inline

Enables ranged-for loops on all planes of the detector.

Returns: an object suitable for ranged-for loops on all planes

Example of usage:

for (geo::PlaneGeo const& Plane: geom->IteratePlanes()) {
  // useful code here
} // for all planes

Definition at line 3212 of file GeometryCore.h.

3212 { return { this }; }

LocalIteratorBox< plane_iterator, geo::CryostatID, &GeometryCore::begin_plane, &GeometryCore::end_plane > geo::GeometryCore::IteratePlanes ( geo::CryostatID const & cid ) const

inline

Enables ranged-for loops on all planes of the specified cryostat.

Parameters

cid	the ID of the cryostat to loop the planes of

Returns: an object suitable for ranged-for loops on planes

If the cryostat ID is invalid, the effect is undefined.

Example of usage:

geo::CryostatID cid{1}; // cryostat #1 (hope it exists!)
for (geo::PlaneGeo const& plane: geom->IteratePlanes(cid)) {
  // useful code here
} // for planes in cryostat 1

Definition at line 3235 of file GeometryCore.h.

3235 { return { this, cid }; }

LocalIteratorBox< plane_iterator, geo::TPCID, &GeometryCore::begin_plane, &GeometryCore::end_plane > geo::GeometryCore::IteratePlanes ( geo::TPCID const & tid ) const

inline

Enables ranged-for loops on all planes of the specified TPC.

Parameters

tid	the ID of the TPC to loop the planes of

Returns: an object suitable for ranged-for loops on planes

If the TPC ID is invalid, the effect is undefined.

Example of usage:

geo::TPCID tid{ 0, 1 }; // C:0 T:1 (hope it exists!)
for (geo::PlaneGeo const& plane: geom->IteratePlanes(tid)) {
  // useful code here
} // for planes in C:0 T:1

Definition at line 3258 of file GeometryCore.h.

3258 { return { this, tid }; }

void geo::GeometryCore::IteratePlanes ( geo::PlaneID const & pid ) const

delete

IteratePlanes() is not supported on plane IDs.

void geo::GeometryCore::IteratePlanes ( geo::WireID const & pid ) const

delete

IteratePlanes() is not supported on wire IDs.

void geo::GeometryCore::IteratePlanes ( readout::TPCsetID const & ) const

delete

IteratePlanes() is not supported on readout IDs.

void geo::GeometryCore::IteratePlanes ( readout::ROPID const & ) const

delete

IteratePlanes() is not supported on readout IDs.

IteratorBox< ROP_id_iterator, &GeometryCore::begin_ROP_id, &GeometryCore::end_ROP_id > geo::GeometryCore::IterateROPIDs ( ) const

inline

Enables ranged-for loops on all readout plane IDs of the detector.

Returns: an object suitable for ranged-for loops on all ROP IDs

Example of usage:

for (readout::ROPID const& rID: geom->IterateROPIDs()) {
  // useful code here
} // for all ROPs

Definition at line 5276 of file GeometryCore.h.

5276 { return { this }; }

LocalIteratorBox< ROP_id_iterator, geo::CryostatID, &GeometryCore::begin_ROP_id, &GeometryCore::end_ROP_id > geo::GeometryCore::IterateROPIDs ( geo::CryostatID const & cid ) const

inline

Enables ranged-for loops on all readout plane IDs of the specified cryostat.

Parameters

cid	the ID of the cryostat to loop the readout plane IDs of

Returns: an object suitable for ranged-for loops on readout plane IDs

If the cryostat ID is invalid, the effect is undefined.

Example of usage:

geo::CryostatID cid{1}; // cryostat #1 (hope it exists!)
for (readout::ROPID const& rID: geom->IterateROPIDs(cid)) {
  // useful code here
} // for all readout planes in cryostat #1

Definition at line 5300 of file GeometryCore.h.

5300 { return { this, cid }; }

LocalIteratorBox< ROP_id_iterator, readout::TPCsetID, &GeometryCore::begin_ROP_id, &GeometryCore::end_ROP_id > geo::GeometryCore::IterateROPIDs ( readout::TPCsetID const & sid ) const

inline

Enables ranged-for loops on all readout plane IDs of the specified TPC set.

Parameters

sid	the ID of the TPC set to loop the readout plane IDs of

Returns: an object suitable for ranged-for loops on readout plane IDs

If the TPC set ID is invalid, the effect is undefined.

Example of usage:

readout::TPCsetID sid{ 0, 1 }; // C:0 S:1 (hope it exists!)
for (readout::ROPID const& rID: geom->IterateROPIDs(sid)) {
  // useful code here
} // for all readout planes in C:0 S:1

Definition at line 5324 of file GeometryCore.h.

5324 { return { this, sid }; }

IteratorBox< TPC_id_iterator, &GeometryCore::begin_TPC_id, &GeometryCore::end_TPC_id > geo::GeometryCore::IterateTPCIDs ( ) const

inline

Enables ranged-for loops on all TPC IDs of the detector.

Returns: an object suitable for ranged-for loops on all TPC IDs

Example of usage:

for (geo::TPCID const& tID: geom->IterateTPCIDs()) {
  geo::TPCGeo const& TPC = geom->TPC(tID);
  // useful code here
} // for all TPC

Definition at line 2603 of file GeometryCore.h.

2603 { return { this }; }

LocalIteratorBox< TPC_id_iterator, geo::CryostatID, &GeometryCore::begin_TPC_id, &GeometryCore::end_TPC_id > geo::GeometryCore::IterateTPCIDs ( geo::CryostatID const & cid ) const

inline

Enables ranged-for loops on all TPC IDs of the specified cryostat.

Parameters

cid	the ID of the cryostat to loop the TPC IDs of

Returns: an object suitable for ranged-for loops on TPC IDs

If the cryostat ID is invalid, the effect is undefined.

Example of usage:

geo::CryostatID cid{1}; // cryostat #1 (hope it exists!)
for (geo::TPCID const& tID: geom->IterateTPCIDs(cid)) {
  geo::TPCGeo const& TPC = geom->TPC(tID);
  // useful code here
} // for all TPC in cryostat #1

Definition at line 2627 of file GeometryCore.h.

2627 { return { this, cid }; }

void geo::GeometryCore::IterateTPCIDs ( geo::TPCID const & pid ) const

delete

IterateTPCIDs() is not supported on TPC IDs.

void geo::GeometryCore::IterateTPCIDs ( geo::PlaneID const & pid ) const

delete

IterateTPCIDs() is not supported on plane IDs.

void geo::GeometryCore::IterateTPCIDs ( geo::WireID const & pid ) const

delete

IterateTPCIDs() is not supported on wire IDs.

void geo::GeometryCore::IterateTPCIDs ( readout::TPCsetID const & ) const

delete

IterateTPCIDs() is not supported on readout IDs.

void geo::GeometryCore::IterateTPCIDs ( readout::ROPID const & ) const

delete

IterateTPCIDs() is not supported on readout IDs.

IteratorBox<TPC_iterator, &GeometryCore::begin_TPC, &GeometryCore::end_TPC> geo::GeometryCore::IterateTPCs ( ) const

inline

Enables ranged-for loops on all TPCs of the detector.

Returns: an object suitable for ranged-for loops on all TPCs

If the cryostat ID is invalid, the effect is undefined.

Example of usage:

for (geo::TPCGeo const& TPC: geom->IterateTPCs()) {
  // useful code here
} // for TPCs

Definition at line 2661 of file GeometryCore.h.

2661 { return { this }; }

LocalIteratorBox< TPC_iterator, geo::CryostatID, &GeometryCore::begin_TPC, &GeometryCore::end_TPC > geo::GeometryCore::IterateTPCs ( geo::CryostatID const & cid ) const

inline

Enables ranged-for loops on all TPCs of the specified cryostat.

Parameters

cid	the ID of the cryostat to loop the TPCs of

Returns: an object suitable for ranged-for loops on TPCs

If the cryostat ID is invalid, the effect is undefined.

Example of usage:

geo::CryostatID cid{1}; // cryostat #1 (hope it exists!)
for (geo::TPCGeo const& TPC: geom->IterateTPCs(cid)) {
  // useful code here
} // for TPCs in cryostat 1

Definition at line 2684 of file GeometryCore.h.

2684 { return { this, cid }; }

void geo::GeometryCore::IterateTPCs ( geo::TPCID const & pid ) const

delete

IterateTPCs() is not supported on TPC IDs.

void geo::GeometryCore::IterateTPCs ( geo::PlaneID const & pid ) const

delete

IterateTPCs() is not supported on plane IDs.

void geo::GeometryCore::IterateTPCs ( geo::WireID const & pid ) const

delete

IterateTPCs() is not supported on wire IDs.

void geo::GeometryCore::IterateTPCs ( readout::TPCsetID const & ) const

delete

IterateTPCs() is not supported on readout IDs.

void geo::GeometryCore::IterateTPCs ( readout::ROPID const & ) const

delete

IterateTPCs() is not supported on readout IDs.

IteratorBox< TPCset_id_iterator, &GeometryCore::begin_TPCset_id, &GeometryCore::end_TPCset_id > geo::GeometryCore::IterateTPCsetIDs ( ) const

inline

Enables ranged-for loops on all TPC set IDs of the detector.

Returns: an object suitable for ranged-for loops on all TPC set IDs

Example of usage:

for (readout::TPCsetID const& sID: geom->IterateTPCsetIDs()) {
  // useful code here
} // for all TPC sets

Definition at line 5031 of file GeometryCore.h.

5031 { return { this }; }

LocalIteratorBox< TPCset_id_iterator, geo::CryostatID, &GeometryCore::begin_TPCset_id, &GeometryCore::end_TPCset_id > geo::GeometryCore::IterateTPCsetIDs ( geo::CryostatID const & cid ) const

inline

Enables ranged-for loops on all TPC set IDs of the specified cryostat.

Parameters

cid	the ID of the cryostat to loop the TPC set IDs of

Returns: an object suitable for ranged-for loops on TPC set IDs

If the cryostat ID is invalid, the effect is undefined.

Example of usage:

geo::CryostatID cid{1}; // cryostat #1 (hope it exists!)
for (readout::TPCsetID const& tID: geom->IterateTPCsetIDs(cid)) {
  // useful code here
} // for all TPC sets in cryostat #1

Definition at line 5055 of file GeometryCore.h.

5055 { return { this, cid }; }

IteratorBox< wire_id_iterator, &GeometryCore::begin_wire_id, &GeometryCore::end_wire_id > geo::GeometryCore::IterateWireIDs ( ) const

inline

Enables ranged-for loops on all wire IDs of the detector.

Returns: an object suitable for ranged-for loops on all wire IDs

Example of usage:

for (geo::WireID const& wID: geom->IterateWireIDs()) {
  geo::WireGeo const& Wire = geom->Wire(wID);
  // useful code here
} // for all wires

Definition at line 3553 of file GeometryCore.h.

3553 { return { this }; }

LocalIteratorBox< wire_id_iterator, geo::CryostatID, &GeometryCore::begin_wire_id, &GeometryCore::end_wire_id > geo::GeometryCore::IterateWireIDs ( geo::CryostatID const & cid ) const

inline

Enables ranged-for loops on all wire IDs of specified cryostat.

Parameters

cid	the ID of the cryostat to loop the wires of

Returns: an object suitable for ranged-for loops on cryostat wire IDs

If the cryostat ID is invalid, the effect is undefined.

Example of usage:

geo::CryostatID cid{1}; // cryostat #1 (hope it exists!)
for (geo::WireID const& wID: geom->IterateWireIDs(cid)) {
  geo::WireGeo const& Wire = geom->Wire(wID);
  // useful code here
} // for all wires

Definition at line 3578 of file GeometryCore.h.

3578 { return { this, cid }; }

LocalIteratorBox< wire_id_iterator, geo::TPCID, &GeometryCore::begin_wire_id, &GeometryCore::end_wire_id > geo::GeometryCore::IterateWireIDs ( geo::TPCID const & tid ) const

inline

Enables ranged-for loops on all wire IDs of specified TPC.

Parameters

tid	the ID of the TPC to loop the wires of

Returns: an object suitable for ranged-for loops on TPC wire IDs

If the TPC ID is invalid, the effect is undefined.

Example of usage:

geo::TPCID tid{0, 1}; // C:0 T:1 (hope it exists!)
for (geo::WireID const& wID: geom->IterateWireIDs(tid)) {
  geo::WireGeo const& Wire = geom->Wire(wID);
  // useful code here
} // for all wires in C:0 T:1

Definition at line 3603 of file GeometryCore.h.

3603 { return { this, tid }; }

LocalIteratorBox< wire_id_iterator, geo::PlaneID, &GeometryCore::begin_wire_id, &GeometryCore::end_wire_id > geo::GeometryCore::IterateWireIDs ( geo::PlaneID const & pid ) const

inline

Enables ranged-for loops on all wire IDs of specified wire plane.

Parameters

pid	the ID of the wire plane to loop the wires of

Returns: an object suitable for ranged-for loops on plane wire IDs

If the wire plane ID is invalid, the effect is undefined.

Example of usage:

geo::PlaneID pid{0, 0, 1}; // C:0 T:0 P:1
for (geo::WireID const& wID: geom->IterateWireIDs(pid)) {
  geo::WireGeo const& Wire = geom->Wire(wID);
  // useful code here
} // for all wires in C:0 T:0 P:1

Definition at line 3628 of file GeometryCore.h.

3628 { return { this, pid }; }

void geo::GeometryCore::IterateWireIDs ( geo::WireID const & pid ) const

delete

IterateWireIDs() is not supported on wire IDs.

void geo::GeometryCore::IterateWireIDs ( readout::TPCsetID const & ) const

delete

IterateWireIDs() is not supported on readout IDs.

void geo::GeometryCore::IterateWireIDs ( readout::ROPID const & ) const

delete

IterateWireIDs() is not supported on readout IDs.

IteratorBox< wire_iterator, &GeometryCore::begin_wire, &GeometryCore::end_wire > geo::GeometryCore::IterateWires ( ) const

inline

Enables ranged-for loops on all wires of the detector.

Returns: an object suitable for ranged-for loops on all wires

Example of usage:

for (geo::WireGeo const& Wire: geom->IterateWires()) {
  // useful code here
} // for all wires

Definition at line 3657 of file GeometryCore.h.

3657 { return { this }; }

LocalIteratorBox< wire_iterator, geo::CryostatID, &GeometryCore::begin_wire, &GeometryCore::end_wire > geo::GeometryCore::IterateWires ( geo::CryostatID const & cid ) const

inline

Enables ranged-for loops on all wires of specified cryostat.

Parameters

cid	the ID of the cryostat to loop the wires of

Returns: an object suitable for ranged-for loops on cryostat wires

If the cryostat ID is invalid, the effect is undefined.

Example of usage:

geo::CryostatID cid{1}; // cryostat #1 (hope it exists!)
for (geo::WireID const& Wire: geom->IterateWires(cid)) {
  // useful code here
} // for all wires

Definition at line 3681 of file GeometryCore.h.

3681 { return { this, cid }; }

LocalIteratorBox< wire_iterator, geo::TPCID, &GeometryCore::begin_wire, &GeometryCore::end_wire > geo::GeometryCore::IterateWires ( geo::TPCID const & tid ) const

inline

Enables ranged-for loops on all wires of specified TPC.

Parameters

tid	the ID of the TPC to loop the wires of

Returns: an object suitable for ranged-for loops on TPC wires

If the TPC ID is invalid, the effect is undefined.

Example of usage:

geo::TPCID tid{0, 1}; // C:0 T:1 (hope it exists!)
for (geo::WireID const& Wire: geom->IterateWires(tid)) {
  // useful code here
} // for all wires in C:0 T:1

Definition at line 3705 of file GeometryCore.h.

3705 { return { this, tid }; }

LocalIteratorBox< wire_iterator, geo::PlaneID, &GeometryCore::begin_wire, &GeometryCore::end_wire > geo::GeometryCore::IterateWires ( geo::PlaneID const & tid ) const

inline

Enables ranged-for loops on all wires of specified wire plane.

Parameters

pid	the ID of the wire plane to loop the wires of

Returns: an object suitable for ranged-for loops on plane wires

If the wire plane ID is invalid, the effect is undefined.

Example of usage:

geo::PlaneID pid{0, 1}; // C:0 T:0 P:1
for (geo::WireID const& Wire: geom->IterateWires(pid)) {
  // useful code here
} // for all wires in C:0 T:0 T:1

Definition at line 3729 of file GeometryCore.h.

3729 { return { this, tid }; }

void geo::GeometryCore::IterateWires ( geo::WireID const & pid ) const

delete

IterateWires() is not supported on wire IDs.

void geo::GeometryCore::IterateWires ( readout::TPCsetID const & ) const

delete

IterateWires() is not supported on readout IDs.

void geo::GeometryCore::IterateWires ( readout::ROPID const & ) const

delete

IterateWires() is not supported on readout IDs.

void geo::GeometryCore::LoadGeometryFile	(	std::string	gdmlfile,
		std::string	rootfile,
		geo::GeometryBuilder &	builder,
		bool	bForceReload = `false`
	)

Loads the geometry information from the specified files.

Parameters

gdmlfile	path to file to be used for Geant4 simulation
rootfile	path to file for internal geometry representation
builder	algorithm to be used for the interpretation of geometry
bForceReload	reload even if there is already a valid geometry

See Also: ApplyChannelMap()

Both paths must directly resolve to an available file, as no search is performed for them.

The gdmlfile parameter does not have to necessarily be in GDML format, as long as it's something supported by Geant4. This file is not used by the geometry, but its path is provided on request by the simulation modules (see LArSoft LArG4 module). The rootfile also does not need to be a ROOT file, but just anything that TGeoManager::Import() supports. This file is parsed immediately and the internal geometry representation is built out of it.

Note: After calling this method, the detector geometry information can be considered complete, but the geometry service provider is not fully initialized yet, since it's still necessary to provide or update the channel mapping.

Definition at line 91 of file GeometryCore.cxx.

     {
 
 
     if (gdmlfile.empty()) {
       throw cet::exception("GeometryCore")
         << "No GDML Geometry file specified!\n";
     }
 
     if (rootfile.empty()) {
       throw cet::exception("GeometryCore")
         << "No ROOT Geometry file specified!\n";
     }
 
     ClearGeometry();
 
     // Open the GDML file, and convert it into ROOT TGeoManager format.
     // Then lock the gGeoManager to prevent future imports, for example
     // in AuxDetGeometry
     if( !gGeoManager || bForceReload ){
       if (gGeoManager) TGeoManager::UnlockGeometry();
       else { // very first time (or so it should)
         // [20210630, petrillo@slac.stanford.edu]
         // ROOT 6.22.08 allows us to choose the representation of lengths
         // in the geometry objects parsed from GDML.
         // In LArSoft we want them to be centimeters (ROOT standard).
         // This was tracked as Redmine issue #25990, and I leave this mark
         // because I feel that we'll be back to it not too far in the future.
         // Despite the documentation (ROOT 6.22/08),
         // it seems the units are locked from the beginning,
         // so we unlock without prejudice.
         TGeoManager::LockDefaultUnits(false);
         TGeoManager::SetDefaultUnits(TGeoManager::kRootUnits);
         TGeoManager::LockDefaultUnits(true);
       }
       TGeoManager::Import(rootfile.c_str());
       gGeoManager->LockGeometry();
     }
 
     BuildGeometry(builder);
 
     fGDMLfile = gdmlfile;
     fROOTfile = rootfile;
 
     mf::LogInfo("GeometryCore") << "New detector geometry loaded from "
                                 << "\n\t" << fROOTfile
                                 << "\n\t" << fGDMLfile << "\n";
 
   } // GeometryCore::LoadGeometryFile()

void geo::GeometryCore::LoadGeometryFile	(	std::string	gdmlfile,
		std::string	rootfile,
		bool	bForceReload = `false`
	)

Loads the geometry information from the specified files.

Parameters

gdmlfile	path to file to be used for Geant4 simulation
rootfile	path to file for internal geometry representation
bForceReload	reload even if there is already a valid geometry

See Also: ApplyChannelMap()

This legacy version of LoadGeometryFile() uses a standard geo::GeometryBuilder implementation. Do not rely on it if you can avoid it.

Definition at line 146 of file GeometryCore.cxx.

     {
     fhicl::Table<geo::GeometryBuilderStandard::Config> const builderConfig
       (fBuilderParameters, { "tool_type" });
 
     // this is a wink to the understanding that we might be using a art-based
     // service provider configuration sprinkled with tools.
     geo::GeometryBuilderStandard builder{builderConfig()};
     LoadGeometryFile(gdmlfile, rootfile, builder, bForceReload);
   } // GeometryCore::LoadGeometryFile()

template<typename T >

geo::PlaneDataContainer<T> geo::GeometryCore::makePlaneData ( ) const

inline

Returns a container with one entry per wire plane.

Template Parameters

T	type of data in the container

Returns: a container with one default-constructed T per plane

See Also: geo::PlaneDataContainer

The working assumption is that all cryostats have the same number of TPCs, and all TPCs have the same number of planes. It is always guaranteed that all existing planes have an entry in the container, although if the previous working assumption is not satisfied there will be entries in the containers which are not associated to a valid plane.

The interface of the container is detailed in the documentation of the container itself, geo::PlaneDataContainer. Example of usage:

auto const* geom = lar::providerFrom<geo::GeometryCore>();
auto hitsPerPlane
  = geom->makePlaneData<std::vector<recob::Hit const*>>();
for (recob::Hit const& hit: hits) {
  if (hit.WireID()) hitsPerPlane[hit.WireID()].push_back(&hit);
} // for

where the container will be filled with pointers to all hits on the given wire plane (wire IDs are implicitly converted into plane IDs in the index operator[] call).

Definition at line 2888 of file GeometryCore.h.

2889 { return { Ncryostats(), MaxTPCs(), MaxPlanes() }; }

geo::GeometryCore::MaxPlanes

unsigned int Ncryostats() const

Returns the number of cryostats in the detector.

Definition: GeometryCore.h:2002

unsigned int MaxPlanes() const

Returns the largest number of planes among all TPCs in this detector.

Definition: GeometryCore.cxx:927

unsigned int MaxTPCs() const

Returns the largest number of TPCs a cryostat in the detector has.

Definition: GeometryCore.cxx:907

template<typename T >

geo::PlaneDataContainer<T> geo::GeometryCore::makePlaneData ( T const & defValue ) const

inline

Returns a container with one entry per wire plane.

Template Parameters

T	type of data in the container

Parameters

defValue the initial value of all elements in the container

Returns: a container with one default-constructed T per plane

See Also: geo::PlaneDataContainer

This function operates as makePlaneData() const, except that copies the specified value into all the entries of the container. Example:

auto const* geom = lar::providerFrom<geo::GeometryCore>();
auto nHitsPerPlane = geom->makePlaneData(0U);
for (recob::Hit const& hit: hits) {
  if (hit.WireID()) ++(hitsPerPlane[hit.WireID()]);
} // for

Definition at line 2910 of file GeometryCore.h.

2911 { return { Ncryostats(), MaxTPCs(), MaxPlanes(), defValue }; }

geo::GeometryCore::MaxPlanes

unsigned int Ncryostats() const

Returns the number of cryostats in the detector.

Definition: GeometryCore.h:2002

unsigned int MaxPlanes() const

Returns the largest number of planes among all TPCs in this detector.

Definition: GeometryCore.cxx:927

geo::GeometryCore::MaxROPs

unsigned int MaxTPCs() const

Returns the largest number of TPCs a cryostat in the detector has.

Definition: GeometryCore.cxx:907

template<typename T >

readout::ROPDataContainer<T> geo::GeometryCore::makeROPdata ( ) const

inline

Returns a container with one entry per readout plane.

Template Parameters

T	type of data in the container

Returns: a container with one default-constructed T per readout plane

See Also: readout::ROPDataContainer

The working assumption is that all cryostats have the same number of TPC sets, and all TPC sets have the same number of readout planes. It is always guaranteed that all existing readout planes have an entry in the container, although if the previous working assumption is not satisfied there will be entries in the container which are not associated to a valid readout plane.

The interface of the container is detailed in the documentation of the container itself, readout::ROPDataContainer. Example of usage:

auto const* geom = lar::providerFrom<geo::GeometryCore>();
auto hitsPerROP
  = geom->makeROPdata<std::vector<recob::Hit const*>>();

Definition at line 5109 of file GeometryCore.h.

5110 { return { Ncryostats(), MaxTPCsets(), MaxROPs() }; }

unsigned int MaxROPs() const

Returns the largest number of ROPs a TPC set in the detector has.

Definition: GeometryCore.cxx:1811

unsigned int Ncryostats() const

Returns the number of cryostats in the detector.

Definition: GeometryCore.h:2002

geo::GeometryCore::MaxROPs

unsigned int MaxTPCsets() const

Returns the largest number of TPC sets any cryostat in the detector has.

Definition: GeometryCore.cxx:1767

template<typename T >

readout::ROPDataContainer<T> geo::GeometryCore::makeROPdata ( T const & defValue ) const

inline

Returns a container with one entry per readout plane.

Template Parameters

T	type of data in the container

Parameters

defValue the initial value of all elements in the container

Returns: a container with one default-constructed T per readout plane

See Also: readout::ROPDataContainer

This function operates as makeROPdata() const, except that copies the specified value into all the entries of the container. Example:

auto const* geom = lar::providerFrom<geo::GeometryCore>();

auto nHitsPerROP = geom->makeROPdata(0U);

Definition at line 5127 of file GeometryCore.h.

5128 { return { Ncryostats(), MaxTPCsets(), MaxROPs(), defValue }; }

unsigned int MaxROPs() const

Returns the largest number of ROPs a TPC set in the detector has.

Definition: GeometryCore.cxx:1811

unsigned int Ncryostats() const

Returns the number of cryostats in the detector.

Definition: GeometryCore.h:2002

unsigned int MaxTPCsets() const

Returns the largest number of TPC sets any cryostat in the detector has.

Definition: GeometryCore.cxx:1767

template<typename T >

geo::TPCDataContainer<T> geo::GeometryCore::makeTPCData ( ) const

inline

Returns a container with one entry per TPC.

Template Parameters

T	type of data in the container

Returns: a container with one default-constructed T per TPC

See Also: geo::TPCDataContainer

The working assumption is that all cryostats have the same number of TPCs. It is always guaranteed that all existing TPCs have an entry in the container, although if the previous working assumption is not satisfied there will be entries in the containers which are not associated to a valid TPC.

The interface of the container is detailed in the documentation of the container itself, geo::TPCDataContainer. Example of usage:

auto const* geom = lar::providerFrom<geo::GeometryCore>();
auto tracksPerTPC
  = geom->makeTPCData<std::vector<recob::Track const*>>();
for (recob::Track const& track: tracks) {
  geo::TPCGeo const* tpc = geom->PositionToTPCptr(track.Start());
  if (tpc) tracksPerTPC[tpc->ID()].push_back(&track);
} // for

where the container will be filled with pointers to all tracks starting from a given TPC (tracks reconstructed as starting outside the TPCs will be not saved in the container).

Definition at line 2350 of file GeometryCore.h.

2351 { return { Ncryostats(), MaxTPCs() }; }

unsigned int Ncryostats() const

Returns the number of cryostats in the detector.

Definition: GeometryCore.h:2002

unsigned int MaxTPCs() const

Returns the largest number of TPCs a cryostat in the detector has.

Definition: GeometryCore.cxx:907

template<typename T >

geo::TPCDataContainer<T> geo::GeometryCore::makeTPCData ( T const & defValue ) const

inline

Returns a container with one entry per TPC.

Template Parameters

T	type of data in the container

Parameters

defValue the initial value of all elements in the container

Returns: a container with a value defValue per each TPC

See Also: geo::TPCDataContainer

This function operates as makeTPCData() const, except that copies the specified value into all the entries of the container. Example:

auto const* geom = lar::providerFrom<geo::GeometryCore>();
auto nTracksPerTPC = geom->makeTPCData(0U);
for (recob::Track const& track: tracks) {
  geo::TPCGeo const* tpc = geom->PositionToTPCptr(track.Start());
  if (tpc) ++(tracksPerTPC[tpc->ID()]);
} // for

Definition at line 2373 of file GeometryCore.h.

2374 { return { Ncryostats(), MaxTPCs(), defValue }; }

unsigned int Ncryostats() const

Returns the number of cryostats in the detector.

Definition: GeometryCore.h:2002

unsigned int MaxTPCs() const

Returns the largest number of TPCs a cryostat in the detector has.

Definition: GeometryCore.cxx:907

template<typename T >

readout::TPCsetDataContainer<T> geo::GeometryCore::makeTPCsetData ( ) const

inline

Returns a container with one entry per TPC set.

Template Parameters

T	type of data in the container

Returns: a container with one default-constructed T per TPC set

See Also: readout::TPCsetDataContainer

The working assumption is that all cryostats have the same number of TPC sets. It is always guaranteed that all existing TPC sets have an entry in the container, although if the previous working assumption is not satisfied there will be entries in the containers which are not associated to a valid TPC set.

The interface of the container is detailed in the documentation of the container itself, readout::TPCsetDataContainer. Example of usage:

auto const* geom = lar::providerFrom<geo::GeometryCore>();
auto tracksPerTPCset
  = geom->makeTPCsetData<std::vector<recob::Track const*>>();

Definition at line 4908 of file GeometryCore.h.

4909 { return { Ncryostats(), MaxTPCsets() }; }

unsigned int Ncryostats() const

Returns the number of cryostats in the detector.

Definition: GeometryCore.h:2002

unsigned int MaxTPCsets() const

Returns the largest number of TPC sets any cryostat in the detector has.

Definition: GeometryCore.cxx:1767

template<typename T >

readout::TPCsetDataContainer<T> geo::GeometryCore::makeTPCsetData ( T const & defValue ) const

inline

Returns a container with one entry per TPC set.

Template Parameters

T	type of data in the container

Parameters

defValue the initial value of all elements in the container

Returns: a container with a value defValue per each TPC set

See Also: readout::TPCsetDataContainer

This function operates as makeTPCsetData() const, except that it copies the specified value into all the entries of the container. Example:

auto const* geom = lar::providerFrom<geo::GeometryCore>();

auto nTracksPerTPCset = geom->makeTPCsetData(0U);

Definition at line 4926 of file GeometryCore.h.

4927 { return { Ncryostats(), MaxTPCsets(), defValue }; }

unsigned int Ncryostats() const

Returns the number of cryostats in the detector.

Definition: GeometryCore.h:2002

unsigned int MaxTPCsets() const

Returns the largest number of TPC sets any cryostat in the detector has.

Definition: GeometryCore.cxx:1767

double geo::GeometryCore::MassBetweenPoints	(	geo::Point_t const &	p1,
		geo::Point_t const &	p2
	)		const

Returns the column density between two points.

Parameters

p1	the first point
p2	the second point

Returns: the column density [kg / cm]

The column density is defined as $\int_{\vec{p}_{1}}^{\vec{p}_{2}} \rho(\vec{p}) d\vec{p}$ where $\rho(\vec{p})$ is the density at point $\vec{p}$ , which the integral leads from p1 to p2 in a straight line.

Both points are specified in world coordinates.

Definition at line 1145 of file GeometryCore.cxx.

   {
 
     //The purpose of this method is to determine the column density
     //between the two points given.  Do that by starting at p1 and
     //stepping until you get to the node of p2.  calculate the distance
     //between the point just inside that node and p2 to get the last
     //bit of column density
     double columnD = 0.;
 
     //first initialize a track - get the direction cosines
     geo::Vector_t const dir = (p2 - p1).Unit();
 
     double const dxyz[3] = { dir.X(), dir.Y(), dir.Z() };
     double const cp1[3] = { p1.X(), p1.Y(), p1.Z() };
     gGeoManager->InitTrack(cp1, dxyz);
 
     //might be helpful to have a point to a TGeoNode
     TGeoNode *node = gGeoManager->GetCurrentNode();
 
     //check that the points are not in the same volume already.
     //if they are in different volumes, keep stepping until you
     //are in the same volume as the second point
     while(!gGeoManager->IsSameLocation(p2.X(), p2.Y(), p2.Z())){
       gGeoManager->FindNextBoundary();
       columnD += gGeoManager->GetStep()*node->GetMedium()->GetMaterial()->GetDensity();
 
       //the act of stepping puts you in the next node and returns that node
       node = gGeoManager->Step();
     }//end loop to get to volume of second point
 
     //now you are in the same volume as the last point, but not at that point.
     //get the distance between the current point and the last one
     geo::Point_t const last
       = geo::vect::makePointFromCoords(gGeoManager->GetCurrentPoint());
     double const lastStep = (p2 - last).R();
     columnD += lastStep*node->GetMedium()->GetMaterial()->GetDensity();
 
     return columnD;
   }

double geo::GeometryCore::MassBetweenPoints	(	double *	p1,
		double *	p2
	)		const

TGeoMaterial const * geo::GeometryCore::Material ( geo::Point_t const & point ) const

Returns the material at the specified position.

Definition at line 1055 of file GeometryCore.cxx.

                                                                           {
     auto const pNode = gGeoManager->FindNode(point.X(), point.Y(), point.Z());
     if (!pNode) return nullptr;
     auto const pMedium = pNode->GetMedium();
     return pMedium? pMedium->GetMaterial(): nullptr;
   }

std::string geo::GeometryCore::MaterialName ( TVector3 const & point ) const

inline

Name of the deepest material containing the point xyz.

Returns: material of the origin by default

Definition at line 1891 of file GeometryCore.h.

1892 { return MaterialName(geo::vect::toPoint(point)); }

geo::GeometryCore::MaterialName

::geo::Point_t toPoint(Point const &p)

Convert the specified point into a geo::Point_t.

Definition: geo_vectors_utils.h:1485

std::string MaterialName(TVector3 const &point) const

Name of the deepest material containing the point xyz.

Definition: GeometryCore.h:1891

std::string geo::GeometryCore::MaterialName ( geo::Point_t const & point ) const

Definition at line 1063 of file GeometryCore.cxx.

   {
     // check that the given point is in the World volume at least
     geo::BoxBoundedGeo worldBox = WorldBox();
     if (!worldBox.ContainsPosition(point)) {
       mf::LogWarning("GeometryCoreBadInputPoint")
         << "point " << point << " is not inside the world volume "
         << worldBox.Min() << " -- " << worldBox.Max()
         << "; returning unknown material name";
       return { "unknownMaterial" };
     }
     auto const pMaterial = Material(point);
     if (!pMaterial) {
       mf::LogWarning("GeometryCoreBadInputPoint")
         << "material for point " << point
         << " not found! returning unknown material name";
       return { "unknownMaterial" };
     }
     return pMaterial->GetName();
   }

unsigned int geo::GeometryCore::MaxOpChannel ( ) const

Largest optical channel number.

Definition at line 259 of file GeometryCore.cxx.

   {
     return fChannelMapAlg->MaxOpChannel(this->NOpDets());
   }

unsigned int geo::GeometryCore::MaxPlanes ( ) const

Returns the largest number of planes among all TPCs in this detector.

Definition at line 927 of file GeometryCore.cxx.

                                              {
     unsigned int maxPlanes = 0;
     for (geo::CryostatGeo const& cryo: Cryostats()) {
       unsigned int maxPlanesInCryo = cryo.MaxPlanes();
       if (maxPlanesInCryo > maxPlanes) maxPlanes = maxPlanesInCryo;
     } // for
     return maxPlanes;
   } // GeometryCore::MaxPlanes()

unsigned int geo::GeometryCore::MaxROPs ( ) const

Returns the largest number of ROPs a TPC set in the detector has.

Definition at line 1811 of file GeometryCore.cxx.

                                            {
     return fChannelMapAlg->MaxROPs();
   } // GeometryCore::MaxROPs()

unsigned int geo::GeometryCore::MaxTPCs ( ) const

Returns the largest number of TPCs a cryostat in the detector has.

Definition at line 907 of file GeometryCore.cxx.

                                            {
     unsigned int maxTPCs = 0;
     for (geo::CryostatGeo const& cryo: Cryostats()) {
       unsigned int maxTPCsInCryo = cryo.NTPC();
       if (maxTPCsInCryo > maxTPCs) maxTPCs = maxTPCsInCryo;
     } // for
     return maxTPCs;
   } // GeometryCore::MaxTPCs()

unsigned int geo::GeometryCore::MaxTPCsets ( ) const

Returns the largest number of TPC sets any cryostat in the detector has.

Definition at line 1767 of file GeometryCore.cxx.

                                               {
     return fChannelMapAlg->MaxTPCsets();
   } // GeometryCore::MaxTPCsets()

unsigned int geo::GeometryCore::MaxWires ( ) const

Returns the largest number of wires among all planes in this detector.

Definition at line 937 of file GeometryCore.cxx.

                                             {
     unsigned int maxWires = 0;
     for (geo::CryostatGeo const& cryo: Cryostats()) {
       unsigned int maxWiresInCryo = cryo.MaxWires();
       if (maxWiresInCryo > maxWires) maxWires = maxWiresInCryo;
     } // for
     return maxWires;
   } // GeometryCore::MaxWires()

unsigned int geo::GeometryCore::NAuxDets ( ) const

inline

Returns the number of auxiliary detectors.

Todo:: use a AutDetID_t instead of unsigned int?

This method returns the total number of scintillator paddles (Auxiliary Detectors aka AuxDet) outside of the cryostat

Todo:: Change return type to size_t

Definition at line 4548 of file GeometryCore.h.

4548 { return AuxDets().size(); }

geo::GeometryCore::AuxDets

AuxDetList_t & AuxDets()

Return the interfal auxiliary detectors list.

Definition: GeometryCore.h:5502

unsigned int geo::GeometryCore::NAuxDetSensitive ( size_t const & aid ) const

Returns the number of sensitive components of auxiliary detector.

Parameters

aid	ID of the auxiliary detector

Returns: number of sensitive components in the auxiliary detector aid cet::exception (category "Geometry") if aid does not exist

Definition at line 296 of file GeometryCore.cxx.

   {
     if( aid > NAuxDets() - 1)
       throw cet::exception("Geometry") << "Requested AuxDet index " << aid
                                        << " is out of range: " << NAuxDets();
 
     return AuxDets()[aid].NSensitiveVolume();
   }

unsigned int geo::GeometryCore::Nchannels ( ) const

Returns the number of TPC readout channels in the detector.

Definition at line 208 of file GeometryCore.cxx.

   {
     return fChannelMapAlg->Nchannels();
   }

unsigned int geo::GeometryCore::Nchannels ( readout::ROPID const & ropid ) const

Returns the number of channels in the specified ROP.

Returns: number of channels in the specified ROP, 0 if non-existent

Definition at line 214 of file GeometryCore.cxx.

   {
     return fChannelMapAlg->Nchannels(ropid);
   } // GeometryCore::Nchannels(ROPID)

unsigned int geo::GeometryCore::Ncryostats ( ) const

inline

Returns the number of cryostats in the detector.

The NElements() and NSiblingElements() methods are overloaded and their return depends on the type of ID.

Todo:: Change return type to size_t

Definition at line 2002 of file GeometryCore.h.

2002 { return Cryostats().size(); }

geo::GeometryCore::Cryostats

CryostatList_t & Cryostats()

Return the internal cryostat list.

Definition: GeometryCore.h:5496

raw::ChannelID_t geo::GeometryCore::NearestChannel	(	geo::Point_t const &	worldLoc,
		geo::PlaneID const &	planeid
	)		const

Returns the ID of the channel nearest to the specified position.

Parameters

worldLoc	3D coordinates of the point (world reference frame)
planeid	ID of the wire plane the channel must belong to

Returns: the ID of the channel, or raw::InvalidChannelID if invalid wire

Bug:: on invalid wire, a geo::InvalidWireError exception is thrown

Definition at line 1296 of file GeometryCore.cxx.

   {
 
     // This method is supposed to return a channel number rather than
     //  a wire number.  Perform the conversion here (although, maybe
     //  faster if we deal in wire numbers rather than channel numbers?)
 
     // NOTE on failure both NearestChannel() and upstream:
     // * according to documentation, should return invalid channel
     // * in the actual code throw an exception because of a BUG
     //
     // The following implementation automatically becomes in fact compliant to
     // the documentation if upstreams becomes compliant to.
     // When that happens, just delete this comment.
     geo::WireID const wireID = NearestWireID(worldPos, planeid);
     return wireID? PlaneWireToChannel(wireID): raw::InvalidChannelID;
   } // GeometryCore::NearestChannel()

raw::ChannelID_t geo::GeometryCore::NearestChannel	(	const double	worldLoc[3],
		geo::PlaneID const &	planeid
	)		const

Returns the ID of the channel nearest to the specified position.

Parameters

worldLoc	3D coordinates of the point (world reference frame)
PlaneNo	the number of plane
TPCNo	the number of TPC
cstat	the number of cryostat

Returns: the ID of the channel, or raw::InvalidChannelID if invalid wire

Bug:: on invalid wire, a geo::InvalidWireError exception is thrown

The different versions allow different way to provide the position.

Todo:: remove the integers version

Definition at line 1279 of file GeometryCore.cxx.

   {
     return NearestChannel(geo::vect::makePointFromCoords(worldPos), planeid);
   }

raw::ChannelID_t geo::GeometryCore::NearestChannel	(	std::vector< double > const &	worldLoc,
		geo::PlaneID const &	planeid
	)		const

Definition at line 1286 of file GeometryCore.cxx.

   {
     if(worldPos.size() > 3) throw cet::exception("GeometryCore") << "bad size vector for "
                                                              << "worldPos: "
                                                              << worldPos.size() << "\n";
     return NearestChannel(worldPos.data(), planeid);
   }

raw::ChannelID_t geo::GeometryCore::NearestChannel	(	const TVector3 &	worldLoc,
		geo::PlaneID const &	planeid
	)		const

inline

Definition at line 4818 of file GeometryCore.h.

4819 { return NearestChannel(geo::vect::toPoint(worldLoc), planeid); }

::geo::Point_t toPoint(Point const &p)

Convert the specified point into a geo::Point_t.

Definition: geo_vectors_utils.h:1485

raw::ChannelID_t NearestChannel(geo::Point_t const &worldLoc, geo::PlaneID const &planeid) const

Returns the ID of the channel nearest to the specified position.

Definition: GeometryCore.cxx:1296

raw::ChannelID_t geo::GeometryCore::NearestChannel	(	const double	worldLoc[3],
		unsigned int const	PlaneNo,
		unsigned int const	TPCNo = `0`,
		unsigned int const	cstat = `0`
	)		const

inline

Definition at line 4820 of file GeometryCore.h.

4824 { return NearestChannel(worldLoc, geo::PlaneID(cstat, TPCNo, PlaneNo)); }

The data type to uniquely identify a Plane.

Definition: geo_types.h:472

raw::ChannelID_t NearestChannel(geo::Point_t const &worldLoc, geo::PlaneID const &planeid) const

Returns the ID of the channel nearest to the specified position.

Definition: GeometryCore.cxx:1296

raw::ChannelID_t geo::GeometryCore::NearestChannel	(	std::vector< double > const &	worldLoc,
		unsigned int const	PlaneNo,
		unsigned int const	TPCNo = `0`,
		unsigned int const	cstat = `0`
	)		const

inline

Definition at line 4825 of file GeometryCore.h.

4829 { return NearestChannel(worldLoc, geo::PlaneID(cstat, TPCNo, PlaneNo)); }

The data type to uniquely identify a Plane.

Definition: geo_types.h:472

raw::ChannelID_t NearestChannel(geo::Point_t const &worldLoc, geo::PlaneID const &planeid) const

Returns the ID of the channel nearest to the specified position.

Definition: GeometryCore.cxx:1296

raw::ChannelID_t geo::GeometryCore::NearestChannel	(	const TVector3 &	worldLoc,
		unsigned int const	PlaneNo,
		unsigned int const	TPCNo = `0`,
		unsigned int const	cstat = `0`
	)		const

inline

Definition at line 4830 of file GeometryCore.h.

4834 { return NearestChannel(worldLoc, geo::PlaneID(cstat, TPCNo, PlaneNo)); }

The data type to uniquely identify a Plane.

Definition: geo_types.h:472

raw::ChannelID_t NearestChannel(geo::Point_t const &worldLoc, geo::PlaneID const &planeid) const

Returns the ID of the channel nearest to the specified position.

Definition: GeometryCore.cxx:1296

raw::ChannelID_t geo::GeometryCore::NearestChannel	(	geo::Point_t const &	worldLoc,
		unsigned int const	PlaneNo,
		unsigned int const	TPCNo = `0`,
		unsigned int const	cstat = `0`
	)		const

inline

Definition at line 4835 of file GeometryCore.h.

4839 { return NearestChannel(worldLoc, geo::PlaneID(cstat, TPCNo, PlaneNo)); }

The data type to uniquely identify a Plane.

Definition: geo_types.h:472

raw::ChannelID_t NearestChannel(geo::Point_t const &worldLoc, geo::PlaneID const &planeid) const

Returns the ID of the channel nearest to the specified position.

Definition: GeometryCore.cxx:1296

unsigned int geo::GeometryCore::NearestWire	(	geo::Point_t const &	point,
		geo::PlaneID const &	planeid
	)		const

Returns the index of wire closest to position in the specified TPC.

Parameters

point	the point to be tested [cm]
planeid	ID of the plane

Returns: the index of the wire, or geo::WireID::InvalidID on failure

Bug:: Actually, on failure an exception geo::InvalidWireError is thrown

Deprecated:: Use NearestWireID() instead.

Definition at line 1230 of file GeometryCore.cxx.

   {
     return NearestWireID(point, planeid).Wire;
     // return fChannelMapAlg->NearestWire(worldPos, planeid);
   }

unsigned int geo::GeometryCore::NearestWire	(	const double	worldLoc[3],
		geo::PlaneID const &	planeid
	)		const

Returns the index of wire closest to position in the specified TPC.

Parameters

worldLoc	3D coordinates of the point (world reference frame)
planeid	ID of the plane
PlaneNo	plane number within the TPC
TPCNo	tpc number within the cryostat
cstat	cryostat number

Returns: the index of the wire

The different versions allow different way to provide the position.

Deprecated:: Use NearestWireID() instead.

Todo:

remove the integers version

what happens when no wire is found?

Definition at line 1238 of file GeometryCore.cxx.

   {
     return NearestWire(geo::vect::makePointFromCoords(worldPos), planeid);
   }

unsigned int geo::GeometryCore::NearestWire	(	std::vector< double > const &	worldLoc,
		geo::PlaneID const &	planeid
	)		const

Definition at line 1245 of file GeometryCore.cxx.

   {
     if(worldPos.size() > 3) throw cet::exception("GeometryCore") << "bad size vector for "
                                                              << "worldPos: "
                                                              << worldPos.size() << "\n";
     return NearestWire(worldPos.data(), planeid);
   }

unsigned int geo::GeometryCore::NearestWire	(	const TVector3 &	worldLoc,
		geo::PlaneID const &	planeid
	)		const

inline

Definition at line 4004 of file GeometryCore.h.

4005 { return NearestWire(geo::vect::toPoint(worldLoc), planeid); }

::geo::Point_t toPoint(Point const &p)

Convert the specified point into a geo::Point_t.

Definition: geo_vectors_utils.h:1485

geo::WireID::WireID_t NearestWire(geo::Point_t const &point, geo::PlaneID const &planeid) const

Returns the index of wire closest to position in the specified TPC.

Definition: GeometryCore.cxx:1230

unsigned int geo::GeometryCore::NearestWire	(	const double	worldLoc[3],
		unsigned int const	PlaneNo,
		unsigned int const	TPCNo = `0`,
		unsigned int const	cstat = `0`
	)		const

inline

Definition at line 4006 of file GeometryCore.h.

4010 { return NearestWire(worldLoc, geo::PlaneID(cstat, TPCNo, PlaneNo)); }

The data type to uniquely identify a Plane.

Definition: geo_types.h:472

geo::WireID::WireID_t NearestWire(geo::Point_t const &point, geo::PlaneID const &planeid) const

Returns the index of wire closest to position in the specified TPC.

Definition: GeometryCore.cxx:1230

unsigned int geo::GeometryCore::NearestWire	(	std::vector< double > const &	worldLoc,
		unsigned int const	PlaneNo,
		unsigned int const	TPCNo = `0`,
		unsigned int const	cstat = `0`
	)		const

inline

Definition at line 4011 of file GeometryCore.h.

4015 { return NearestWire(worldLoc, geo::PlaneID(cstat, TPCNo, PlaneNo)); }

The data type to uniquely identify a Plane.

Definition: geo_types.h:472

geo::WireID::WireID_t NearestWire(geo::Point_t const &point, geo::PlaneID const &planeid) const

Returns the index of wire closest to position in the specified TPC.

Definition: GeometryCore.cxx:1230

unsigned int geo::GeometryCore::NearestWire	(	const TVector3 &	worldLoc,
		unsigned int const	PlaneNo,
		unsigned int const	TPCNo = `0`,
		unsigned int const	cstat = `0`
	)		const

inline

Definition at line 4016 of file GeometryCore.h.

4020 { return NearestWire(worldLoc, geo::PlaneID(cstat, TPCNo, PlaneNo)); }

The data type to uniquely identify a Plane.

Definition: geo_types.h:472

geo::WireID::WireID_t NearestWire(geo::Point_t const &point, geo::PlaneID const &planeid) const

Returns the index of wire closest to position in the specified TPC.

Definition: GeometryCore.cxx:1230

unsigned int geo::GeometryCore::NearestWire	(	geo::Point_t const &	worldLoc,
		unsigned int const	PlaneNo,
		unsigned int const	TPCNo = `0`,
		unsigned int const	cstat = `0`
	)		const

inline

Definition at line 4021 of file GeometryCore.h.

4025 { return NearestWire(worldLoc, geo::PlaneID(cstat, TPCNo, PlaneNo)); }

The data type to uniquely identify a Plane.

Definition: geo_types.h:472

geo::WireID::WireID_t NearestWire(geo::Point_t const &point, geo::PlaneID const &planeid) const

Returns the index of wire closest to position in the specified TPC.

Definition: GeometryCore.cxx:1230

geo::WireID geo::GeometryCore::NearestWireID	(	geo::Point_t const &	point,
		geo::PlaneID const &	planeid
	)		const

Returns the ID of wire closest to position in the specified TPC.

Parameters

point	the point to be tested [cm]
planeid	ID of the plane

Returns: the ID of the wire, or an invalid wire ID

See Also: geo::PlaneGeo::ClosestWireID()

Bug:: Instead of returning an invalid wire ID, an exception is thrown!

If the nearest wire is not closer than half a wire pitch, the result is marked invalid. The returned (invalid) ID will contain the non-existing wire that would be the nearest, if it existed.

If the wire ID is invalid and the existing closest wire is desired, a possible solution is (when the BUG will be solved):

geo::WireID wireID = geom->NearestWireID(point, planeID);

if (!wireID) wireID = geom->Plane(planeID).ClosestWireID(wireID);

Note however that this will execute plane lookup twice, and a more efficient approach would be to ask the plane everything directly:

geo::PlaneGeo const& plane = geom->Plane(planeID);
geo::WireID wireID = plane.NearestWireID(point);
if (!wireID) wireID = plane.ClosestWireID(wireID);

Until the BUG is fixed, the actual working code is:

geo::PlaneGeo const& plane = geom->Plane(planeID);
geo::WireID wireID;
try {
  wireID = plane.NearestWireID(point);
}
catch (geo::InvalidWireError const& e) {
  if (!e.hasSuggestedWire()) throw;
  wireID = plane.ClosestWireID(e.suggestedWireID());
}

Definition at line 1255 of file GeometryCore.cxx.

   {
     return Plane(planeid).NearestWireID(worldPos);
   }

geo::WireID geo::GeometryCore::NearestWireID	(	const double	point[3],
		geo::PlaneID const &	planeid
	)		const

Returns the ID of wire closest to position in the specified TPC.

Parameters

point	the point to be tested [cm]
planeid	ID of the plane
PlaneNo	plane number within the TPC
TPCNo	tpc number within the cryostat
cstat	cryostat number

Returns: the ID of the wire, or an invalid wire ID

Bug:: Instead of returning an invalid wire ID, an exception is thrown!

The different versions allow different way to provide the position.

Deprecated:: Use the version with a geo::Point_t and PlaneID arguments

Todo:: remove the integers version

Definition at line 1272 of file GeometryCore.cxx.

   {
     return NearestWireID(geo::vect::makePointFromCoords(worldPos), planeid);
   }

geo::WireID geo::GeometryCore::NearestWireID	(	std::vector< double > const &	point,
		geo::PlaneID const &	planeid
	)		const

Definition at line 1262 of file GeometryCore.cxx.

   {
     if(worldPos.size() > 3) throw cet::exception("GeometryCore") << "bad size vector for "
                                                              << "worldPos: "
                                                              << worldPos.size() << "\n";
     return NearestWireID(worldPos.data(), planeid);
   }

geo::WireID geo::GeometryCore::NearestWireID	(	const TVector3 &	point,
		geo::PlaneID const &	planeid
	)		const

inline

Definition at line 3947 of file GeometryCore.h.

3948 { return NearestWireID(geo::vect::toPoint(point), planeid); }

::geo::Point_t toPoint(Point const &p)

Convert the specified point into a geo::Point_t.

Definition: geo_vectors_utils.h:1485

geo::WireID NearestWireID(geo::Point_t const &point, geo::PlaneID const &planeid) const

Returns the ID of wire closest to position in the specified TPC.

Definition: GeometryCore.cxx:1255

geo::WireID geo::GeometryCore::NearestWireID	(	const double	point[3],
		unsigned int const	PlaneNo,
		unsigned int const	TPCNo = `0`,
		unsigned int const	cstat = `0`
	)		const

inline

Definition at line 3949 of file GeometryCore.h.

3953 { return NearestWireID(point, geo::PlaneID(cstat, TPCNo, PlaneNo)); }

The data type to uniquely identify a Plane.

Definition: geo_types.h:472

geo::WireID NearestWireID(geo::Point_t const &point, geo::PlaneID const &planeid) const

Returns the ID of wire closest to position in the specified TPC.

Definition: GeometryCore.cxx:1255

geo::WireID geo::GeometryCore::NearestWireID	(	std::vector< double > const &	point,
		unsigned int const	PlaneNo,
		unsigned int const	TPCNo = `0`,
		unsigned int const	cstat = `0`
	)		const

inline

Definition at line 3954 of file GeometryCore.h.

3958 { return NearestWireID(point, geo::PlaneID(cstat, TPCNo, PlaneNo)); }

The data type to uniquely identify a Plane.

Definition: geo_types.h:472

geo::WireID NearestWireID(geo::Point_t const &point, geo::PlaneID const &planeid) const

Returns the ID of wire closest to position in the specified TPC.

Definition: GeometryCore.cxx:1255

geo::WireID geo::GeometryCore::NearestWireID	(	const TVector3 &	point,
		unsigned int const	PlaneNo,
		unsigned int const	TPCNo = `0`,
		unsigned int const	cstat = `0`
	)		const

inline

Definition at line 3959 of file GeometryCore.h.

3963 { return NearestWireID(point, geo::PlaneID(cstat, TPCNo, PlaneNo)); }

The data type to uniquely identify a Plane.

Definition: geo_types.h:472

geo::WireID NearestWireID(geo::Point_t const &point, geo::PlaneID const &planeid) const

Returns the ID of wire closest to position in the specified TPC.

Definition: GeometryCore.cxx:1255

geo::WireID geo::GeometryCore::NearestWireID	(	geo::Point_t const &	point,
		unsigned int const	PlaneNo,
		unsigned int const	TPCNo = `0`,
		unsigned int const	cstat = `0`
	)		const

inline

Definition at line 3964 of file GeometryCore.h.

3968 { return NearestWireID(point, geo::PlaneID(cstat, TPCNo, PlaneNo)); }

The data type to uniquely identify a Plane.

Definition: geo_types.h:472

geo::WireID NearestWireID(geo::Point_t const &point, geo::PlaneID const &planeid) const

Returns the ID of wire closest to position in the specified TPC.

Definition: GeometryCore.cxx:1255

unsigned int geo::GeometryCore::NElements ( ) const

inline

Definition at line 2003 of file GeometryCore.h.

2003 { return Ncryostats(); }

geo::GeometryCore::Nplanes

unsigned int Ncryostats() const

Returns the number of cryostats in the detector.

Definition: GeometryCore.h:2002

unsigned int geo::GeometryCore::NElements ( geo::CryostatID const & cryoid ) const

inline

Definition at line 2394 of file GeometryCore.h.

2395 { return NTPC(cryoid); }

geo::GeometryCore::NTPC

unsigned int NTPC(unsigned int cstat=0) const

Returns the total number of TPCs in the specified cryostat.

Definition: GeometryCore.h:2311

unsigned int geo::GeometryCore::NElements ( geo::TPCID const & tpcid ) const

inline

Definition at line 2930 of file GeometryCore.h.

2931 { return Nplanes(tpcid); }

unsigned int Nplanes(unsigned int tpc=0, unsigned int cstat=0) const

Returns the total number of wire planes in the specified TPC.

Definition: GeometryCore.h:2854

unsigned int geo::GeometryCore::NElements ( geo::PlaneID const & planeid ) const

inline

Definition at line 3364 of file GeometryCore.h.

3365 { return Nwires(planeid); }

geo::GeometryCore::Nwires

unsigned int Nwires(unsigned int p, unsigned int tpc=0, unsigned int cstat=0) const

Returns the total number of wires in the specified plane.

Definition: GeometryCore.h:3345

unsigned int geo::GeometryCore::NOpChannels ( ) const

Number of electronics channels for all the optical detectors.

Todo:: add explanation of the different IDs

Definition at line 253 of file GeometryCore.cxx.

   {
     return fChannelMapAlg->NOpChannels(this->NOpDets());
   }

unsigned int geo::GeometryCore::NOpDets ( ) const

Number of OpDets in the whole detector.

Definition at line 244 of file GeometryCore.cxx.

   {
     int N=0;
     for(size_t cstat=0; cstat!=Ncryostats(); cstat++)
       N += this->Cryostat(cstat).NOpDet();
     return N;
   }

unsigned int geo::GeometryCore::NOpHardwareChannels ( int opDet ) const

Definition at line 265 of file GeometryCore.cxx.

   {
     return fChannelMapAlg->NOpHardwareChannels(opDet);
   }

unsigned int geo::GeometryCore::Nplanes	(	unsigned int	tpc = `0`,
		unsigned int	cstat = `0`
	)		const

inline

Returns the total number of wire planes in the specified TPC.

Parameters

tpc	tpc number within the cryostat
cstat	cryostat number

Todo:

Make all the arguments mandatory (as TPCID)

Change return type to size_t

what happens if TPC does not exist?

Definition at line 2854 of file GeometryCore.h.

2855 { return Nplanes(geo::TPCID(cstat, tpc)); }

geo::GeometryCore::Nplanes

unsigned int Nplanes(unsigned int tpc=0, unsigned int cstat=0) const

Returns the total number of wire planes in the specified TPC.

Definition: GeometryCore.h:2854

The data type to uniquely identify a TPC.

Definition: geo_types.h:386

unsigned int geo::GeometryCore::Nplanes ( geo::TPCID const & tpcid ) const

inline

Returns the total number of planes in the specified TPC.

Parameters

tpcid TPC ID

Returns: number of planes in specified TPC, or 0 if no TPC found

The NElements() and NSiblingElements() methods are overloaded and their return depends on the type of ID.

Todo:: Change return type to size_t

Definition at line 2925 of file GeometryCore.h.

       {
         TPCGeo const* pTPC = GetElementPtr(tpcid);
         return pTPC? pTPC->NElements(): 0;
       }

unsigned int geo::GeometryCore::NROPs ( readout::TPCsetID const & tpcsetid ) const

Returns the total number of ROP in the specified TPC set.

Parameters

tpcsetid TPC set ID

Returns: number of readout planes in the TPC set, or 0 if no TPC set found

Note that this methods explicitly check the existence of the TPC set.

The NSiblingElements() method is overloaded and its return depends on the type of ID.

Definition at line 1805 of file GeometryCore.cxx.

                                                                         {
     return fChannelMapAlg->NROPs(tpcsetid);
   } // GeometryCore::NROPs()

unsigned int geo::GeometryCore::NSiblingElements ( geo::CryostatID const & ) const

inline

Definition at line 2004 of file GeometryCore.h.

2005 { return Ncryostats(); }

geo::GeometryCore::Nplanes

unsigned int Ncryostats() const

Returns the number of cryostats in the detector.

Definition: GeometryCore.h:2002

unsigned int geo::GeometryCore::NSiblingElements ( geo::TPCID const & tpcid ) const

inline

Definition at line 2396 of file GeometryCore.h.

2397 { return NTPC(tpcid); }

geo::GeometryCore::NTPC

unsigned int NTPC(unsigned int cstat=0) const

Returns the total number of TPCs in the specified cryostat.

Definition: GeometryCore.h:2311

unsigned int geo::GeometryCore::NSiblingElements ( geo::PlaneID const & planeid ) const

inline

Definition at line 2932 of file GeometryCore.h.

2933 { return Nplanes(planeid); }

unsigned int Nplanes(unsigned int tpc=0, unsigned int cstat=0) const

Returns the total number of wire planes in the specified TPC.

Definition: GeometryCore.h:2854

unsigned int geo::GeometryCore::NSiblingElements ( geo::WireID const & wireid ) const

inline

Definition at line 3366 of file GeometryCore.h.

3367 { return Nwires(wireid); }

geo::GeometryCore::Nwires

unsigned int Nwires(unsigned int p, unsigned int tpc=0, unsigned int cstat=0) const

Returns the total number of wires in the specified plane.

Definition: GeometryCore.h:3345

unsigned int geo::GeometryCore::NSiblingElements ( readout::TPCsetID const & tpcsetid ) const

inline

Definition at line 4879 of file GeometryCore.h.

4880 { return NTPCsets(tpcsetid); }

geo::GeometryCore::NTPCsets

unsigned int NTPCsets(readout::CryostatID const &cryoid) const

Returns the total number of TPC sets in the specified cryostat.

Definition: GeometryCore.cxx:1761

unsigned int geo::GeometryCore::NSiblingElements ( readout::ROPID const & ropid ) const

inline

Definition at line 5079 of file GeometryCore.h.

5080 { return NROPs(ropid); }

geo::GeometryCore::NROPs

unsigned int NROPs(readout::TPCsetID const &tpcsetid) const

Returns the total number of ROP in the specified TPC set.

Definition: GeometryCore.cxx:1805

unsigned int geo::GeometryCore::NTPC ( unsigned int cstat = 0 ) const

inline

Returns the total number of TPCs in the specified cryostat.

Parameters

cstat cryostat number

Todo:

Make the cryostat number mandatory (as CryostatID)

Change return type to size_t

what happens if it does not exist?

Definition at line 2311 of file GeometryCore.h.

2312 { return NTPC(geo::CryostatID(cstat)); }

geo::GeometryCore::NTPC

unsigned int NTPC(unsigned int cstat=0) const

Returns the total number of TPCs in the specified cryostat.

Definition: GeometryCore.h:2311

The data type to uniquely identify a cryostat.

Definition: geo_types.h:190

unsigned int geo::GeometryCore::NTPC ( geo::CryostatID const & cryoid ) const

inline

Returns the total number of TPCs in the specified cryostat.

Parameters

cryoid cryostat number

Returns: number of TPCs in specified cryostat, or 0 if no cryostat found

The NElements() and NSiblingElements() methods are overloaded and their return depends on the type of ID.

Todo:: Change return type to size_t

Definition at line 2389 of file GeometryCore.h.

       {
         CryostatGeo const* pCryo = GetElementPtr(cryoid);
         return pCryo? pCryo->NElements(): 0;
       }

unsigned int geo::GeometryCore::NTPCsets ( readout::CryostatID const & cryoid ) const

Returns the total number of TPC sets in the specified cryostat.

Parameters

cryoid cryostat ID

Returns: number of TPC sets in the cryostat, or 0 if no cryostat found

The NSiblingElements() method is overloaded and its return depends on the type of ID.

Definition at line 1761 of file GeometryCore.cxx.

                                                                            {
     return fChannelMapAlg->NTPCsets(cryoid);
   } // GeometryCore::NTPCsets()

unsigned int geo::GeometryCore::Nviews ( ) const

Returns the number of views (different wire orientations)

Returns the number of different views, or wire orientations, in the detector.

The function assumes that all TPCs in all cryostats of a detector have the same number of planes, which should be a safe assumption.

Todo:: Change return type to size_t

Definition at line 307 of file GeometryCore.cxx.

   {
     return MaxPlanes();
   }

unsigned int geo::GeometryCore::Nwires	(	unsigned int	p,
		unsigned int	tpc = `0`,
		unsigned int	cstat = `0`
	)		const

inline

Returns the total number of wires in the specified plane.

Parameters

p	plane number within the TPC
tpc	tpc number within the cryostat
cstat	cryostat number

Todo:

Make all the arguments mandatory (as PlaneID)

Change return type to size_t

what happens if it does not exist?

Definition at line 3345 of file GeometryCore.h.

3346 { return Nwires(geo::PlaneID(cstat, tpc, p)); }

p

pdgs p

Definition: selectors.fcl:22

geo::GeometryCore::Nwires

The data type to uniquely identify a Plane.

Definition: geo_types.h:472

unsigned int Nwires(unsigned int p, unsigned int tpc=0, unsigned int cstat=0) const

Returns the total number of wires in the specified plane.

Definition: GeometryCore.h:3345

unsigned int geo::GeometryCore::Nwires ( geo::PlaneID const & planeid ) const

inline

Returns the total number of wires in the specified plane.

Parameters

planeid plane ID

Returns: number of wires in specified plane, or 0 if no plane found

The NElements() and NSiblingElements() methods are overloaded and their return depends on the type of ID.

Todo:: Change return type to size_t

Definition at line 3359 of file GeometryCore.h.

       {
         PlaneGeo const* pPlane = GetElementPtr(planeid);
         return pPlane? pPlane->NElements(): 0;
       }

unsigned int geo::GeometryCore::OpChannel	(	int	detNum,
		int	hardwareChannel
	)		const

Convert detector number and hardware channel to unique channel.

Definition at line 271 of file GeometryCore.cxx.

   {
     return fChannelMapAlg->OpChannel(detNum, hardwareChannel);
   }

unsigned int geo::GeometryCore::OpDetFromCryo	(	unsigned int	o,
		unsigned int	c
	)		const

Get unique opdet number from cryo and internal count.

Definition at line 1877 of file GeometryCore.cxx.

   {
     static bool Loaded=false;
     static std::vector<unsigned int> LowestID;
     static unsigned int NCryo;
     // If not yet loaded static parameters, do it
     if(Loaded == false){
 
       Loaded = true;
 
       // Store the lowest ID for each cryostat
       NCryo=Ncryostats();
       LowestID.resize(NCryo + 1);
       LowestID.at(0)=0;
       for(size_t cryo=0; cryo!=NCryo; ++cryo){
         LowestID.at(cryo+1)=LowestID.at(cryo)+Cryostat(c).NOpDet();
       }
 
     }
 
     if( (c < NCryo) && (o < Cryostat(c).NOpDet())){
       return LowestID.at(c)+o;
     }
     else{
       throw cet::exception("OpDetCryoToOpID Error") << "Coordinates c=" << c
                                                     << ", o=" << o
                                                     << " out of range. Abort\n";
     }
 
     // if all is well, we never get to this point in the method
     // but still a good idea to be sure to always return something.
 
     return INT_MAX;
   }

unsigned int geo::GeometryCore::OpDetFromOpChannel ( int opChannel ) const

Convert unique channel to detector number.

Definition at line 277 of file GeometryCore.cxx.

   {
     return fChannelMapAlg->OpDetFromOpChannel(opChannel);
   }

const OpDetGeo & geo::GeometryCore::OpDetGeoFromOpChannel ( unsigned int OpChannel ) const

Returns the geo::OpDetGeo object for the given channel number.

Parameters

OpChannel optical detector unique channel number

See Also: GeometryCoreOpDetGeometry "optical detector identification"

Definition at line 1913 of file GeometryCore.cxx.

   {
     return this->OpDetGeoFromOpDet(this->OpDetFromOpChannel(OpChannel));
   }

const OpDetGeo & geo::GeometryCore::OpDetGeoFromOpDet ( unsigned int OpDet ) const

Returns the geo::OpDetGeo object for the given detector number.

Parameters

OpDet optical detector unique number

See Also: GeometryCoreOpDetGeometry "optical detector identification"

Definition at line 1919 of file GeometryCore.cxx.

   {
     static bool Loaded=false;
     static std::vector<unsigned int> LowestID;
     static size_t NCryo;
     // If not yet loaded static parameters, do it
     if(Loaded == false){
 
       Loaded = true;
 
       // Store the lowest ID for each cryostat
       NCryo=Ncryostats();
       LowestID.resize(NCryo + 1);
       LowestID[0] = 0;
       for(size_t cryo = 0; cryo != NCryo; ++cryo){
         LowestID[cryo+1] = LowestID[cryo] + Cryostat(cryo).NOpDet();
       }
 
     }
 
     for(size_t i=0; i!=NCryo; ++i){
       if( (OpDet >= LowestID[i]) && (OpDet < LowestID[i+1]) ){
         int c = i;
         int o = OpDet-LowestID[i];
         return this->Cryostat(c).OpDet(o);
       }
     }
     // If we made it here, we didn't find the right combination. abort
     throw cet::exception("OpID To OpDetCryo error")<<"OpID out of range, "<< OpDet << "\n";
 
     // Will not reach due to exception
     return this->Cryostat(0).OpDet(0);
   }

std::string geo::GeometryCore::OpDetGeoName ( unsigned int c = 0 ) const

Returns gdml string which gives sensitive opdet name.

Parameters

c	ID of the cryostat the detector is in

This name is defined in the geometry (GDML) description.

Todo:: Change to use CryostatID

Definition at line 1870 of file GeometryCore.cxx.

   {
     return Cryostat(c).OpDetGeoName();
   }

GeometryCore& geo::GeometryCore::operator= ( GeometryCore const & )

delete

GeometryCore& geo::GeometryCore::operator= ( GeometryCore && )

delete

PlaneGeo const& geo::GeometryCore::Plane	(	unsigned int const	p,
		unsigned int const	tpc = `0`,
		unsigned int const	cstat = `0`
	)		const

inline

Returns the specified wire.

Parameters

planeid	ID of the plane
p	plane number within the TPC
tpc	TPC number within the cryostat
cstat	number of cryostat

Returns: a constant reference to the specified plane

Exceptions

cet::exception	(`GeometryCore` category) if cryostat not present
cet::exception	(`TPCOutOfRange` category) if no such TPC
cet::exception	(`PlaneOutOfRange` category) if no such plane

The GetElement() method is overloaded and its return depends on the type of ID.

Todo:: remove the version with integers

Definition at line 3000 of file GeometryCore.h.

3002 { return Plane(geo::PlaneID(cstat, tpc, p)); }

geo::GeometryCore::Plane

PlaneGeo const & Plane(unsigned int const p, unsigned int const tpc=0, unsigned int const cstat=0) const

Returns the specified wire.

Definition: GeometryCore.h:3000

p

pdgs p

Definition: selectors.fcl:22

The data type to uniquely identify a Plane.

Definition: geo_types.h:472

PlaneGeo const& geo::GeometryCore::Plane ( geo::PlaneID const & planeid ) const

inline

Definition at line 3003 of file GeometryCore.h.

3004 { return TPC(planeid).Plane(planeid); }

geo::GeometryCore::PlaneWireToChannel

TPCGeo const & TPC(unsigned int const tpc=0, unsigned int const cstat=0) const

Returns the specified TPC.

Definition: GeometryCore.h:2431

geo::TPCGeo::Plane

PlaneGeo const & Plane(geo::View_t view) const

Return the plane in the tpc with View_t view.

Definition: TPCGeo.cxx:263

std::set< PlaneID > const & geo::GeometryCore::PlaneIDs ( ) const

Returns a list of possible PlaneIDs in the detector.

Returns: a constant reference to the set of plane IDs

Deprecated:: use IteratePlaneIDs() instead plane IDs of DUNE FD? probably better to use iterators instead

Definition at line 634 of file GeometryCore.cxx.

   {
     return fChannelMapAlg->PlaneIDs();
   }

double geo::GeometryCore::PlanePitch	(	geo::TPCID const &	tpcid,
		geo::PlaneID::PlaneID_t	p1 = `0`,
		geo::PlaneID::PlaneID_t	p2 = `1`
	)		const

Returns the distance between two planes.

Parameters

p1	index of the first plane
p2	index of the second plane
tpc	tpc number within the cryostat
cstat	cryostat number

Returns: distance between the planes

Todo:

add a version with plane IDs

deprecate this function

add a default version for a given TPCID

add a version with two plane indices for a given TPCID

return the absolute value of the distance (makes the order unimportant)

document what will happen (in the future methods) with planes on different TPCs

Definition at line 849 of file GeometryCore.cxx.

   {
     return TPC(tpcid).PlanePitch(p1, p2);
   }

double geo::GeometryCore::PlanePitch	(	geo::PlaneID const &	pid1,
		geo::PlaneID const &	pid2
	)		const

Definition at line 858 of file GeometryCore.cxx.

   {
     return PlanePitch(pid1.asTPCID(), pid1.Plane, pid2.Plane);
   }

double geo::GeometryCore::PlanePitch	(	unsigned int	p1 = `0`,
		unsigned int	p2 = `1`,
		unsigned int	tpc = `0`,
		unsigned int	cstat = `0`
	)		const

Definition at line 863 of file GeometryCore.cxx.

   {
     return PlanePitch(geo::TPCID(cstat, tpc), p1, p2);
   }

PlaneGeo const* geo::GeometryCore::PlanePtr ( geo::PlaneID const & planeid ) const

inline

Returns the specified plane.

Parameters

planeid plane ID

Returns: a constant pointer to the specified plane, or nullptr if none

The GetElementPtr() method is overloaded and its return depends on the type of ID.

Definition at line 3018 of file GeometryCore.h.

       {
         geo::TPCGeo const* pTPC = TPCPtr(planeid);
         return pTPC? pTPC->PlanePtr(planeid): nullptr;
       } // PlanePtr()

raw::ChannelID_t geo::GeometryCore::PlaneWireToChannel ( WireID const & wireid ) const

Returns the ID of the TPC channel connected to the specified wire.

Parameters

plane	the number of plane
wire	the number of wire
tpc	the number of TPC
cryostat	the number of cryostat
wireid	the ID of the wire

Returns: the ID of the channel, or raw::InvalidChannelID if invalid wire

Todo:

Verify the raw::InvalidChannelID part

remove the integers version

Definition at line 1315 of file GeometryCore.cxx.

   {
     return fChannelMapAlg->PlaneWireToChannel(wireid);
   }

raw::ChannelID_t geo::GeometryCore::PlaneWireToChannel	(	unsigned int const	plane,
		unsigned int const	wire,
		unsigned int const	tpc = `0`,
		unsigned int const	cstat = `0`
	)		const

inline

Definition at line 4737 of file GeometryCore.h.

4741 { return PlaneWireToChannel(geo::WireID(cstat, tpc, plane, wire)); }

geo::WireID

Definition: geo_types.h:560

raw::ChannelID_t PlaneWireToChannel(WireID const &wireid) const

Returns the ID of the TPC channel connected to the specified wire.

Definition: GeometryCore.cxx:1315

bool geo::GeometryCore::PointWithinSegments	(	double	A_start_x,
		double	A_start_y,
		double	A_end_x,
		double	A_end_y,
		double	B_start_x,
		double	B_start_y,
		double	B_end_x,
		double	B_end_y,
		double	x,
		double	y
	)

staticprivate

Returns whether x and y are within both specified ranges (A and B).

Definition at line 2002 of file GeometryCore.cxx.

     {
     return coordIs.withinSorted(x, A_start_x, A_end_x)
       && coordIs.withinSorted(y, A_start_y, A_end_y)
       && coordIs.withinSorted(x, B_start_x, B_end_x)
       && coordIs.withinSorted(y, B_start_y, B_end_y)
       ;
 
   } // GeometryCore::PointWithinSegments()

const AuxDetGeo & geo::GeometryCore::PositionToAuxDet	(	geo::Point_t const &	point,
		unsigned int &	ad,
		double	tolerance = `0`
	)		const

Returns the auxiliary detector at specified location.

Parameters

point	location to be tested
ad	_(output)_ the auxiliary detector index
tolerance	tolerance (cm) for matches. Default 0.

Returns: constant reference to AuxDetGeo object of the auxiliary detector

Todo:: what happens if it does not exist?

Definition at line 532 of file GeometryCore.cxx.

   {
     // locate the desired Auxiliary Detector
     ad = FindAuxDetAtPosition(point, tolerance);
     return AuxDet(ad);
   }

const AuxDetGeo & geo::GeometryCore::PositionToAuxDet	(	double const	worldLoc[3],
		unsigned int &	ad,
		double	tolerance = `0`
	)		const

Returns the auxiliary detector at specified location.

Parameters

worldLoc	3D coordinates of the point (world reference frame)
ad	(output) the auxiliary detector index
tolerance	tolerance (cm) for matches. Default 0.

Returns: constant reference to AuxDetGeo object of the auxiliary detector

Deprecated:: Use the version with geo::Point_t.

Todo:: what happens if it does not exist?

Definition at line 541 of file GeometryCore.cxx.

542 { return PositionToAuxDet(geo::vect::makePointFromCoords(worldLoc), ad, tolerance); }

geo::GeometryCore::PositionToAuxDet

auto const tolerance

Definition: OpFlashAlg_test.cc:11

AuxDetGeo const & PositionToAuxDet(geo::Point_t const &point, unsigned int &ad, double tolerance=0) const

Returns the auxiliary detector at specified location.

Definition: GeometryCore.cxx:532

GENVECTOR_CONSTEXPR::geo::Point_t makePointFromCoords(Coords &&coords)

Creates a geo::Point_t from its coordinates (see makeFromCoords()).

Definition: geo_vectors_utils.h:1511

const AuxDetSensitiveGeo & geo::GeometryCore::PositionToAuxDetSensitive	(	geo::Point_t const &	point,
		size_t &	ad,
		size_t &	sv,
		double	tolerance = `0`
	)		const

Returns the auxiliary detector at specified location.

Parameters

point	location to be tested
ad	_(output)_ the auxiliary detector index
sv	_(output)_ the auxiliary detector sensitive volume index
tolerance	tolerance (cm) for matches. Default 0.

Returns: reference to AuxDetSensitiveGeo object of the auxiliary detector

Todo:: what happens if it does not exist?

Definition at line 563 of file GeometryCore.cxx.

   {
     // locate the desired Auxiliary Detector
     FindAuxDetSensitiveAtPosition(point, ad, sv, tolerance);
     return AuxDet(ad).SensitiveVolume(sv);
   }

const AuxDetSensitiveGeo & geo::GeometryCore::PositionToAuxDetSensitive	(	double const	worldLoc[3],
		size_t &	ad,
		size_t &	sv,
		double	tolerance = `0`
	)		const

Returns the auxiliary detector at specified location.

Parameters

worldLoc	3D coordinates of the point (world reference frame)
ad	(output) the auxiliary detector index
sv	(output) the auxiliary detector sensitive volume index
tolerance	tolerance (cm) for matches. Default 0.

Returns: reference to AuxDetSensitiveGeo object of the auxiliary detector

Todo:: what happens if it does not exist?

Deprecated:: Use the version with geo::Point_t.

Definition at line 572 of file GeometryCore.cxx.

573 { return PositionToAuxDetSensitive(geo::vect::makePointFromCoords(worldLoc), ad, sv, tolerance); }

geo::GeometryCore::PositionToAuxDetSensitive

auto const tolerance

Definition: OpFlashAlg_test.cc:11

const AuxDetSensitiveGeo & PositionToAuxDetSensitive(geo::Point_t const &point, size_t &ad, size_t &sv, double tolerance=0) const

Returns the auxiliary detector at specified location.

Definition: GeometryCore.cxx:563

geo::GeometryCore::PositionToCryostat

GENVECTOR_CONSTEXPR::geo::Point_t makePointFromCoords(Coords &&coords)

Creates a geo::Point_t from its coordinates (see makeFromCoords()).

Definition: geo_vectors_utils.h:1511

geo::CryostatGeo const & geo::GeometryCore::PositionToCryostat ( geo::Point_t const & point ) const

Returns the cryostat at specified location.

Parameters

point the location [cm]

Returns: a constant reference to the geo::CryostatGeo containing point

Exceptions

cet::exception ("Geometry" category) if no cryostat matches

The tolerance used here is the one returned by DefaultWiggle().

Definition at line 481 of file GeometryCore.cxx.

   {
     geo::CryostatGeo const* cstat = PositionToCryostatPtr(point);
     if (!cstat) {
       throw cet::exception("GeometryCore")
         << "Can't find any cryostat at position " << point << "\n";
     }
     return *cstat;
   } // GeometryCore::PositionToCryostat()

CryostatGeo const& geo::GeometryCore::PositionToCryostat ( double const point[3] ) const

inline

Definition at line 2105 of file GeometryCore.h.

2106 { return PositionToCryostat(geo::vect::makePointFromCoords(point)); }

CryostatGeo const & PositionToCryostat(geo::Point_t const &point) const

Returns the cryostat at specified location.

Definition: GeometryCore.cxx:481

geo::GeometryCore::PositionToTPC

GENVECTOR_CONSTEXPR::geo::Point_t makePointFromCoords(Coords &&coords)

Creates a geo::Point_t from its coordinates (see makeFromCoords()).

Definition: geo_vectors_utils.h:1511

const CryostatGeo & geo::GeometryCore::PositionToCryostat	(	double const	worldLoc[3],
		geo::CryostatID &	cid
	)		const

Returns the cryostat at specified location.

Parameters

worldLoc	3D coordinates of the point (world reference frame)
cid	(output) cryostat ID

Returns: a constant reference to the CryostatGeo object of the cryostat

Exceptions

cet::exception ("Geometry" category) if no cryostat matches

The tolerance used here is the one returned by DefaultWiggle().

Deprecated:: Use PositionToCryostat(geo::Point_t const&) instead.

Definition at line 494 of file GeometryCore.cxx.

   {
     geo::CryostatID::CryostatID_t cstat = FindCryostatAtPosition(worldLoc);
 
     if(cstat == geo::CryostatID::InvalidID)
       throw cet::exception("GeometryCore") << "Can't find Cryostat for position ("
                                        << worldLoc[0] << ","
                                        << worldLoc[1] << ","
                                        << worldLoc[2] << ")\n";
     cid = geo::CryostatID(cstat);
     return Cryostat(cid);
   } // GeometryCore::PositionToCryostat(double[3], CryostatID)

const CryostatGeo & geo::GeometryCore::PositionToCryostat	(	double const	worldLoc[3],
		unsigned int &	cstat
	)		const

Returns the cryostat at specified location.

Parameters

worldLoc	3D coordinates of the point (world reference frame)
cstat	(output) number of cryostat

Returns: a constant reference to the CryostatGeo object of the cryostat

Exceptions

cet::exception ("Geometry" category) if no cryostat matches

The tolerance used here is the one returned by DefaultWiggle().

Deprecated:: Use PositionToCryostat(geo::Point_t const&) instead.

Definition at line 508 of file GeometryCore.cxx.

   {
     geo::CryostatID cid;
     geo::CryostatGeo const& cryo = PositionToCryostat(worldLoc, cid);
     cstat = cid.Cryostat;
     return cryo;
   } // GeometryCore::PositionToCryostat(double[3], unsigned int)

geo::CryostatID geo::GeometryCore::PositionToCryostatID ( geo::Point_t const & point ) const

Returns the ID of the cryostat at specified location.

Parameters

point the location [cm]

Returns: ID of the cryostat including point (invalid if none)

The tolerance used here is the one returned by DefaultWiggle().

Definition at line 384 of file GeometryCore.cxx.

   {
     geo::CryostatGeo const* cryo = PositionToCryostatPtr(point);
     return cryo? cryo->ID(): geo::CryostatID{};
   } // GeometryCore::PositionToCryostatID()

geo::CryostatGeo const * geo::GeometryCore::PositionToCryostatPtr ( geo::Point_t const & point ) const

Returns the cryostat at specified location.

Parameters

point the location [cm]

Returns: pointer to the geo::CryostatGeo including point, or nullptr

The tolerance used here is the one returned by DefaultWiggle().

Definition at line 372 of file GeometryCore.cxx.

   {
     for (geo::CryostatGeo const& cryostat: IterateCryostats()) {
       if (cryostat.ContainsPosition(point, 1.0 + fPositionWiggle))
         return &cryostat;
     }
     return nullptr;
   } // GeometryCore::PositionToCryostatPtr()

geo::TPCGeo const & geo::GeometryCore::PositionToTPC ( geo::Point_t const & point ) const

Returns the TPC at specified location.

Parameters

point the location [cm]

Returns: a constant reference to the geo::TPCGeo including point

Exceptions

cet::exception ("Geometry" category) if no TPC matches

Definition at line 419 of file GeometryCore.cxx.

   {
     geo::TPCGeo const* tpc = PositionToTPCptr(point);
     if (!tpc) {
       throw cet::exception("GeometryCore")
         << "Can't find any TPC at position " << point << "\n";
     }
     return *tpc;
   } // GeometryCore::PositionToTPC()

TPCGeo const& geo::GeometryCore::PositionToTPC ( double const point[3] ) const

inline

Definition at line 2492 of file GeometryCore.h.

2493 { return PositionToTPC(geo::vect::makePointFromCoords(point)); }

geo::TPCGeo const & PositionToTPC(geo::Point_t const &point) const

Returns the TPC at specified location.

Definition: GeometryCore.cxx:419

geo::GeometryCore::fROOTfile

GENVECTOR_CONSTEXPR::geo::Point_t makePointFromCoords(Coords &&coords)

Creates a geo::Point_t from its coordinates (see makeFromCoords()).

Definition: geo_vectors_utils.h:1511

TPCGeo const & geo::GeometryCore::PositionToTPC	(	double const	worldLoc[3],
		unsigned int &	tpc,
		unsigned int &	cstat
	)		const

Returns the TPC at specified location.

Parameters

point	the location [cm]
tpc	_(output)_ where to store the number of TPC
cstat	_(output)_ where to store the number of cryostat

Returns: a constant reference to the geo::TPCGeo including point

Exceptions

cet::exception ("Geometry" category) if no TPC matches

Deprecated:: Use PositionToTPCID() or PositionToTPC().ID()

Definition at line 442 of file GeometryCore.cxx.

   {
     geo::TPCGeo const& TPC = PositionToTPC(worldLoc);
     cstat = TPC.ID().Cryostat;
     tpc = TPC.ID().TPC;
     return TPC;
   } // GeometryCore::PositionToTPC(double*, TPCID&)

TPCGeo const & geo::GeometryCore::PositionToTPC	(	double const	worldLoc[3],
		TPCID &	tpcid
	)		const

Returns the TPC at specified location.

Parameters

point	the location [cm]
tpcid	_(output)_ where to store the TPC ID

Returns: a constant reference to the geo::TPCGeo including point

Exceptions

cet::exception ("Geometry" category) if no TPC matches

Deprecated:: Use PositionToTPCID() or PositionToTPC().ID()

Definition at line 432 of file GeometryCore.cxx.

   {
     geo::TPCGeo const& TPC = PositionToTPC(worldLoc);
     tpcid = TPC.ID();
     return TPC;
   } // GeometryCore::PositionToTPC(double*, TPCID&)

geo::TPCID geo::GeometryCore::PositionToTPCID ( geo::Point_t const & point ) const

Returns the ID of the TPC at specified location.

Parameters

point the location [cm]

Returns: ID of the TPC at specified location, invalid if none

See Also: PositionToTPC()

Definition at line 452 of file GeometryCore.cxx.

                                                                       {
     geo::TPCGeo const* tpc = PositionToTPCptr(point);
     return tpc? tpc->ID(): geo::TPCID{};
   } // GeometryCore::PositionToTPCID()

geo::TPCGeo const * geo::GeometryCore::PositionToTPCptr ( geo::Point_t const & point ) const

Returns the TPC at specified location.

Parameters

point the location [cm]

Returns: the geo::TPCGeo including point, or nullptr if none

Definition at line 410 of file GeometryCore.cxx.

   {
     geo::CryostatGeo const* cryo = PositionToCryostatPtr(point);
     return cryo? cryo->PositionToTPCptr(point, 1. + fPositionWiggle): nullptr;
   } // GeometryCore::PositionToTPCptr()

template<typename Stream >

void geo::GeometryCore::Print	(	Stream &&	out,
		std::string	indent = `" "`
	)		const

Prints geometry information with maximum verbosity.

Definition at line 5703 of file GeometryCore.h.

 {
 
   out << "Detector " << DetectorName() << " has "
     << Ncryostats() << " cryostats and "
     << NAuxDets() << " auxiliary detectors:";
 
   auto const& detEnclosureBox = DetectorEnclosureBox();
   out << "\n" << indent << "Detector enclosure: "
     << detEnclosureBox.Min() << " -- " << detEnclosureBox.Max()
     << " cm => ( " << detEnclosureBox.SizeX() << " x "
     << detEnclosureBox.SizeY() << " x "
     << detEnclosureBox.SizeZ() << " ) cm^3"
     ;
 
   for (geo::CryostatGeo const& cryostat: IterateCryostats()) {
     out << "\n" << indent;
     cryostat.PrintCryostatInfo
       (std::forward<Stream>(out), indent + "  ", cryostat.MaxVerbosity);
 
     const unsigned int nTPCs = cryostat.NTPC();
     for(unsigned int t = 0;  t < nTPCs; ++t) {
       const geo::TPCGeo& tpc = cryostat.TPC(t);
 
       out << "\n" << indent << "  ";
       tpc.PrintTPCInfo
         (std::forward<Stream>(out), indent + "    ", tpc.MaxVerbosity);
 
       const unsigned int nPlanes = tpc.Nplanes();
       for(unsigned int p = 0; p < nPlanes; ++p) {
         const geo::PlaneGeo& plane = tpc.Plane(p);
         const unsigned int nWires = plane.Nwires();
 
         out << "\n" << indent << "    ";
         plane.PrintPlaneInfo
           (std::forward<Stream>(out), indent + "      ", plane.MaxVerbosity);
         geo::SigType_t const sigType = SignalType(plane.ID());
         out << "\n" << indent << "      "
           << "signal type: " << SignalTypeName(sigType)
           << " (" << static_cast<int>(sigType) << ")";
 
         for(unsigned int w = 0;  w < nWires; ++w) {
           const geo::WireGeo& wire = plane.Wire(w);
           geo::WireID wireID(plane.ID(), w);
 
           // the wire should be aligned on z axis, half on each side of 0,
           // in its local frame
           out << "\n" << indent << "      " << wireID << " ";
           wire.PrintWireInfo
             (std::forward<Stream>(out), indent + "      ", wire.MaxVerbosity);
         } // for wire
       } // for plane
     } // for TPC
 
     unsigned int nOpDets = cryostat.NOpDet();
     for (unsigned int iOpDet = 0; iOpDet < nOpDets; ++iOpDet) {
       geo::OpDetGeo const& opDet = cryostat.OpDet(iOpDet);
       out << "\n" << indent << "  [OpDet #" << iOpDet << "] ";
       opDet.PrintOpDetInfo
         (std::forward<Stream>(out), indent + "  ", opDet.MaxVerbosity);
     } // for
   } // for cryostat
 
   unsigned int const nAuxDets = NAuxDets();
   for (unsigned int iDet = 0; iDet < nAuxDets; ++iDet) {
     geo::AuxDetGeo const& auxDet = AuxDet(iDet);
 
     out << "\n" << indent << "[#" << iDet << "] ";
     auxDet.PrintAuxDetInfo
       (std::forward<Stream>(out), indent + "  ", auxDet.MaxVerbosity);
 
     unsigned int const nSensitive = auxDet.NSensitiveVolume();
     switch (nSensitive) {
       case 0: break;
       case 1: {
         geo::AuxDetSensitiveGeo const& auxDetS = auxDet.SensitiveVolume(0U);
         out << "\n" << indent << "  ";
         auxDetS.PrintAuxDetInfo
           (std::forward<Stream>(out), indent + "    ", auxDetS.MaxVerbosity);
         break;
       }
       default:
         for (unsigned int iSens = 0; iSens < nSensitive; ++iSens) {
           out << "\n" << indent << "[#" << iSens << "] ";
           geo::AuxDetSensitiveGeo const& auxDetS
             = auxDet.SensitiveVolume(iSens);
           auxDetS.PrintAuxDetInfo
             (std::forward<Stream>(out), indent + "    ", auxDetS.MaxVerbosity);
         } // for
         break;
     } // if sensitive detectors
 
   } // for auxiliary detector
 
   out << '\n';
 
 } // geo::GeometryCore::Print()

std::string geo::GeometryCore::ROOTFile ( ) const

inline

Returns the full directory path to the geometry file source.

Returns: the full directory path to the geometry file source

This is the full path of the source of the detector geometry GeometryCore relies on.

Definition at line 1748 of file GeometryCore.h.

1748 { return fROOTfile; }

std::string fROOTfile

path to geometry file for geometry in GeometryCore

Definition: GeometryCore.h:5513

TGeoManager * geo::GeometryCore::ROOTGeoManager ( ) const

Access to the ROOT geometry description manager.

Definition at line 202 of file GeometryCore.cxx.

   {
     return gGeoManager;
   }

std::vector< geo::TPCID > geo::GeometryCore::ROPtoTPCs ( readout::ROPID const & ropid ) const

Returns a list of ID of TPCs the specified ROP spans.

Parameters

ropid ID of the readout plane

Returns: the list of TPC IDs, empty if readout plane ID is invalid

Note that this check is performed on the validity of the readout plane ID, that does not necessarily imply that the readout plane specified by the ID actually exists. Check if the ROP exists with HasROP(). The behaviour on non-existing readout planes is undefined.

Definition at line 1839 of file GeometryCore.cxx.

   {
     return fChannelMapAlg->ROPtoTPCs(ropid);
   } // GeometryCore::ROPtoTPCs()

std::vector< geo::PlaneID > geo::GeometryCore::ROPtoWirePlanes ( readout::ROPID const & ropid ) const

Returns a list of ID of planes belonging to the specified ROP.

Parameters

ropid ID of the readout plane

Returns: list of ID of wire planes belonging to the specified ROP

If ropid is an invalid ID, an empty list is returned. If ropid is a valid ID (i.e. an ID whose isValid flag is set) that points to a non-existent readout plane, the result is undefined. Use HasROP() to check if the readout plane actually exists.

Definition at line 1831 of file GeometryCore.cxx.

   {
     return fChannelMapAlg->ROPtoWirePlanes(ropid);
   } // GeometryCore::ROPtoWirePlanes()

void geo::GeometryCore::SetDetectorName ( std::string const & new_name )

inlineprotected

Sets the detector name.

Definition at line 5488 of file GeometryCore.h.

5488 { fDetectorName = new_name; }

geo::GeometryCore::fDetectorName

std::string fDetectorName

Name of the detector.

Definition: GeometryCore.h:5511

SigType_t geo::GeometryCore::SignalType ( geo::PlaneID const & pid ) const

Returns the type of signal on the channels of specified TPC plane.

Parameters

plane TPC plane ID

Returns: the type of signal on the specified plane, or geo::kMysteryType

Assumes that all the channels on the plane have the same signal type.

Todo:: verify that kMysteryType is returned on invalid plane

Definition at line 599 of file GeometryCore.cxx.

   {
     // map wire plane -> readout plane -> first channel,
     // then use SignalType(channel)
 
     auto const ropid = WirePlaneToROP(pid);
     if (!ropid.isValid) {
       throw cet::exception("GeometryCore")
         << "SignalType(): Mapping of wire plane " << std::string(pid)
         << " to readout plane failed!\n";
     }
     return SignalType(ropid);
 
   } // GeometryCore::SignalType(PlaneID)

SigType_t geo::GeometryCore::SignalType ( raw::ChannelID_t const channel ) const

Returns the type of signal on the specified TPC channel.

Parameters

channel TPC channel ID

Returns: the type of signal on the specified channel, or geo::kMysteryType

Todo:: verify that kMysteryType is returned on invalid channel

Definition at line 593 of file GeometryCore.cxx.

   {
     return fChannelMapAlg->SignalTypeForChannel(channel);
   }

geo::SigType_t geo::GeometryCore::SignalType ( readout::ROPID const & ropid ) const

Returns the type of signal of channels in specified readout plane.

Parameters

ropid readout plane ID

Returns: the type of signal on the specified ROP

Assumes that all the channels on the readout plane have the same signal type. If ropid is an invalid ID, geo::kMysteryType is returned. If ropid is a valid ID (i.e. an ID whose isValid flag is set) that points to a non-existent readout plane, the result is undefined. Use HasROP() to check if the readout plane actually exists.

Definition at line 1860 of file GeometryCore.cxx.

                                                                        {
     return fChannelMapAlg->SignalTypeForROPID(ropid);
   } // GeometryCore::SignalType(ROPID)

void geo::GeometryCore::SortGeometry ( geo::GeoObjectSorter const & sorter )

private

Runs the sorting of geometry with the sorter provided by channel mapping.

Definition at line 168 of file GeometryCore.cxx.

   {
     mf::LogInfo("GeometryCore") << "Sorting volumes...";
 
     sorter.SortAuxDets(AuxDets());
     sorter.SortCryostats(Cryostats());
 
     geo::CryostatID::CryostatID_t c = 0;
     for (geo::CryostatGeo& cryo: Cryostats())
     {
       cryo.SortSubVolumes(sorter);
       cryo.UpdateAfterSorting(geo::CryostatID(c));
       ++c;
     } // for
 
   } // GeometryCore::SortGeometry()

geo::Length_t geo::GeometryCore::SurfaceY ( ) const

inline

The position of the detector respect to earth surface.

Returns: typical y position at surface in units of cm

This is the depth (y) of the surface (where earth meets air) for this detector site. The number is expressed in world coordinates and in centimetres, and it represents the y coordinate of earth surface. A negative value means that the origin of coordinates, typically matching the detector centre, is above surface.

Todo:: check that this is actually how it is used

Definition at line 1820 of file GeometryCore.h.

1820 { return fSurfaceY; }

geo::GeometryCore::fSurfaceY

double fSurfaceY

The point where air meets earth for this detector.

Definition: GeometryCore.h:5510

geo::PlaneID geo::GeometryCore::ThirdPlane	(	geo::PlaneID const &	pid1,
		geo::PlaneID const &	pid2
	)		const

Returns the plane that is not in the specified arguments.

Parameters

pid1	a plane
pid2	another plane

Returns: the ID to the third plane

Exceptions

cet::exception	(category: "GeometryCore") if other than 3 planes
cet::exception	(category: "GeometryCore") if pid1 and pid2 match

This function requires a geometry with exactly three planes. If the two input planes are not on the same TPC, the result is undefined.

Definition at line 1571 of file GeometryCore.cxx.

   {
     // how many planes in the TPC pid1 belongs to:
     const unsigned int nPlanes = Nplanes(pid1);
     if(nPlanes != 3) {
       throw cet::exception("GeometryCore")
         << "ThirdPlane() supports only TPCs with 3 planes, and I see "
         << nPlanes << " instead\n";
     }
 
     geo::PlaneID::PlaneID_t target_plane = nPlanes;
     for (geo::PlaneID::PlaneID_t iPlane = 0; iPlane < nPlanes; ++iPlane){
       if ((iPlane == pid1.Plane) || (iPlane == pid2.Plane)) continue;
       if (target_plane != nPlanes) {
         throw cet::exception("GeometryCore")
           << "ThirdPlane() found too many planes that are not "
           << std::string(pid1) << " nor " << std::string(pid2)
           << "! (first " << target_plane << ", then " << iPlane << ")\n";
       } // if we had a target already
       target_plane = iPlane;
     } // for
     if (target_plane == nPlanes) {
       throw cet::exception("GeometryCore")
         << "ThirdPlane() can't find a plane that is not " << std::string(pid1)
         << " nor " << std::string(pid2) << "!\n";
     }
 
     return geo::PlaneID(pid1, target_plane);
   } // GeometryCore::ThirdPlane()

double geo::GeometryCore::ThirdPlane_dTdW	(	geo::PlaneID const &	pid1,
		double	slope1,
		geo::PlaneID const &	pid2,
		double	slope2,
		geo::PlaneID const &	output_plane
	)		const

Returns dT/dW on the third plane, given it in the other two.

Parameters

pid1	ID of the plane of the first dT/dW
dTdW1	dT/dW as seen on the first plane
pid2	ID of the plane of the second dT/dW
dTdW2	dT/dW as seen on the second plane
output_plane	ID of the plane on which to calculate the slope

Returns: dT/dW on the third plane, or -999. if dT/dW would be infinity

Exceptions

cet::exception	(category: "GeometryCore") if different TPC
cet::exception	(category: "GeometryCore") if same plane
cet::exception	(category: "GeometryCore") if other than 3 planes

Given a dT/dW as projected in two planes, returns the dT/dW as projected in the third plane. The dT/dW are defined in time ticks/wide number units.

Definition at line 1648 of file GeometryCore.cxx.

           {
 
     CheckIndependentPlanesOnSameTPC(pid1, pid2, "ThirdPlane_dTdW()");
 
     geo::TPCGeo const& TPC = this->TPC(pid1);
 
     double angle[3], pitch[3];
     geo::PlaneGeo const* const planes[3]
       = { &TPC.Plane(pid1), &TPC.Plane(pid2), &TPC.Plane(output_plane) };
 
     // We need wire pitch and "wire coordinate direction" for each plane.
     // The latter is perpendicular to the wire orientation.
     // PlaneGeo::PhiZ() defines the right orientation too.
     for (size_t i = 0; i < 3; ++i) {
       angle[i] = planes[i]->PhiZ();
       pitch[i] = planes[i]->WirePitch();
     } // for
 
     return ComputeThirdPlane_dTdW(
       angle[0], pitch[0], slope1,
       angle[1], pitch[1], slope2,
       angle[2], pitch[2]
       );
 
   } // GeometryCore::ThirdPlane_dTdW()

double geo::GeometryCore::ThirdPlane_dTdW	(	geo::PlaneID const &	pid1,
		double	slope1,
		geo::PlaneID const &	pid2,
		double	slope2
	)		const

Returns dT/dW on the third plane, given it in the other two.

Parameters

pid1	ID of the plane of the first dT/dW
dTdW1	dT/dW as seen on the first plane
pid2	ID of the plane of the second dT/dW
dTdW2	dT/dW as seen on the second plane

Returns: dT/dW on the third plane, or -999. if dT/dW would be infinity

Exceptions

cet::exception	(category: "GeometryCore") if different TPC
cet::exception	(category: "GeometryCore") if same plane
cet::exception	(category: "GeometryCore") if other than 3 planes

Given a dT/dW as projected in two planes, returns the dT/dW as projected in the third plane. This function is a shortcut assuming exactly three wire planes in the TPC, in which case the output plane is chosen as the one that is neither of the input planes.

Definition at line 1679 of file GeometryCore.cxx.

           {
     geo::PlaneID target_plane = ThirdPlane(pid1, pid2);
     return ThirdPlane_dTdW(pid1, slope1, pid2, slope2, target_plane);
   } // ThirdPlane_dTdW()

double geo::GeometryCore::ThirdPlaneSlope	(	geo::PlaneID const &	pid1,
		double	slope1,
		geo::PlaneID const &	pid2,
		double	slope2,
		geo::PlaneID const &	output_plane
	)		const

Returns the slope on the third plane, given it in the other two.

Parameters

pid1	ID of the plane of the first slope
slope1	slope as seen on the first plane
pid2	ID of the plane of the second slope
slope2	slope as seen on the second plane
output_plane	ID of the plane on which to calculate the slope

Returns: the slope on the third plane, or -999. if slope would be infinity

Exceptions

cet::exception	(category: "GeometryCore") if different TPC
cet::exception	(category: "GeometryCore") if input planes match

Given a slope as projected in two planes, returns the slope as projected in the specified output plane. The slopes are defined in uniform units; they should be computed as distance ratios (or tangent of a geometrical angle; the formula is still valid using dt/dw directly in case of equal wire pitch in all planes and uniform drift velocity.

Definition at line 1618 of file GeometryCore.cxx.

           {
 
     CheckIndependentPlanesOnSameTPC(pid1, pid2, "ThirdPlaneSlope()");
 
     geo::TPCGeo const& TPC = this->TPC(pid1);
 
     // We need the "wire coordinate direction" for each plane.
     // This is perpendicular to the wire orientation.
     // PlaneGeo::PhiZ() defines the right orientation too.
     return ComputeThirdPlaneSlope(
       TPC.Plane(pid1).PhiZ(), slope1,
       TPC.Plane(pid2).PhiZ(), slope2,
       TPC.Plane(output_plane).PhiZ()
       );
   } // ThirdPlaneSlope()

double geo::GeometryCore::ThirdPlaneSlope	(	geo::PlaneID const &	pid1,
		double	slope1,
		geo::PlaneID const &	pid2,
		double	slope2
	)		const

Returns the slope on the third plane, given it in the other two.

Parameters

pid1	ID of the plane of the first slope
slope1	slope as seen on the first plane
pid2	ID of the plane of the second slope
slope2	slope as seen on the second plane

Returns: the slope on the third plane, or -999. if slope would be infinity

Exceptions

cet::exception	(category: "GeometryCore") if different TPC
cet::exception	(category: "GeometryCore") if same plane
cet::exception	(category: "GeometryCore") if other than 3 planes

Given a slope as projected in two planes, returns the slope as projected in the third plane. This function is a shortcut assuming exactly three wire planes in the TPC, in which case the output plane is chosen as the one that is neither of the input planes.

Definition at line 1639 of file GeometryCore.cxx.

           {
     geo::PlaneID target_plane = ThirdPlane(pid1, pid2);
     return ThirdPlaneSlope(pid1, slope1, pid2, slope2, target_plane);
   } // ThirdPlaneSlope()

double geo::GeometryCore::ThirdPlaneSlope	(	geo::PlaneID::PlaneID_t	plane1,
		double	slope1,
		geo::PlaneID::PlaneID_t	plane2,
		double	slope2,
		geo::TPCID const &	tpcid
	)		const

inline

Returns the slope on the third plane, given it in the other two.

Parameters

plane1	index of the plane of the first slope
slope1	slope as seen on the first plane
plane2	index of the plane of the second slope
slope2	slope as seen on the second plane
tpcid	TPC where the two planes belong

Returns: the slope on the third plane, or -999. if slope would be infinity

Exceptions

cet::exception	(category: "GeometryCore") if different TPC
cet::exception	(category: "GeometryCore") if same plane
cet::exception	(category: "GeometryCore") if other than 3 planes

Given a slope as projected in two planes, returns the slope as projected in the third plane.

Definition at line 4348 of file GeometryCore.h.

       {
         return ThirdPlaneSlope(
           geo::PlaneID(tpcid, plane1), slope1,
           geo::PlaneID(tpcid, plane2), slope2
           );
       }

double geo::GeometryCore::ThirdPlaneSlope	(	unsigned int	plane1,
		double	slope1,
		unsigned int	plane2,
		double	slope2,
		unsigned int	tpc,
		unsigned int	cstat
	)		const

inline

Definition at line 4357 of file GeometryCore.h.

       {
         return ThirdPlaneSlope
           (plane1, slope1, plane2, slope2, geo::TPCID(cstat, tpc));
       }

double geo::GeometryCore::TotalMass ( ) const

inline

Returns the total mass [kg] of the specified volume (default: world).

Definition at line 1899 of file GeometryCore.h.

1899 { return TotalMass(GetWorldVolumeName()); }

geo::GeometryCore::GetWorldVolumeName

const std::string GetWorldVolumeName() const

Return the name of the world volume (needed by Geant4 simulation)

Definition: GeometryCore.cxx:640

geo::GeometryCore::TotalMass

double TotalMass() const

Returns the total mass [kg] of the specified volume (default: world).

Definition: GeometryCore.h:1899

double geo::GeometryCore::TotalMass ( std::string vol ) const

Definition at line 1131 of file GeometryCore.cxx.

   {
     //the TGeoNode::GetVolume() returns the TGeoVolume of the detector outline
     //and ROOT calculates the mass in kg for you
     TGeoVolume *gvol = gGeoManager->FindVolumeFast(vol.c_str());
     if(gvol) return gvol->Weight();
 
     throw cet::exception("GeometryCore") << "could not find specified volume '"
                                          << vol
                                          << " 'to determine total mass\n";
   }

unsigned int geo::GeometryCore::TotalNTPC ( ) const

Returns the total number of TPCs in the detector.

Definition at line 917 of file GeometryCore.cxx.

                                              {
     // it looks like C++11 lambdas have made STL algorithms easier to use,
     // but only so much:
     return std::accumulate(Cryostats().begin(), Cryostats().end(), 0U,
       [](unsigned int sum, geo::CryostatGeo const& cryo)
         { return sum + cryo.NTPC(); }
       );
   } // GeometryCore::TotalNTPC()

TPCGeo const& geo::GeometryCore::TPC	(	unsigned int const	tpc = `0`,
		unsigned int const	cstat = `0`
	)		const

inline

Returns the specified TPC.

Parameters

tpcid	ID of the tpc
tpc	tpc number within the cryostat
cstat	number of cryostat

Returns: a constant reference to the specified TPC

Exceptions

cet::exception	(`GeometryCore` category) if cryostat not present
cet::exception	(`TPCOutOfRange` category) if no such TPC

The GetElement() method is overloaded and its return depends on the type of ID.

Todo:: remove the version with integers

Definition at line 2431 of file GeometryCore.h.

2432 { return TPC(geo::TPCID(cstat, tpc)); }

The data type to uniquely identify a TPC.

Definition: geo_types.h:386

geo::GeometryCore::Cryostat

TPCGeo const & TPC(unsigned int const tpc=0, unsigned int const cstat=0) const

Returns the specified TPC.

Definition: GeometryCore.h:2431

TPCGeo const& geo::GeometryCore::TPC ( geo::TPCID const & tpcid ) const

inline

Definition at line 2433 of file GeometryCore.h.

2434 { return Cryostat(tpcid).TPC(tpcid); }

CryostatGeo const & Cryostat(geo::CryostatID const &cryoid) const

Returns the specified cryostat.

Definition: GeometryCore.cxx:321

geo::CryostatGeo::TPC

const TPCGeo & TPC(unsigned int itpc) const

Return the itpc'th TPC in the cryostat.

Definition: CryostatGeo.cxx:93

TPCGeo const* geo::GeometryCore::TPCPtr ( geo::TPCID const & tpcid ) const

inline

Returns the specified TPC.

Parameters

tpcid TPC ID

Returns: a constant pointer to the specified TPC, or nullptr if none

The GetElementPtr() method is overloaded and its return depends on the type of ID.

Definition at line 2448 of file GeometryCore.h.

       {
         CryostatGeo const* pCryo = CryostatPtr(tpcid);
         return pCryo? pCryo->TPCPtr(tpcid): nullptr;
       } // TPCPtr()

std::vector< geo::TPCID > geo::GeometryCore::TPCsetToTPCs ( readout::TPCsetID const & tpcsetid ) const

Returns a list of ID of TPCs belonging to the specified TPC set.

Parameters

tpcsetid ID of the TPC set to convert into TPC IDs

Returns: the list of TPCs, empty if TPC set is invalid

Note that the check is performed on the validity of the TPC set ID, that does not necessarily imply that the TPC set specified by the ID actually exists. Check the existence of the TPC set first (HasTPCset()). Behaviour on valid, non-existent TPC set IDs is undefined.

Definition at line 1795 of file GeometryCore.cxx.

   {
     return fChannelMapAlg->TPCsetToTPCs(tpcsetid);
   } // GeometryCore::TPCsetToTPCs()

readout::TPCsetID geo::GeometryCore::TPCtoTPCset ( geo::TPCID const & tpcid ) const

Returns the ID of the TPC set tpcid belongs to.

Definition at line 1787 of file GeometryCore.cxx.

   {
     return fChannelMapAlg->TPCtoTPCset(tpcid);
   } // GeometryCore::TPCtoTPCset()

void geo::GeometryCore::UpdateAfterSorting ( )

private

Performs all the updates needed after sorting.

Definition at line 187 of file GeometryCore.cxx.

                                         {
 
     for (size_t c = 0; c < Ncryostats(); ++c)
       Cryostats()[c].UpdateAfterSorting(geo::CryostatID(c));
 
     allViews.clear();
     for (geo::TPCGeo const& tpc: IterateTPCs()) {
       auto const& TPCviews = tpc.Views();
       allViews.insert(TPCviews.cbegin(), TPCviews.cend());
     }
 
   } // GeometryCore::UpdateAfterSorting()

bool geo::GeometryCore::ValueInRange	(	double	value,
		double	min,
		double	max
	)		const

Returns whether a value is within the specified range.

Parameters

value	the value to be tested
min	the lower boundary
max	the upper boundary

Returns: whether the value is within range

If min is larger than max, they are swapped. A tolerance of 10^-6 (absolute) is used.

Todo:

Use wiggle instead of 10^-6

resort source code for a bit of speed up

Definition at line 1323 of file GeometryCore.cxx.

   {
     if(min>max) std::swap(min,max);//protect against funny business due to wire angles
     if (std::abs(value-min)<1e-6||std::abs(value-max)<1e-6) return true;
     return (value>=min) && (value<=max);
   }

View_t geo::GeometryCore::View ( geo::PlaneID const & pid ) const

Returns the view (wire orientation) on the channels of specified TPC plane.

Parameters

plane TPC plane ID

Returns: the type of signal on the specified plane, or geo::kUnknown

Definition at line 622 of file GeometryCore.cxx.

   {
     return pid? Plane(pid).View(): geo::kUnknown;
   }

View_t geo::GeometryCore::View ( raw::ChannelID_t const channel ) const

Returns the view (wire orientation) on the specified TPC channel.

Parameters

channel TPC channel ID

Returns: the type of signal on the specified channel, or geo::kUnknown

The view of the readout plane channel belongs to is returned, as in View(readout::ROPID const&) const.

Definition at line 616 of file GeometryCore.cxx.

                                                               {
     return (channel == raw::InvalidChannelID)
       ? geo::kUnknown: View(ChannelToROP(channel));
   } // GeometryCore::View()

geo::View_t geo::GeometryCore::View ( readout::ROPID const & ropid ) const

Returns the view of the channels in the specified readout plane.

Parameters

ropid readout plane ID

Returns: the type of signal on the specified ROP

Returns the view (wire orientation) on the channels of specified readout plane. If ropid is an invalid ID, geo::kUnknown is returned. If ropid is a valid ID (i.e. an ID whose isValid flag is set) that points to a non-existent readout plane, the result is undefined. Use HasROP() to check if the readout plane actually exists.

Definition at line 1854 of file GeometryCore.cxx.

                                                               {
     return View(fChannelMapAlg->FirstWirePlaneInROP(ropid));
   } // GeometryCore::View()

std::set<geo::View_t> const& geo::GeometryCore::Views ( ) const

inline

Returns a list of possible views in the detector.

Returns: the set of views

Definition at line 4706 of file GeometryCore.h.

4706 { return allViews; }

geo::GeometryCore::allViews

std::set< geo::View_t > allViews

All views in the detector.

Definition: GeometryCore.h:5525

std::string geo::GeometryCore::VolumeName ( geo::Point_t const & point ) const

Returns the name of the deepest volume containing specified point.

Parameters

point the location to query, in world coordinates

Returns: name of the volume containing the point

Todo:

what happens if none?

Unify the coordinates type

Definition at line 1029 of file GeometryCore.cxx.

   {
     // check that the given point is in the World volume at least
     TGeoVolume const*volWorld = WorldVolume();
     double halflength = ((TGeoBBox*)volWorld->GetShape())->GetDZ();
     double halfheight = ((TGeoBBox*)volWorld->GetShape())->GetDY();
     double halfwidth  = ((TGeoBBox*)volWorld->GetShape())->GetDX();
     if(std::abs(point.x()) > halfwidth  ||
        std::abs(point.y()) > halfheight ||
        std::abs(point.z()) > halflength
        ){
       mf::LogWarning("GeometryCoreBadInputPoint") << "point (" << point.x() << ","
                                               << point.y() << "," << point.z() << ") "
                                               << "is not inside the world volume "
                                               << " half width = " << halfwidth
                                               << " half height = " << halfheight
                                               << " half length = " << halflength
                                               << " returning unknown volume name";
       const std::string unknown("unknownVolume");
       return unknown;
     }
 
     return gGeoManager->FindNode(point.X(), point.Y(), point.Z())->GetName();
   }

std::string geo::GeometryCore::VolumeName ( TVector3 const & point ) const

inline

Definition at line 1850 of file GeometryCore.h.

1851 { return VolumeName(geo::vect::toPoint(point)); }

geo::GeometryCore::VolumeName

::geo::Point_t toPoint(Point const &p)

Convert the specified point into a geo::Point_t.

Definition: geo_vectors_utils.h:1485

std::string VolumeName(geo::Point_t const &point) const

Returns the name of the deepest volume containing specified point.

Definition: GeometryCore.cxx:1029

WireGeo const& geo::GeometryCore::Wire ( geo::WireID const & wireid ) const

inline

Returns the specified wire.

Parameters

wireid ID of the wire

Returns: a constant reference to the specified wire

Exceptions

cet::exception if not found

The GetElement() method is overloaded and its return depends on the type of ID.

Definition at line 3422 of file GeometryCore.h.

3423 { return Plane(wireid).Wire(wireid); }

geo::GeometryCore::Plane

PlaneGeo const & Plane(unsigned int const p, unsigned int const tpc=0, unsigned int const cstat=0) const

Returns the specified wire.

Definition: GeometryCore.h:3000

geo::PlaneGeo::Wire

WireGeo const & Wire(unsigned int iwire) const

Definition: PlaneGeo.cxx:506

double geo::GeometryCore::WireAngleToVertical	(	geo::View_t	view,
		geo::TPCID const &	tpcid
	)		const

Returns the angle of the wires in the specified view from vertical.

Parameters

view	the view
TPC	the index of the TPC in the specified cryostat
Cryo	the cryostat
tpcid	ID of the TPC

Returns: the angle [radians]

Exceptions

cet::exception ("GeometryCore" category) if no such view

The angle is defined as in WireGeo::ThetaZ().

This method assumes all wires in the view have the same angle (it queries for the first).

Deprecated:: This does not feel APA-ready

Definition at line 892 of file GeometryCore.cxx.

   {
     // loop over the planes in cryostat 0, tpc 0 to find the plane with the
     // specified view
     geo::TPCGeo const& TPC = this->TPC(tpcid);
     for (unsigned int p = 0; p < TPC.Nplanes(); ++p) {
       geo::PlaneGeo const& plane = TPC.Plane(p);
       if (plane.View() == view) return plane.ThetaZ();
     } // for
     throw cet::exception("GeometryCore") << "WireAngleToVertical(): no view \""
       << geo::PlaneGeo::ViewName(view) << "\" (#" << ((int) view)
       << ") in " << std::string(tpcid);
   } // GeometryCore::WireAngleToVertical()

double geo::GeometryCore::WireAngleToVertical	(	geo::View_t	view,
		int	TPC = `0`,
		int	Cryo = `0`
	)		const

inline

Definition at line 3801 of file GeometryCore.h.

3802 { return WireAngleToVertical(view, geo::TPCID(Cryo, TPC)); }

The data type to uniquely identify a TPC.

Definition: geo_types.h:386

geo::GeometryCore::WireAngleToVertical

TPCGeo const & TPC(unsigned int const tpc=0, unsigned int const cstat=0) const

Returns the specified TPC.

Definition: GeometryCore.h:2431

double WireAngleToVertical(geo::View_t view, geo::TPCID const &tpcid) const

Returns the angle of the wires in the specified view from vertical.

Definition: GeometryCore.cxx:892

geo::Length_t geo::GeometryCore::WireCoordinate	(	double	YPos,
		double	ZPos,
		geo::PlaneID const &	planeid
	)		const

Returns the index of the nearest wire to the specified position.

Parameters

YPos	y coordinate on the wire plane
ZPos	z coordinate on the wire plane
planeid	ID of the plane

Returns: an index interpolation between the two nearest wires

Deprecated:: Use WireCoordinate(geo::Point_t const&, geo::PlaneID const&) instead

Respect to NearestWireID(), this method returns a real number, representing a continuous coordinate in the wire axis, with the round values corresponding to the actual wires.

Todo:: Unify (y, z) coordinate

Definition at line 1217 of file GeometryCore.cxx.

   {
     return fChannelMapAlg->WireCoordinate(YPos, ZPos, planeid);
   }

geo::Length_t geo::GeometryCore::WireCoordinate	(	double	YPos,
		double	ZPos,
		unsigned int	PlaneNo,
		unsigned int	TPCNo,
		unsigned int	cstat
	)		const

inline

Returns the index of the nearest wire to the specified position.

Parameters

YPos	y coordinate on the wire plane
ZPos	z coordinate on the wire plane
PlaneNo	number of plane
TPCNo	number of TPC
cstat	number of cryostat

Returns: an index interpolation between the two nearest wires

See Also: ChannelMapAlg::WireCoordinate()

Deprecated:: Use the version with plane ID instead

Definition at line 4060 of file GeometryCore.h.

4064 { return WireCoordinate(YPos, ZPos, geo::PlaneID(cstat, TPCNo, PlaneNo)); }

geo::GeometryCore::WireCoordinate

geo::Length_t WireCoordinate(double YPos, double ZPos, geo::PlaneID const &planeid) const

Returns the index of the nearest wire to the specified position.

Definition: GeometryCore.cxx:1217

geo::GeometryCore::WireCoordinate

The data type to uniquely identify a Plane.

Definition: geo_types.h:472

geo::Length_t geo::GeometryCore::WireCoordinate	(	geo::Point_t const &	pos,
		geo::PlaneID const &	planeid
	)		const

Returns the index of the nearest wire to the specified position.

Parameters

pos	world coordinates of the position (it will be projected)
planeid	ID of the plane

Returns: an index interpolation between the two nearest wires

See Also: ChannelMapAlg::WireCoordinate()

Respect to NearestWireID(), this method returns a real number, representing a continuous coordinate in the wire axis, with the round values corresponding to the actual wires.

Definition at line 1210 of file GeometryCore.cxx.

   {
     return Plane(planeid).WireCoordinate(pos);
   }

geo::Length_t geo::GeometryCore::WireCoordinate	(	TVector3 const &	pos,
		geo::PlaneID const &	planeid
	)		const

inline

Definition at line 4081 of file GeometryCore.h.

4082 { return WireCoordinate(geo::vect::toPoint(pos), planeid); }

geo::Length_t WireCoordinate(double YPos, double ZPos, geo::PlaneID const &planeid) const

Returns the index of the nearest wire to the specified position.

Definition: GeometryCore.cxx:1217

geo::GeometryCore::WireEndPoints

::geo::Point_t toPoint(Point const &p)

Convert the specified point into a geo::Point_t.

Definition: geo_vectors_utils.h:1485

void geo::GeometryCore::WireEndPoints	(	geo::WireID const &	wireid,
		double *	xyzStart,
		double *	xyzEnd
	)		const

Fills two arrays with the coordinates of the wire end points.

Parameters

wireid	ID of the wire
xyzStart	(output) an array with the start coordinate
xyzEnd	(output) an array with the end coordinate

Exceptions

cet::exception wire not present

The starting point is the wire end with lower z coordinate.

Deprecated:: use the wire ID interface instead (but note that it does not sort the ends)

Definition at line 1332 of file GeometryCore.cxx.

   {
     Segment_t result = WireEndPoints(wireid);
 
     xyzStart[0] = result.start().X();
     xyzStart[1] = result.start().Y();
     xyzStart[2] = result.start().Z();
     xyzEnd[0]   = result.end().X();
     xyzEnd[1]   = result.end().Y();
     xyzEnd[2]   = result.end().Z();
 
     if(xyzEnd[2]<xyzStart[2]){
       //ensure that "End" has higher z-value than "Start"
       std::swap(xyzStart[0],xyzEnd[0]);
       std::swap(xyzStart[1],xyzEnd[1]);
       std::swap(xyzStart[2],xyzEnd[2]);
     }
     if(xyzEnd[1]<xyzStart[1] && std::abs(xyzEnd[2]-xyzStart[2])<0.01){
       // if wire is vertical ensure that "End" has higher y-value than "Start"
       std::swap(xyzStart[0],xyzEnd[0]);
       std::swap(xyzStart[1],xyzEnd[1]);
       std::swap(xyzStart[2],xyzEnd[2]);
     }
 
   } // GeometryCore::WireEndPoints(WireID, 2x double*)

void geo::GeometryCore::WireEndPoints	(	unsigned int	cstat,
		unsigned int	tpc,
		unsigned int	plane,
		unsigned int	wire,
		double *	xyzStart,
		double *	xyzEnd
	)		const

inline

Fills two arrays with the coordinates of the wire end points.

Parameters

cstat	cryostat number
tpc	tpc number within the cryostat
plane	plane number within the TPC
wire	wire number within the plane
xyzStart	(output) an array with the start coordinate
xyzEnd	(output) an array with the end coordinate

Exceptions

cet::exception wire not present

The starting point is the wire end with lower z coordinate.

Deprecated:: use the wire ID interface instead (but note that it does not sort the ends)

Definition at line 3855 of file GeometryCore.h.

3859 { WireEndPoints(geo::WireID(cstat, tpc, plane, wire), xyzStart, xyzEnd); }

geo::WireID

Definition: geo_types.h:560

void WireEndPoints(geo::WireID const &wireid, double *xyzStart, double *xyzEnd) const

Fills two arrays with the coordinates of the wire end points.

Definition: GeometryCore.cxx:1332

template<typename Point >

Segment<Point> geo::GeometryCore::WireEndPoints ( geo::WireID const & wireID ) const

Returns a segment whose ends are the wire end points.

Parameters

wireid ID of the wire

Returns: a segment whose ends are the wire end points

Exceptions

cet::exception wire not present

The start and end are assigned as returned from the geo::WireGeo object. The rules for this assignment are documented in that class.

Deprecated:: use the wire ID interface instead (but note that it does not sort the ends)

geo::GeometryCore::Segment< Point > geo::GeometryCore::WireEndPoints ( geo::WireID const & wireID ) const

inline

Definition at line 3876 of file GeometryCore.h.

3877 { return WireEndPoints<DefaultPoint_t>(wireID); }

bool geo::GeometryCore::WireIDIntersectionCheck	(	const geo::WireID &	wid1,
		const geo::WireID &	wid2
	)		const

private

Wire ID check for WireIDsIntersect methods.

Definition at line 1973 of file GeometryCore.cxx.

   {
     if (wid1.asTPCID() != wid2) {
       mf::LogError("WireIDIntersectionCheck")
         << "Comparing two wires on different TPCs: return failure.";
       return false;
     }
     if (wid1.Plane == wid2.Plane) {
       mf::LogError("WireIDIntersectionCheck")
         << "Comparing two wires in the same plane: return failure";
       return false;
     }
     if (!HasWire(wid1)) {
       mf::LogError("WireIDIntersectionCheck")
         << "1st wire " << wid1 << " does not exist (max wire number: "
         << Nwires(wid1.planeID()) << ")";
       return false;
     }
     if (!HasWire(wid2)) {
       mf::LogError("WireIDIntersectionCheck")
         << "2nd wire " << wid2 << " does not exist (max wire number: "
         << Nwires(wid2.planeID()) << ")";
       return false;
     }
     return true;
   } // GeometryCore::WireIDIntersectionCheck()

bool geo::GeometryCore::WireIDsIntersect	(	WireID const &	wid1,
		WireID const &	wid2,
		geo::Point_t &	intersection
	)		const

Computes the intersection between two wires.

Parameters

	wid1	ID of the first wire
	wid2	ID of the other wire
[out]	intersection	the intersection point (global coordinates)

Returns: whether an intersection was found inside the TPC the wires belong

See Also: geo::WiresIntersection(), geo::LineClosestPoint()

The wires identified by wid1 and wid2 are intersected, and the 3D intersection point is written into the intersection parameter. The "intersection" point is actually the point belonging to the first wire (wid2) which is the closest (in Euclidean 3D metric) to the second wire.

The intersection is computed only if the wires belong to different planes of the same TPC. If that is not the case (i.e. they belong to different TPC or cryostat, or if they belong to the same plane), false is returned and intersection is set with all components to infinity (std::numeric_limits<>::infinity()).

When the intersection is computed, it is always stored in the intersection output parameter. Return value is true if this intersection lies within the physical boundaries first wire, while it is instead false if it lies on the extrapolation of the wire direction, but not within the wire physical extension.

To test that the result is not infinity (nor NaN), use geo::vect::isfinite(intersection) etc.

Note: If geo::WireGeo objects are already available, using instead the free function geo::WiresIntersection() or the method geo::WireGeo::IntersectionWith() is faster (and recommended). For purely geometric intersection, geo::LineClosestPoint() is also available.

Definition at line 1512 of file GeometryCore.cxx.

   {
     //
     // This is not a real 3D intersection: the wires do not cross, since they
     // are required to belong to two different planes.
     //
     // After Christopher Backhouse suggestion, we take the point on the first
     // wire which is closest to the other one.
     //
     //
     static_assert(
       std::numeric_limits<decltype(intersection.X())>::has_infinity,
       "the vector coordinate type can't represent infinity!"
       );
     constexpr auto infinity
       = std::numeric_limits<decltype(intersection.X())>::infinity();
 
     if (!WireIDIntersectionCheck(wid1, wid2)) {
       intersection = { infinity, infinity, infinity };
       return false;
     }
 
     geo::WireGeo const& wire1 = Wire(wid1);
     geo::WireGeo const& wire2 = Wire(wid2);
 
     // distance of the intersection point from the center of the two wires:
     geo::IntersectionPointAndOffsets<geo::Point_t> intersectionAndOffset
       = geo::WiresIntersectionAndOffsets(wire1, wire2);
     intersection = intersectionAndOffset.point;
     
     bool const within = (
       (std::abs(intersectionAndOffset.offset1) <= wire1.HalfL())
       && (std::abs(intersectionAndOffset.offset2) <= wire2.HalfL())
       );
 
     // return whether the intersection is within the length of both wires
     return within;
 
   } // GeometryCore::WireIDsIntersect(Point3D_t)

bool geo::GeometryCore::WireIDsIntersect	(	WireID const &	wid1,
		WireID const &	wid2,
		TVector3 &	intersection
	)		const

Definition at line 1559 of file GeometryCore.cxx.

   {
     geo::Point_t p;
     bool res = WireIDsIntersect(wid1, wid2, p);
     intersection = geo::vect::toTVector3(p);
     return res;
   } // GeometryCore::WireIDsIntersect(TVector3)

bool geo::GeometryCore::WireIDsIntersect	(	WireID const &	wid1,
		WireID const &	wid2,
		geo::WireIDIntersection &	widIntersect
	)		const

Computes the intersection between two wires.

Parameters

wid1	ID of the first wire
wid2	ID of the other wire
widIntersect	(output) the coordinate of the intersection point

Returns: whether an intersection was found within the TPC

The "intersection" refers to the projection of the wires into the same $ x = 0 $ plane. Wires are assumed to have at most one intersection. If wires are parallel, widIntersect will have the two components set to infinity (std::numeric_limits<>::infinity()) and the TPC number set to invalid (geo::TPCID::InvalidID). Also, false is returned. If the intersection is outside the TPC, false is also returned, but the widIntersect will contain the coordinates of that intersection. The TPC number is still set to invalid, although the intersection might belong to a valid TPC somewhere else.

Deprecated:: This method uses arbitrary assumptions and should not be used. Use the interface returning a full vector instead.

Definition at line 1463 of file GeometryCore.cxx.

           {
 
     static_assert(
       std::numeric_limits<decltype(widIntersect.y)>::has_infinity,
       "the vector coordinate type can't represent infinity!"
       );
     constexpr auto infinity
       = std::numeric_limits<decltype(widIntersect.y)>::infinity();
 
     if (!WireIDIntersectionCheck(wid1, wid2)) {
       widIntersect.y = widIntersect.z = infinity;
       widIntersect.TPC = geo::TPCID::InvalidID;
       return false;
     }
 
     // get the endpoints to see if wires intersect
     Segment_t const w1 = WireEndPoints(wid1);
     Segment_t const w2 = WireEndPoints(wid2);
 
     // TODO extract the coordinates in the right way;
     // is it any worth, since then the result is in (y, z), whatever it means?
     bool const cross = IntersectLines(
       w1.start()[1], w1.start()[2], w1.end()[1], w1.end()[2],
       w2.start()[1], w2.start()[2], w2.end()[1], w2.end()[2],
       widIntersect.y, widIntersect.z
       );
     if (!cross) {
       widIntersect.y = widIntersect.z = infinity;
       widIntersect.TPC = geo::TPCID::InvalidID;
       return false;
     }
     bool const within = PointWithinSegments(
       w1.start()[1], w1.start()[2], w1.end()[1], w1.end()[2],
       w2.start()[1], w2.start()[2], w2.end()[1], w2.end()[2],
       widIntersect.y, widIntersect.z
       );
 
     widIntersect.TPC = (within? wid1.TPC: geo::TPCID::InvalidID);
 
     // return whether the intersection is within the length of both wires
     return within;
 
   } // GeometryCore::WireIDsIntersect(WireIDIntersection)

WireGeo const& geo::GeometryCore::WireIDToWireGeo ( geo::WireID const & wireid ) const

inline

Definition at line 3424 of file GeometryCore.h.

3425 { return Wire(wireid); }

geo::GeometryCore::Wire

WireGeo const & Wire(geo::WireID const &wireid) const

Returns the specified wire.

Definition: GeometryCore.h:3422

geo::Length_t geo::GeometryCore::WirePitch ( geo::PlaneID const & planeid ) const

Returns the distance between two consecutive wires.

Parameters

p	plane number within the TPC
tpc	tpc number within the cryostat
cstat	cryostat number

Returns: the distance between the two wires

Note: The current geometry assumptions imply that wire pitch is constant between all wires on the same wire plane. This is an assumption non-trivial to remove.

Todo:

add a version with wire IDs

deprecate this function

document what will happen (in the future methods) with wires on different planes

Definition at line 873 of file GeometryCore.cxx.

   {
     return Plane(planeid).WirePitch();
   }

geo::Length_t geo::GeometryCore::WirePitch	(	unsigned int	plane = `0`,
		unsigned int	tpc = `0`,
		unsigned int	cstat = `0`
	)		const

inline

Definition at line 3762 of file GeometryCore.h.

3765 { return WirePitch(geo::PlaneID(cstat, tpc, plane)); }