LArSoft  v10_04_05
Liquid Argon Software toolkit - https://larsoft.org/
geo::WireReadoutGeometryBuilder Class Referenceabstract

Manages the extraction of LArSoft geometry information from ROOT. More...

#include "WireReadoutGeometryBuilder.h"

Inheritance diagram for geo::WireReadoutGeometryBuilder:
geo::WireReadoutGeomBuilderStandard

Public Types

using Path_t = GeoNodePath
 Identification of a single node in ROOT geometry. More...
 

Public Member Functions

virtual ~WireReadoutGeometryBuilder ()=default
 Virtual destructor. More...
 

Private Member Functions

virtual Planes_t doExtractPlanes (Path_t &path) const =0
 

Cryostat information

using Planes_t = std::map< std::size_t, std::vector< PlaneGeo >>
 Collection of wire-plane information objects. More...
 
Planes_t extractPlanes (Path_t path) const
 Looks for all cryostats under the specified path. More...
 

Detailed Description

Manages the extraction of LArSoft geometry information from ROOT.

The general interface only provides abstraction for the high level objects (cryostats and auxiliary detectors). The implementations can use a finer internal structure to address single subcomponents (e.g. wire planes).

Builder objects can be configured via FHiCL parameters.

This is an abstract interface.

Customization of geometry objects

The builders return collections of LArSoft geometry objects dynamically allocated. In this way, in future it will be possible to easily customize those objects for detector-specific needs. Note that as of LArSoft v08_06_00, no polymorphism is actually implemented.

Definition at line 37 of file WireReadoutGeometryBuilder.h.

Member Typedef Documentation

Identification of a single node in ROOT geometry.

Definition at line 41 of file WireReadoutGeometryBuilder.h.

using geo::WireReadoutGeometryBuilder::Planes_t = std::map<std::size_t, std::vector<PlaneGeo>>

Collection of wire-plane information objects.

Definition at line 56 of file WireReadoutGeometryBuilder.h.

Constructor & Destructor Documentation

virtual geo::WireReadoutGeometryBuilder::~WireReadoutGeometryBuilder ( )
virtualdefault

Virtual destructor.

Member Function Documentation

virtual Planes_t geo::WireReadoutGeometryBuilder::doExtractPlanes ( Path_t path) const
privatepure virtual

Implemented in geo::WireReadoutGeomBuilderStandard.

Referenced by extractPlanes().

Planes_t geo::WireReadoutGeometryBuilder::extractPlanes ( Path_t  path) const
inline

Looks for all cryostats under the specified path.

Parameters
pathpath pointing to the starting node
Returns
a list of fully constructed planes, keyed by TPC TGeoVolume pointer

The planes contain all their inner elements. The current node itself of the path is also considered as plane candidate, then it is descended into.

Definition at line 66 of file WireReadoutGeometryBuilder.h.

References doExtractPlanes().

66 { return doExtractPlanes(path); }
virtual Planes_t doExtractPlanes(Path_t &path) const =0

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