geo::CryostatGeo Class Reference

bool HasTPC(unsigned int itpc) const

Returns whether a TPC with index itpc is present in this cryostat.

Definition: CryostatGeo.h:190

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

inline

Alias for HasTPC(geo::TPCID const&)

Definition at line 205 of file CryostatGeo.h.

205 { return HasTPC(tpcid); }

bool HasTPC(unsigned int itpc) const

Returns whether a TPC with index itpc is present in this cryostat.

Definition: CryostatGeo.h:190

bool geo::CryostatGeo::HasTPC ( unsigned int itpc ) const

inline

Returns whether a TPC with index itpc is present in this cryostat.

Parameters

itpc	index of TPC in this cryostat

Returns: whether the TPC with index itpc is present in this cryostat

Definition at line 190 of file CryostatGeo.h.

190 { return itpc < NTPC(); }

geo::CryostatGeo::NTPC

unsigned int NTPC() const

Number of TPCs in this cryostat.

Definition: CryostatGeo.h:181

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

inline

Returns whether the TPC in tpcid is present in this cryostat.

Parameters

tpcid full TPC ID

Returns: whether the TPC in tpcid is present in this cryostat

The cryostat number in tpcid is ignored, as it is ignored whether tpcid is invalid.

Definition at line 203 of file CryostatGeo.h.

203 { return HasTPC(tpcid.TPC); }

geo::CryostatGeo::HalfHeight

bool HasTPC(unsigned int itpc) const

Returns whether a TPC with index itpc is present in this cryostat.

Definition: CryostatGeo.h:190

double geo::CryostatGeo::Height ( ) const

inline

Full height of the cryostat [cm].

Definition at line 105 of file CryostatGeo.h.

105 { return 2. * HalfHeight(); }

double HalfHeight() const

Half height of the cryostat [cm].

Definition: CryostatGeo.cxx:196

geo::CryostatID const& geo::CryostatGeo::ID ( ) const

inline

Returns the identifier of this cryostat.

Definition at line 132 of file CryostatGeo.h.

132 { return fID; }

geo::CryostatGeo::fID

geo::CryostatID fID

ID of this cryostat.

Definition: CryostatGeo.h:479

void geo::CryostatGeo::InitCryoBoundaries ( )

private

Fill the boundary information of the cryostat.

Definition at line 258 of file CryostatGeo.cxx.

                                        {
 
     // check that this is indeed a box
     if (!dynamic_cast<TGeoBBox*>(Volume()->GetShape())) {
       // at initialisation time we don't know yet our real ID
       throw cet::exception("CryostatGeo") << "Cryostat is not a box! (it is a "
         << Volume()->GetShape()->IsA()->GetName() << ")\n";
     }
 
     // get the half width, height, etc of the cryostat
     const double halflength = HalfLength();
     const double halfwidth  = HalfWidth();
     const double halfheight = HalfHeight();
 
     SetBoundaries(
       toWorldCoords(LocalPoint_t{ -halfwidth, -halfheight, -halflength }),
       toWorldCoords(LocalPoint_t{ +halfwidth, +halfheight, +halflength })
       );
 
   } // CryostatGeo::InitCryoBoundaries()

auto geo::CryostatGeo::IterateElements ( ) const

Returns an object suitable for iterating through all TPCs.

See Also: IterateTPCs()

The returned value can be used in a range-for loop like:

for (geo::TPCGeo const& tpc: cryo.IterateElements()) { ... }

The resulting sequence exposes the TPCs within the cryostat in their ID order, from TPC 0 to NTPC() - 1.

This method is designed for templated code, where the object obj.IterateElements() may be a geo::CryostatGeo or some other one. For non-template code, prefer IterateTPCs() for clarity.

Definition at line 119 of file CryostatGeo.cxx.

120 { return fTPCs; }

geo::CryostatGeo::IterateElements

TPCList_t fTPCs

List of tpcs in this cryostat.

Definition: CryostatGeo.h:475

ElementIteratorBox geo::CryostatGeo::IterateTPCs ( ) const

inline

Returns an object suitable for iterating through all TPCs.

See Also: IterateElements()

The returned value can be used in a range-for loop like:

for (geo::TPCGeo const& tpc: cryo.IterateTPCs()) { ... }

The resulting sequence exposes the TPCs within the cryostat in their ID order, from TPC 0 to NTPC() - 1.

A version of this functionality designed for template code is provided under the generic name IterateElements().

Definition at line 258 of file CryostatGeo.h.

258 { return IterateElements(); }

ElementIteratorBox IterateElements() const

Returns an object suitable for iterating through all TPCs.

Definition: CryostatGeo.cxx:119

double geo::CryostatGeo::Length ( ) const

inline

Length of the cryostat [cm].

Definition at line 107 of file CryostatGeo.h.

107 { return 2. * HalfLength(); }

geo::CryostatGeo::HalfLength

double HalfLength() const

Half height of the cryostat [cm].

Definition: CryostatGeo.cxx:202

void geo::CryostatGeo::LocalToWorld	(	const double *	cryo,
		double *	world
	)		const

inline

Transform point from local cryostat frame to world frame.

Definition at line 387 of file CryostatGeo.h.

388 { fTrans.LocalToWorld(cryo, world); }

geo::LocalTransformation::LocalToWorld

void LocalToWorld(double const *local, double *world) const

Transforms a point from local frame to world frame.

geo::LocalTransformation::LocalToWorld

LocalTransformation_t fTrans

Cryostat-to-world transformation.

Definition: CryostatGeo.h:474

template<typename Point >

Point geo::CryostatGeo::LocalToWorld ( Point const & local ) const

inline

Transform point from local cryostat frame to world frame.

Deprecated:: This method breaks the distinction between local and global vectors, since input and output vectors share the same type; use the "official" vector types geo::Point_t, geo::CryostatGeo::LocalPoint_t, geo::Vector_t and geo::CryostatGeo::LocalVector_t, and then use the method geo::CryostatGeo::toWorldCoords() instead.

Definition at line 399 of file CryostatGeo.h.

400 { return fTrans.LocalToWorld(local); }

void LocalToWorld(double const *local, double *world) const

Transforms a point from local frame to world frame.

local

then local

Definition: make_xml_premcc1.0.sh:85

geo::LocalTransformation::LocalToWorldVect

LocalTransformation_t fTrans

Cryostat-to-world transformation.

Definition: CryostatGeo.h:474

void geo::CryostatGeo::LocalToWorldVect	(	const double *	cryo,
		double *	world
	)		const

inline

Transform direction vector from local to world.

Definition at line 407 of file CryostatGeo.h.

408 { fTrans.LocalToWorldVect(cryo, world); }

void LocalToWorldVect(double const *local, double *world) const

Transforms a vector from local frame to world frame.

geo::CryostatGeo::fVolume

LocalTransformation_t fTrans

Cryostat-to-world transformation.

Definition: CryostatGeo.h:474

void geo::CryostatGeo::MakeOpDet	(	std::vector< const TGeoNode * > &	path,
		int	depth
	)

private

void geo::CryostatGeo::MakeTPC	(	std::vector< const TGeoNode * > &	path,
		int	depth
	)

private

double geo::CryostatGeo::Mass ( ) const

inline

Mass of the cryostat.

Definition at line 109 of file CryostatGeo.h.

109 { return fVolume->Weight(); }

TGeoVolume * fVolume

Total volume of cryostat, called volCryostat in GDML file.

Definition: CryostatGeo.h:477

unsigned int geo::CryostatGeo::MaxPlanes ( ) const

Returns the largest number of planes among the TPCs in this cryostat.

Definition at line 170 of file CryostatGeo.cxx.

                                             {
     unsigned int maxPlanes = 0;
     for (geo::TPCGeo const& TPC: fTPCs) {
       unsigned int maxPlanesInTPC = TPC.Nplanes();
       if (maxPlanesInTPC > maxPlanes) maxPlanes = maxPlanesInTPC;
     } // for
     return maxPlanes;
   } // CryostatGeo::MaxPlanes()

unsigned int geo::CryostatGeo::MaxWires ( ) const

Returns the largest number of wires among the TPCs in this cryostat.

Definition at line 180 of file CryostatGeo.cxx.

                                            {
     unsigned int maxWires = 0;
     for (geo::TPCGeo const& TPC: fTPCs) {
       unsigned int maxWiresInTPC = TPC.MaxWires();
       if (maxWiresInTPC > maxWires) maxWires = maxWiresInTPC;
     } // for
     return maxWires;
   } // CryostatGeo::MaxWires()

unsigned int geo::CryostatGeo::NElements ( ) const

inline

Alias for NTPC().

Definition at line 183 of file CryostatGeo.h.

183 { return fTPCs.size(); }

geo::CryostatGeo::fOpDets

TPCList_t fTPCs

List of tpcs in this cryostat.

Definition: CryostatGeo.h:475

unsigned int geo::CryostatGeo::NOpDet ( ) const

inline

Number of optical detectors in this TPC.

Definition at line 361 of file CryostatGeo.h.

361 { return fOpDets.size(); }

OpDetList_t fOpDets

List of opdets in this cryostat.

Definition: CryostatGeo.h:476

unsigned int geo::CryostatGeo::NTPC ( ) const

inline

Number of TPCs in this cryostat.

Definition at line 181 of file CryostatGeo.h.

181 { return fTPCs.size(); }

geo::CryostatGeo::fOpDetGeoName

TPCList_t fTPCs

List of tpcs in this cryostat.

Definition: CryostatGeo.h:475

const OpDetGeo & geo::CryostatGeo::OpDet ( unsigned int iopdet ) const

Return the iopdet'th optical detector in the cryostat.

Definition at line 107 of file CryostatGeo.cxx.

   {
     if(iopdet >= fOpDets.size()){
       throw cet::exception("OpDetOutOfRange") << "Request for non-existant OpDet "
                                               << iopdet;
     }
 
     return fOpDets[iopdet];
   }

std::string geo::CryostatGeo::OpDetGeoName ( ) const

inline

Get name of opdet geometry element.

Definition at line 377 of file CryostatGeo.h.

377 { return fOpDetGeoName; }

std::string fOpDetGeoName

Name of opdet geometry elements in gdml.

Definition: CryostatGeo.h:478

TPCGeo const & geo::CryostatGeo::PositionToTPC	(	geo::Point_t const &	point,
		double	wiggle
	)		const

Returns the ID of the TPC at specified location.

Parameters

point	the location (world reference frame)
wiggle	a small factor (like 1+epsilon) to avoid rounding errors

Returns: the ID of the TPC at the specified point (invalid ID if none)

Definition at line 148 of file CryostatGeo.cxx.

   {
     geo::TPCGeo const* tpc = PositionToTPCptr(point, wiggle);
     if (!tpc) {
       throw cet::exception("CryostatGeo")
         << "Can't find any TPC for position " << point << " within " << ID()
         << "\n";
     }
     return *tpc;
   }

TPCGeo const& geo::CryostatGeo::PositionToTPC	(	double const	worldLoc[3],
		double	wiggle
	)		const

inline

Returns the ID of the TPC at specified location.

Parameters

worldLoc	3D coordinates of the point (world reference frame)
wiggle	a small factor (like 1+epsilon) to avoid rounding errors

Returns: the ID of the TPC at the specified point (invalid ID if none)

Definition at line 334 of file CryostatGeo.h.

335 { return PositionToTPC(geo::vect::makePointFromCoords(worldLoc), wiggle); }

geo::CryostatGeo::PositionToTPC

TPCGeo const & PositionToTPC(geo::Point_t const &point, double wiggle) const

Returns the ID of the TPC at specified location.

Definition: CryostatGeo.cxx:148

geo::vect::makePointFromCoords

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::CryostatGeo::PositionToTPCID	(	geo::Point_t const &	point,
		double	wiggle
	)		const

Returns the ID of the TPC at specified location.

Parameters

point	3D coordinates of the point (world reference frame)
wiggle	a small factor (like 1+epsilon) to avoid rounding errors

Returns: the ID of the TPC at the specified point (invalid ID if none)

Definition at line 138 of file CryostatGeo.cxx.

   {
     geo::TPCGeo const* tpc = PositionToTPCptr(point, wiggle);
     return tpc? tpc->ID(): geo::TPCID{};
   }

geo::TPCGeo const * geo::CryostatGeo::PositionToTPCptr	(	geo::Point_t const &	point,
		double	wiggle
	)		const

Returns a pointer to the TPC at specified location.

Parameters

point	position in space [cm]
wiggle	a small factor (like 1+ε) to avoid rounding errors

Returns: a pointer to the geo::TPCGeo at point (nullptr if none)

Definition at line 161 of file CryostatGeo.cxx.

   {
     for (auto const& tpc: IterateTPCs())
       if (tpc.ContainsPosition(point, wiggle)) return &tpc;
     return nullptr;
   } // CryostatGeo::PositionToTPCptr()

template<typename Stream >

void geo::CryostatGeo::PrintCryostatInfo	(	Stream &&	out,
		std::string	indent = `""`,
		unsigned int	verbosity = `1`
	)		const

Prints information about this cryostat.

Template Parameters

Stream type of output stream to use

Parameters

out	stream to send the information to
indent	prepend each line with this string
verbosity	amount of information printed

Note that the first line out the output is not indented.

Verbosity levels

0: only cryostat ID
1 _(default)_: also center and size
2: also number of TPCs, optical detectors, and maximum wires per plane
and of planes for TPC
3: also information on bounding box

The constant MaxVerbosity is set to the highest supported verbosity level.

Definition at line 489 of file CryostatGeo.h.

         {
 
   //----------------------------------------------------------------------------
   out << "Cryostat " << std::string(ID());
 
   if (verbosity-- <= 0) return; // 0
 
   //----------------------------------------------------------------------------
   out
     << " (" << Width() << " x " << Height() << " x " << Length() << ") cm^3 at "
       << GetCenter();
 
   if (verbosity-- <= 0) return; // 1
 
   //----------------------------------------------------------------------------
 
   out << "\n" << indent
     << "hosts " << NTPC() << " TPCs (largest number of planes: " << MaxPlanes()
       << ", of wires: " << MaxWires() << ") and "
       << NOpDet() << " optical detectors"
     ;
 
   if (verbosity-- <= 0) return; // 2
 
   //----------------------------------------------------------------------------
   // print also the containing box
   geo::BoxBoundedGeo const& box = BoundingBox();
   out << "\n" << indent
     << "bounding box: " << box.Min() << " -- " << box.Max();
 
 //  if (verbosity-- <= 0) return; // 3
 
   //----------------------------------------------------------------------------
 } // geo::CryostatGeo::PrintCryostatInfo()

void geo::CryostatGeo::SortSubVolumes ( geo::GeoObjectSorter const & sorter )

Method to sort TPCGeo objects.

Definition at line 63 of file CryostatGeo.cxx.

   {
     sorter.SortTPCs(fTPCs);
 
     for (geo::TPCGeo& TPC: fTPCs) {
       TPC.SortSubVolumes(sorter);
     }
 
     sorter.SortOpDets(fOpDets);
   } // CryostatGeo::SortSubVolumes()

LocalPoint_t geo::CryostatGeo::toLocalCoords ( geo::Point_t const & world ) const

inline

Transform point from world frame to local cryostat frame.

Definition at line 431 of file CryostatGeo.h.

432 { return fTrans.toLocalCoords(world); }

geo::LocalTransformationGeo::toLocalCoords

LocalPoint_t toLocalCoords(GlobalPoint_t const &world) const

Transforms a point from world frame to local frame.

Definition: LocalTransformationGeo.h:134

geo::LocalTransformationGeo::toLocalCoords

LocalTransformation_t fTrans

Cryostat-to-world transformation.

Definition: CryostatGeo.h:474

LocalVector_t geo::CryostatGeo::toLocalCoords ( geo::Vector_t const & world ) const

inline

Transform direction vector from world to local.

Definition at line 439 of file CryostatGeo.h.

440 { return fTrans.toLocalCoords(world); }

LocalPoint_t toLocalCoords(GlobalPoint_t const &world) const

Transforms a point from world frame to local frame.

Definition: LocalTransformationGeo.h:134

LocalTransformation_t fTrans

Cryostat-to-world transformation.

Definition: CryostatGeo.h:474

geo::Point_t geo::CryostatGeo::toWorldCoords ( LocalPoint_t const & local ) const

inline

Transform point from local cryostat frame to world frame.

Definition at line 403 of file CryostatGeo.h.

404 { return fTrans.toWorldCoords(local); }

local

then local

Definition: make_xml_premcc1.0.sh:85

geo::LocalTransformationGeo::toWorldCoords

LocalTransformation_t fTrans

Cryostat-to-world transformation.

Definition: CryostatGeo.h:474

GlobalPoint_t toWorldCoords(LocalPoint_t const &local) const

Transforms a point from local frame to world frame.

Definition: LocalTransformationGeo.h:104

geo::Vector_t geo::CryostatGeo::toWorldCoords ( LocalVector_t const & local ) const

inline

Transform direction vector from local to world.

Definition at line 411 of file CryostatGeo.h.

412 { return fTrans.toWorldCoords(local); }

local

then local

Definition: make_xml_premcc1.0.sh:85

geo::LocalTransformationGeo::toWorldCoords

LocalTransformation_t fTrans

Cryostat-to-world transformation.

Definition: CryostatGeo.h:474

GlobalPoint_t toWorldCoords(LocalPoint_t const &local) const

Transforms a point from local frame to world frame.

Definition: LocalTransformationGeo.h:104

const TPCGeo & geo::CryostatGeo::TPC ( unsigned int itpc ) const

Return the itpc'th TPC in the cryostat.

Exceptions

cet::exception (category "TPCOutOfRange") if no such TPC

Definition at line 93 of file CryostatGeo.cxx.

   {
     TPCGeo const* pTPC = TPCPtr(itpc);
     if(!pTPC){
       throw cet::exception("TPCOutOfRange") << "Request for non-existant TPC "
                                             << itpc << "\n";
     }
 
     return *pTPC;
   }

const TPCGeo& geo::CryostatGeo::TPC ( TPCID const & tpcid ) const

inline

Returns the TPC in tpcid from this cryostat.

Parameters

tpcid full TPC ID

Returns: a constant reference to the TPC in tpcid

Exceptions

cet::exception (category "TPCOutOfRange") if no such TPC

The cryostat number in tpcid is ignored, as it is ignored whether tpcid is invalid.

Definition at line 220 of file CryostatGeo.h.

221 { return TPC(tpcid.TPC); }

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::CryostatGeo::TPCPtr ( unsigned int itpc ) const

inline

Returns the TPC number itpc from this cryostat.

Parameters

itpc	the number of local TPC

Returns: a constant pointer to the TPC, or nullptr if it does not exist

Definition at line 283 of file CryostatGeo.h.

284 { return HasTPC(itpc)? &(fTPCs[itpc]): nullptr; }

TPCList_t fTPCs

List of tpcs in this cryostat.

Definition: CryostatGeo.h:475

bool HasTPC(unsigned int itpc) const

Returns whether a TPC with index itpc is present in this cryostat.

Definition: CryostatGeo.h:190

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

inline

Returns the TPC in tpcid from this cryostat.

Parameters

tpcid full TPC ID

Returns: a constant pointer to the TPC, or nullptr if it does not exist

The cryostat number in tpcid is ignored, as it is ignored whether tpcid is invalid.

Definition at line 294 of file CryostatGeo.h.

295 { return TPCPtr(tpcid.TPC); }

geo::CryostatGeo::TPCPtr

TPCGeo const * TPCPtr(unsigned int itpc) const

Returns the TPC number itpc from this cryostat.

Definition: CryostatGeo.h:283

auto const& geo::CryostatGeo::TPCs ( ) const

inline

Returns an object suitable for iterating through all TPCs.

See Also: IterateTPCs(), IterateElements()

The returned value can be used in a range-for loop like:

for (geo::TPCGeo const& tpc: cryo.TPCs()) { ... }

The resulting sequence exposes the TPCs within the cryostat in their ID order, from TPC 0 to NTPC() - 1.

Deprecated:: TPCs() is informally deprecated because it used to return a collection of geo::TPCGeo and it might soon be unable to do so. For iterations, IterateTPCs() is just as good.

Definition at line 275 of file CryostatGeo.h.

275 { return fTPCs; }

geo::CryostatGeo::fVolume

TPCList_t fTPCs

List of tpcs in this cryostat.

Definition: CryostatGeo.h:475

void geo::CryostatGeo::UpdateAfterSorting ( geo::CryostatID cryoid )

Performs all needed updates after geometry has sorted the cryostats.

Definition at line 76 of file CryostatGeo.cxx.

                                                            {
 
     // update the cryostat ID
     fID = cryoid;
 
     // trigger all the optical detectors to update
     for (unsigned int opdet = 0; opdet < NOpDet(); ++opdet)
       fOpDets[opdet].UpdateAfterSorting(geo::OpDetID(fID, opdet));
 
     // trigger all the TPCs to update as well
     for (unsigned int tpc = 0; tpc < NTPC(); ++tpc)
       fTPCs[tpc].UpdateAfterSorting(geo::TPCID(fID, tpc));
 
   } // CryostatGeo::UpdateAfterSorting()

const TGeoVolume* geo::CryostatGeo::Volume ( ) const

inline

Pointer to ROOT's volume descriptor.

Definition at line 111 of file CryostatGeo.h.

111 { return fVolume; }

TGeoVolume * fVolume

Total volume of cryostat, called volCryostat in GDML file.

Definition: CryostatGeo.h:477

double geo::CryostatGeo::Width ( ) const

inline

Full width of the cryostat [cm].

Definition at line 103 of file CryostatGeo.h.

103 { return 2. * HalfWidth(); }

geo::CryostatGeo::HalfWidth

double HalfWidth() const

Half width of the cryostat [cm].

Definition: CryostatGeo.cxx:190

void geo::CryostatGeo::WorldToLocal	(	const double *	world,
		double *	cryo
	)		const

inline

Transform point from world frame to local cryostat frame.

Definition at line 415 of file CryostatGeo.h.

416 { fTrans.WorldToLocal(world, cryo); }

geo::LocalTransformation::WorldToLocal

void WorldToLocal(double const *world, double *local) const

Transforms a point from world frame to local frame.

geo::LocalTransformation::WorldToLocal

LocalTransformation_t fTrans

Cryostat-to-world transformation.

Definition: CryostatGeo.h:474

template<typename Point >

Point geo::CryostatGeo::WorldToLocal ( Point const & world ) const

inline

Transform point from world frame to local cryostat frame.

Deprecated:: This method breaks the distinction between local and global vectors, since input and output vectors share the same type; use the "official" vector types geo::Point_t, geo::CryostatGeo::LocalPoint_t, geo::Vector_t and geo::CryostatGeo::LocalVector_t, and then use the method geo::CryostatGeo::toLocalCoords() instead.

Definition at line 427 of file CryostatGeo.h.

428 { return fTrans.WorldToLocal(world); }

void WorldToLocal(double const *world, double *local) const

Transforms a point from world frame to local frame.

LocalTransformation_t fTrans

Cryostat-to-world transformation.

Definition: CryostatGeo.h:474

void geo::CryostatGeo::WorldToLocalVect	(	const double *	world,
		double *	cryo
	)		const

inline

Transform direction vector from world to local.

Definition at line 435 of file CryostatGeo.h.

436 { fTrans.WorldToLocalVect(world, cryo); }