geo::AuxDetGeometryCore Class Reference

Description of geometry of one set of auxiliary detectors. More...

#include "AuxDetGeometryCore.h"

Public Types
using	AuxDetList_t = AuxDetGeometryData_t::AuxDetList_t
	Type of list of auxiliary detectors. More...

Public Member Functions
	AuxDetGeometryCore (fhicl::ParameterSet const &pset)
	Initialize geometry from a given configuration. More...
	AuxDetGeometryCore (AuxDetGeometryCore const &)=delete
	AuxDetGeometryCore (AuxDetGeometryCore &&)=delete
AuxDetGeometryCore &	operator= (AuxDetGeometryCore const &)=delete
AuxDetGeometryCore &	operator= (AuxDetGeometryCore &&)=delete
std::string const &	ROOTFile () const
	Returns the full directory path to the geometry file source. More...
std::string const &	GDMLFile () const
	Returns the full directory path to the GDML file source. More...
std::string const &	DetectorName () const
	Returns a string with the name of the detector, as configured. More...
unsigned int	NAuxDets () const
	Returns the number of auxiliary detectors. More...
unsigned int	NAuxDetSensitive (size_t const &aid) const
	Returns the number of sensitive components of auxiliary detector. More...
std::vector< AuxDetGeo > const &	AuxDetGeoVec () const
	Returns the full list of pointer to the auxiliary detectors. More...
AuxDetGeo const &	AuxDet (unsigned int const ad=0) const
	Returns the specified auxiliary detector. More...
unsigned int	FindAuxDetAtPosition (Point_t const &worldLoc, double tolerance=0) const
	Returns the index of the auxiliary detector at specified location. More...
void	FindAuxDetSensitiveAtPosition (Point_t const &worldLoc, size_t &adg, size_t &sv, double tolerance=0) const
	Fills the indices of the sensitive auxiliary detector at location. More...
AuxDetGeo const &	PositionToAuxDet (Point_t const &worldLoc, unsigned int &ad, double tolerance=0) const
	Returns the auxiliary detector at specified location. More...
AuxDetSensitiveGeo const &	PositionToAuxDetSensitive (Point_t const &worldLoc, size_t &ad, size_t &sv, double tolerance=0) const
	Returns the auxiliary detector at specified location. More...
uint32_t	PositionToAuxDetChannel (Point_t const &worldLoc, size_t &ad, size_t &sv) const
Point_t	AuxDetChannelToPosition (std::string const &auxDetName, uint32_t channel) const
AuxDetGeo const &	ChannelToAuxDet (std::string const &auxDetName, uint32_t channel) const
AuxDetSensitiveGeo const &	ChannelToAuxDetSensitive (std::string const &auxDetName, uint32_t channel) const
Geometry initialization
void	LoadGeometryFile (std::string gdmlfile, std::string rootfile)
	Loads the geometry information from the specified files. More...
bool	hasAuxDetChannelMap () const
	Returns whether we have a channel map. More...
void	ApplyChannelMap (std::unique_ptr< geo::AuxDetChannelMapAlg > pChannelMap)
	Initializes the geometry to work with this channel map. More...

Protected Member Functions
geo::AuxDetChannelMapAlg const *	AuxDetChannelMap () const
	Returns the object handling the channel map. More...
AuxDetList_t &	AuxDets ()
	Return the internal auxiliary detectors list. More...
AuxDetList_t const &	AuxDets () const
	Return the internal auxiliary detectors list. More...

Private Member Functions
void	ClearGeometry ()
	Deletes the detector geometry structures. More...

Private Attributes
AuxDetGeometryData_t	fGeoData
	The detector description data. More...
std::string	fDetectorName
	Name of the detector. More...
std::string	fGDMLfile
	path to geometry file used for Geant4 simulation More...
std::string	fROOTfile
	path to geometry file for geometry in GeometryCore More...
fhicl::ParameterSet	fBuilderParameters
	Configuration of geometry builder. More...
std::unique_ptr< AuxDetChannelMapAlg const >	fChannelMapAlg
	Object containing the channel to wire mapping. More...

Detailed Description

Description of geometry of one set of auxiliary detectors.

---

Note

All lengths are specified in centimetres

How to correctly instantiate a GeometryCore object

Instantiation is a multi-step procedure:

1. construct a GeometryCore object (the "service provider"), with the full configuration; at this step, configuration is just stored
2. load a geometry with GeometryCore::LoadGeometryFile(); this loads the detector geometry information
3. prepare a channel map algorithm object (might use for example GeometryCore::DetectorName() or the detector geometry from the newly created object, but any use of channel mapping related functions is forbidden and it would yield undefined behaviour (expected to be catastrophic)
4. acquire the channel mapping algorithm with GeometryCore::ApplyChannelMap(); at this point, the ChannelMapAlg object is asked to initialize itself and to perform whatever modifications to the geometry provider is needed.

Step 3 (creation of the channel mapping algorithm object) can be performed at any time before step 4, provided that no GeometryCore instance is needed for it.

Configuration parameters

• Name (string; mandatory): string identifying the detector; it can be different from the base name of the file used to initialize the geometry; standard names are recommended by each experiment. This name can be used, for example, to select which channel mapping algorithm to use.
• SurfaceY (real; mandatory): depth of the detector, in centimetrs; see SurfaceY() for details
• MinWireZDist (real; default: 3)
• PositionEpsilon (real; default: 0.01%) set the default tolerance (see DefaultWiggle())

Definition at line 88 of file AuxDetGeometryCore.h.

Member Typedef Documentation

using geo::AuxDetGeometryCore::AuxDetList_t = AuxDetGeometryData_t::AuxDetList_t

Type of list of auxiliary detectors.

Definition at line 91 of file AuxDetGeometryCore.h.

Constructor & Destructor Documentation

geo::AuxDetGeometryCore::AuxDetGeometryCore

(

fhicl::ParameterSet const &

pset

)

Initialize geometry from a given configuration.

Parameters

pset	configuration parameters

This constructor does not load any geometry description. The next step is to do exactly that, by GeometryCore::LoadGeometryFile().

Definition at line 40 of file AuxDetGeometryCore.cxx.

References fDetectorName.

    : fDetectorName(pset.get<std::string>("Name"))
    , fBuilderParameters(pset.get<fhicl::ParameterSet>("Builder", fhicl::ParameterSet()))
  {
    std::transform(fDetectorName.begin(), fDetectorName.end(), fDetectorName.begin(), ::tolower);
  }

geo::AuxDetGeometryCore::AuxDetGeometryCore ( AuxDetGeometryCore const &  )

delete

geo::AuxDetGeometryCore::AuxDetGeometryCore ( AuxDetGeometryCore &&  )

delete

Member Function Documentation

void geo::AuxDetGeometryCore::ApplyChannelMap

(

std::unique_ptr< geo::AuxDetChannelMapAlg >

pChannelMap

)

Initializes the geometry to work with this channel map.

Parameters

pChannelMap

a pointer to the channel mapping algorithm to be used

See also

LoadGeometryFile()

The specified channel mapping is used with this geometry. The algorithm object is asked and allowed to make the necessary modifications to the geometry description. These modifications typically involve some resorting of the objects.

The ownership of the algorithm object is shared, usually with a calling framework: we maintain it alive as long as we need it (and no other code can delete it), and we delete it only if no other code is sharing the ownership.

This method needs to be called after LoadGeometryFile() to complete the geometry initialization.

Definition at line 48 of file AuxDetGeometryCore.cxx.

References fChannelMapAlg, fGeoData, and geo::AuxDetChannelMapAlg::Initialize().

Referenced by geo::AuxDetGeometry::InitializeChannelMap().

  {
    pChannelMap->Initialize(fGeoData);
    fChannelMapAlg = move(pChannelMap);
  }

const AuxDetGeo & geo::AuxDetGeometryCore::AuxDet

(

unsigned int const

ad = 0

)

const

Returns the specified auxiliary detector.

Parameters

ad	the auxiliary detector index

Returns

a constant reference to the specified auxiliary detector

Todo:

what happens if it does not exist?

remove the default parameter?

Definition at line 121 of file AuxDetGeometryCore.cxx.

References AuxDets(), and NAuxDets().

Referenced by ChannelToAuxDet(), ChannelToAuxDetSensitive(), PositionToAuxDet(), and PositionToAuxDetSensitive().

  {
    if (ad >= NAuxDets())
      throw cet::exception("AuxDetGeometryCore") << "AuxDet " << ad << " does not exist\n";

    return AuxDets()[ad];
  }

geo::AuxDetChannelMapAlg const* geo::AuxDetGeometryCore::AuxDetChannelMap ( ) const

inlineprotected

Returns the object handling the channel map.

Definition at line 289 of file AuxDetGeometryCore.h.

{ return fChannelMapAlg.get(); }

Point_t geo::AuxDetGeometryCore::AuxDetChannelToPosition	(	std::string const &	auxDetName,
		uint32_t	channel
	)		const

Definition at line 176 of file AuxDetGeometryCore.cxx.

References AuxDets(), and fChannelMapAlg.

  {
    return fChannelMapAlg->AuxDetChannelToPosition(channel, auxDetName, AuxDets());
  }

std::vector<AuxDetGeo> const& geo::AuxDetGeometryCore::AuxDetGeoVec ( ) const

inline

Returns the full list of pointer to the auxiliary detectors.

Definition at line 162 of file AuxDetGeometryCore.h.

{ return AuxDets(); }

AuxDetList_t& geo::AuxDetGeometryCore::AuxDets ( )

inlineprotected

Return the internal auxiliary detectors list.

Definition at line 293 of file AuxDetGeometryCore.h.

Referenced by AuxDet(), AuxDetChannelToPosition(), ChannelToAuxDet(), ChannelToAuxDetSensitive(), ClearGeometry(), FindAuxDetAtPosition(), FindAuxDetSensitiveAtPosition(), LoadGeometryFile(), NAuxDetSensitive(), and PositionToAuxDetChannel().

{ return fGeoData.auxDets; }

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

inlineprotected

Return the internal auxiliary detectors list.

Definition at line 294 of file AuxDetGeometryCore.h.

{ return fGeoData.auxDets; }

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

Definition at line 183 of file AuxDetGeometryCore.cxx.

References AuxDet(), AuxDets(), and fChannelMapAlg.

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

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

Definition at line 191 of file AuxDetGeometryCore.cxx.

References AuxDet(), AuxDets(), fChannelMapAlg, and geo::AuxDetGeo::SensitiveVolume().

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

void geo::AuxDetGeometryCore::ClearGeometry ( )

private

Deletes the detector geometry structures.

Definition at line 97 of file AuxDetGeometryCore.cxx.

References AuxDets().

Referenced by LoadGeometryFile().

  {
    AuxDets().clear();
  }

std::string const& geo::AuxDetGeometryCore::DetectorName ( ) const

inline

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

Definition at line 127 of file AuxDetGeometryCore.h.

{ return fDetectorName; }

unsigned int geo::AuxDetGeometryCore::FindAuxDetAtPosition	(	Point_t const &	worldLoc,
		double	tolerance = 0
	)		const

Returns the index of the auxiliary detector at specified location.

Parameters

worldLoc

3D coordinates of the point (world reference frame)

Returns

the index of the detector, or UINT_MAX if no detector is there

Todo:

replace with numeric_limits<>?

Definition at line 130 of file AuxDetGeometryCore.cxx.

References AuxDets(), and fChannelMapAlg.

Referenced by FindAuxDetSensitiveAtPosition(), and PositionToAuxDet().

  {
    return fChannelMapAlg->NearestAuxDet(worldPos, AuxDets(), tolerance);
  }

void geo::AuxDetGeometryCore::FindAuxDetSensitiveAtPosition	(	Point_t const &	worldLoc,
		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.

Definition at line 147 of file AuxDetGeometryCore.cxx.

References AuxDets(), fChannelMapAlg, and FindAuxDetAtPosition().

Referenced by PositionToAuxDetSensitive().

  {
    adg = FindAuxDetAtPosition(worldPos, tolerance);
    sv = fChannelMapAlg->NearestSensitiveAuxDet(worldPos, AuxDets(), adg, tolerance);
  }

std::string const& geo::AuxDetGeometryCore::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 124 of file AuxDetGeometryCore.h.

{ return fGDMLfile; }

bool geo::AuxDetGeometryCore::hasAuxDetChannelMap ( ) const

inline

Returns whether we have a channel map.

Definition at line 264 of file AuxDetGeometryCore.h.

{ return bool(fChannelMapAlg); }

void geo::AuxDetGeometryCore::LoadGeometryFile	(	std::string	gdmlfile,
		std::string	rootfile
	)

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

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 55 of file AuxDetGeometryCore.cxx.

References AuxDets(), ClearGeometry(), geo::GeometryBuilder::extractAuxiliaryDetectors(), fBuilderParameters, fGDMLfile, and fROOTfile.

Referenced by geo::AuxDetGeometry::LoadNewGeometry().

  {

    if (gdmlfile.empty()) {
      throw cet::exception("AuxDetGeometryCore") << "No GDML Geometry file specified!\n";
    }

    if (rootfile.empty()) {
      throw cet::exception("AuxDetGeometryCore") << "No ROOT Geometry file specified!\n";
    }

    ClearGeometry();

    // Open the GDML file, and convert it into ROOT TGeoManager format.
    // try to be efficient - if the GeometryCore object already imported
    // the file, then the gGeoManager will be non-null.  If not, import it.
    // Then lock the gGeoManager to prevent future imports.
    if (!gGeoManager) {
      // [20210701, petrillo@slac.stanford.edu]
      // same code, same comment as in `geo::GeometryCore::LoadGeometryFile()`.
      TGeoManager::LockDefaultUnits(false);
      TGeoManager::SetDefaultUnits(TGeoManager::kRootUnits);
      TGeoManager::LockDefaultUnits(true);
      TGeoManager::Import(rootfile.c_str());
      gGeoManager->LockGeometry();
    }

    geo::GeometryBuilderStandard builder(
      fhicl::Table<geo::GeometryBuilderStandard::Config>(fBuilderParameters, {"tool_type"})());
    geo::GeoNodePath path{gGeoManager->GetTopNode()};

    AuxDets() = builder.extractAuxiliaryDetectors(path);

    fGDMLfile = gdmlfile;
    fROOTfile = rootfile;

    mf::LogInfo("AuxDetGeometryCore") << "New detector geometry loaded from "
                                      << "\n\t" << fROOTfile << "\n\t" << fGDMLfile << "\n";

  } // AuxDetGeometryCore::LoadGeometryFile()

unsigned int geo::AuxDetGeometryCore::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 147 of file AuxDetGeometryCore.h.

Referenced by AuxDet(), and NAuxDetSensitive().

{ return AuxDets().size(); }

unsigned int geo::AuxDetGeometryCore::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

Exceptions

cet::exception

(category "Geometry") if aid does not exist

Definition at line 103 of file AuxDetGeometryCore.cxx.

References AuxDets(), and NAuxDets().

  {
    if (aid > NAuxDets() - 1)
      throw cet::exception("Geometry")
        << "Requested AuxDet index " << aid << " is out of range: " << NAuxDets();

    return AuxDets()[aid].NSensitiveVolume();
  }

AuxDetGeometryCore& geo::AuxDetGeometryCore::operator= ( AuxDetGeometryCore const &  )

delete

AuxDetGeometryCore& geo::AuxDetGeometryCore::operator= ( AuxDetGeometryCore &&  )

delete

const AuxDetGeo & geo::AuxDetGeometryCore::PositionToAuxDet	(	Point_t const &	worldLoc,
		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

Todo:

what happens if it does not exist?

Definition at line 137 of file AuxDetGeometryCore.cxx.

References AuxDet(), and FindAuxDetAtPosition().

  {
    // locate the desired Auxiliary Detector
    ad = FindAuxDetAtPosition(worldLoc, tolerance);
    return AuxDet(ad);
  }

uint32_t geo::AuxDetGeometryCore::PositionToAuxDetChannel	(	Point_t const &	worldLoc,
		size_t &	ad,
		size_t &	sv
	)		const

Definition at line 168 of file AuxDetGeometryCore.cxx.

References AuxDets(), and fChannelMapAlg.

  {
    return fChannelMapAlg->PositionToAuxDetChannel(worldLoc, AuxDets(), ad, sv);
  }

AuxDetSensitiveGeo const & geo::AuxDetGeometryCore::PositionToAuxDetSensitive	(	Point_t const &	worldLoc,
		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
tolerance	tolerance (cm) for matches. Default 0.
ad	(output) the auxiliary detector index
sv	(output) the auxiliary detector sensitive volume index

Returns

reference to AuxDetSensitiveGeo object of the auxiliary detector

Todo:

what happens if it does not exist?

Definition at line 157 of file AuxDetGeometryCore.cxx.

References AuxDet(), FindAuxDetSensitiveAtPosition(), and geo::AuxDetGeo::SensitiveVolume().

  {
    // locate the desired Auxiliary Detector
    FindAuxDetSensitiveAtPosition(worldLoc, ad, sv, tolerance);
    return AuxDet(ad).SensitiveVolume(sv);
  }

std::string const& geo::AuxDetGeometryCore::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 115 of file AuxDetGeometryCore.h.

{ return fROOTfile; }

Member Data Documentation

fhicl::ParameterSet geo::AuxDetGeometryCore::fBuilderParameters

private

Configuration of geometry builder.

Definition at line 306 of file AuxDetGeometryCore.h.

Referenced by LoadGeometryFile().

std::unique_ptr<AuxDetChannelMapAlg const> geo::AuxDetGeometryCore::fChannelMapAlg

private

Object containing the channel to wire mapping.

Definition at line 308 of file AuxDetGeometryCore.h.

Referenced by ApplyChannelMap(), AuxDetChannelToPosition(), ChannelToAuxDet(), ChannelToAuxDetSensitive(), FindAuxDetAtPosition(), FindAuxDetSensitiveAtPosition(), and PositionToAuxDetChannel().

std::string geo::AuxDetGeometryCore::fDetectorName

private

Name of the detector.

Definition at line 303 of file AuxDetGeometryCore.h.

Referenced by AuxDetGeometryCore().

std::string geo::AuxDetGeometryCore::fGDMLfile

private

path to geometry file used for Geant4 simulation

Definition at line 304 of file AuxDetGeometryCore.h.

Referenced by LoadGeometryFile().

AuxDetGeometryData_t geo::AuxDetGeometryCore::fGeoData

private

The detector description data.

Definition at line 301 of file AuxDetGeometryCore.h.

Referenced by ApplyChannelMap().

std::string geo::AuxDetGeometryCore::fROOTfile

private

path to geometry file for geometry in GeometryCore

Definition at line 305 of file AuxDetGeometryCore.h.

Referenced by LoadGeometryFile().

---

The documentation for this class was generated from the following files:

• larcorealg/v09_13_01/source/larcorealg/Geometry/AuxDetGeometryCore.h
• larcorealg/v09_13_01/source/larcorealg/Geometry/AuxDetGeometryCore.cxx