geo::WireReadoutDumper Class Reference

Algorithm dumping the full detector geometry down to wires. More...

#include "WireReadoutDumper.h"

Classes
struct	StreamAdapter
	Helper for insertion into C++ output streams. More...

Public Member Functions
	WireReadoutDumper (geo::GeometryCore const *geom, geo::WireReadoutGeom const *wireGeom, geo::AuxDetGeometryCore const *auxGeom)
	Constructor: acquires geometry service providers. More...
void	dump (std::ostream &out, std::string const &indent, std::string const &firstIndent) const
	Dumps the full geometry information into a stream. More...
void	dump (std::ostream &out, std::string const &indent="") const
	Dumps the full geometry information into a stream. More...
StreamAdapter	toStream (std::string indent, std::string firstIndent) const
	Adapter to send the dump to a C++ output stream via insertion. More...
auto	toStream (std::string indent="") const
	Adapter to send the dump to a C++ output stream via insertion. More...

Private Member Functions
void	dumpDetectorInfo (std::ostream &out, std::string const &indent, std::string const &firstIndent) const
	Dumps the general detector information. More...
void	dumpCryostat (std::ostream &out, geo::CryostatGeo const &cryostat, std::string const &indent, std::string const &firstIndent) const
	Dumps all content of the specified cryostat. More...
void	dumpTPCplane (std::ostream &out, geo::PlaneGeo const &plane, std::string const &indent, std::string const &firstIndent) const
	Dumps the information from the specified plane (including wires). More...
void	dumpAuxiliaryDetectors (std::ostream &out, std::string const &indent, std::string const &firstIndent) const
	Dumps all auxiliary detector information. More...

Private Attributes
geo::GeometryCore const *	fGeom = nullptr
	Cached geometry service provider. More...
geo::WireReadoutGeom const *	fWireGeom = nullptr
	Cached wire readout service provider. More...
geo::AuxDetGeometryCore const *	fAuxGeom = nullptr
	Cached auxiliary detector geometry service provider. More...

Friends
std::ostream &	operator<< (std::ostream &out, StreamAdapter const &dumpAdapter)
	Helper for geo::WireReadoutDumper::toStream(). More...

Detailed Description

Algorithm dumping the full detector geometry down to wires.

This algorithm dumps all the available information from the geometry, including the chamber information (from geo::GeometryCore), the wire and readout information (from geo::WireReadoutGeom) and the auxiliary detectors (from geo::AuxDetGeometryCore). Any of the service providers can be omitted (nullptr), in which case the relative information will not be printed.

A typical usage example is to create the algorithm and then call its dump() method, like in:

auto const* geom = lar::providerFrom<geo::Geometry>();
auto const* wireGeom = &(art::ServiceHandle<geo::WireReadout>()->Get());
auto const* auxDetGeom = art::ServiceHandle<geo::AuxDetGeometry>()->GetProviderPtr();
geo::WireReadoutDumper const dumper{ geom, wireGeom, auxDetGeom };
dumper.dump(std::cout);

The interface supports only dumping to C++ output streams (including std::ostringstream to bridge to libraries which can us strings). However, for streams which support inserter operators to std::ostream, the following is also possible:

mf::LogInfo{ "DumpGeometry" } << dumper.toStream();

The messagefacility library streams (like in this example) fall into this category.

The output is documented in the dump() method.

Definition at line 59 of file WireReadoutDumper.h.

Constructor & Destructor Documentation

geo::WireReadoutDumper::WireReadoutDumper	(	geo::GeometryCore const *	geom,
		geo::WireReadoutGeom const *	wireGeom,
		geo::AuxDetGeometryCore const *	auxGeom
	)

Constructor: acquires geometry service providers.

Definition at line 24 of file WireReadoutDumper.cxx.

References fAuxGeom, and fWireGeom.

  : fGeom{geom}, fWireGeom{wireGeom}, fAuxGeom{auxGeom}
{}

Member Function Documentation

void geo::WireReadoutDumper::dump	(	std::ostream &	out,
		std::string const &	indent,
		std::string const &	firstIndent
	)		const

Dumps the full geometry information into a stream.

Parameters

out	the stream to write the information in
indent	string to be prepended to each output line except the first
firstIndent	string to be prepended to the first line only

The output is in human-readable format, structured as follows:

• all the information for each cryostat, including:
  • all the information for each TPC, including:
    • all the information for each readout plane, including:
      • all the information for each sensitive element (e.g. wire)
  • all the optical detector information
• all information for the "auxiliary" detectors (typically, scintillators for cosmic ray tagging), including:
  • all the information for the "sensitive detectors" in each module.

The output starts on the current line of the stream and it ends with a new line.

Definition at line 31 of file WireReadoutDumper.cxx.

References dumpAuxiliaryDetectors(), dumpCryostat(), dumpDetectorInfo(), fAuxGeom, fGeom, and geo::Iterable< IterationPolicy, Transform >::Iterate().

Referenced by geo::operator<<().

{

  dumpDetectorInfo(out, indent, firstIndent);

  if (fGeom) {
    for (auto const& cryostat : fGeom->Iterate<geo::CryostatGeo>()) {
      out << "\n";
      dumpCryostat(out, cryostat, indent + "    ", indent + "  ");
    }
  }

  if (fAuxGeom) {
    out << "\n";
    dumpAuxiliaryDetectors(out, indent, indent);
  }

  out << '\n';

} // geo::WireReadoutDumper::dump()

void geo::WireReadoutDumper::dump ( std::ostream &  out, std::string const &  indent = ""  ) const

inline

Dumps the full geometry information into a stream.

Parameters

out	the stream to write the information in
indent	(default: none) string to be prepended to all output lines

See also

dump(std::ostream&, std::string const&, std::string const&) const

Dumps the geometry like dump(std::ostream&, std::string const&, std::string const&) const does, but using the same indentation string for all lines.

Definition at line 117 of file WireReadoutDumper.h.

References dump(), geo::WireReadoutDumper::StreamAdapter::firstIndent, geo::WireReadoutDumper::StreamAdapter::indent, and toStream().

Referenced by dump().

{ dump(out, indent, indent); }

void geo::WireReadoutDumper::dumpAuxiliaryDetectors ( std::ostream &  out, std::string const &  indent, std::string const &  firstIndent  ) const

private

Dumps all auxiliary detector information.

Definition at line 151 of file WireReadoutDumper.cxx.

References geo::AuxDetGeometryCore::AuxDet(), util::counter(), fAuxGeom, geo::AuxDetSensitiveGeo::MaxVerbosity, geo::AuxDetGeo::MaxVerbosity, geo::AuxDetGeometryCore::NAuxDets(), geo::AuxDetGeo::NSensitiveVolume(), geo::AuxDetSensitiveGeo::PrintAuxDetInfo(), geo::AuxDetGeo::PrintAuxDetInfo(), and geo::AuxDetGeo::SensitiveVolume().

Referenced by dump(), and toStream().

{

  unsigned int const nAuxDets = fAuxGeom->NAuxDets();
  out << firstIndent << "Auxiliary detectors (" << nAuxDets << "):";
  for (unsigned int const iDet : util::counter(nAuxDets)) {
    geo::AuxDetGeo const& auxDet = fAuxGeom->AuxDet(iDet);

    out << '\n' << indent << "[#" << iDet << "] ";
    auxDet.PrintAuxDetInfo(out, indent + "  ", auxDet.MaxVerbosity);

    unsigned int const nSensitive = auxDet.NSensitiveVolume();
    switch (nSensitive) {
    case 0: break;
    case 1: {
      AuxDetSensitiveGeo const& auxDetS = auxDet.SensitiveVolume(0U);
      out << "\n" << indent << "  ";
      auxDetS.PrintAuxDetInfo(out, indent + "    ", auxDetS.MaxVerbosity);
      break;
    }
    default:
      for (unsigned int const iSens : util::counter(nSensitive)) {
        out << "\n" << indent << "  [#" << iSens << "] ";
        AuxDetSensitiveGeo const& auxDetS = auxDet.SensitiveVolume(iSens);
        auxDetS.PrintAuxDetInfo(out, indent + "    ", auxDetS.MaxVerbosity);
      } // for
      break;
    } // if sensitive detectors

  } // for auxiliary detector

} // geo::WireReadoutDumper::dumpAuxiliaryDetectors()

void geo::WireReadoutDumper::dumpCryostat ( std::ostream &  out, geo::CryostatGeo const &  cryostat, std::string const &  indent, std::string const &  firstIndent  ) const

private

Dumps all content of the specified cryostat.

Definition at line 83 of file WireReadoutDumper.cxx.

References util::counter(), dumpTPCplane(), fWireGeom, art::detail::indent(), geo::Iterable< IterationPolicy, Transform >::Iterate(), geo::CryostatGeo::IterateTPCs(), geo::CryostatGeo::MaxVerbosity, geo::OpDetGeo::MaxVerbosity, geo::CryostatGeo::NOpDet(), geo::CryostatGeo::OpDet(), geo::CryostatGeo::PrintCryostatInfo(), and geo::OpDetGeo::PrintOpDetInfo().

Referenced by dump(), and toStream().

{

  // the indentation game:
  //   `PrintXxxxInfo()` methods don't indent the first line;
  //   our `dumpCryostat()` do as directed, but don't start with a new line

  out << firstIndent;
  cryostat.PrintCryostatInfo(out, indent, cryostat.MaxVerbosity);

  //
  // TPC
  //
  for (geo::TPCGeo const& tpc : cryostat.IterateTPCs()) {

    out << "\n" << indent;
    tpc.PrintTPCInfo(out, indent + "  ", tpc.MaxVerbosity);

    // for (unsigned int const planeNo: tpc.Nplanes()) {
    //   geo::PlaneGeo const& plane = fWireGeom->Plane({ tpc.ID(), planeNo });

    for (auto const& plane : fWireGeom->Iterate<geo::PlaneGeo>(tpc.ID())) {
      out << "\n";
      dumpTPCplane(out, plane, indent + "    ", indent + "  ");

    } // for plane
  }   // for TPC

  //
  // optical detectors
  //
  for (unsigned int const iOpDet : util::counter(cryostat.NOpDet())) {
    geo::OpDetGeo const& opDet = cryostat.OpDet(iOpDet);
    out << "\n" << indent << "  [OpDet #" << iOpDet << "] ";
    opDet.PrintOpDetInfo(out, indent + "    ", opDet.MaxVerbosity);
  } // for

} // geo::WireReadoutDumper::dumpCryostat()

void geo::WireReadoutDumper::dumpDetectorInfo ( std::ostream &  out, std::string const &  indent, std::string const &  firstIndent  ) const

private

Dumps the general detector information.

Definition at line 63 of file WireReadoutDumper.cxx.

References geo::GeometryCore::DetectorEnclosureBox(), geo::GeometryCore::DetectorName(), fAuxGeom, fGeom, geo::BoxBoundedGeo::Max(), geo::BoxBoundedGeo::Min(), geo::AuxDetGeometryCore::NAuxDets(), geo::GeometryCore::Ncryostats(), geo::BoxBoundedGeo::SizeX(), geo::BoxBoundedGeo::SizeY(), geo::BoxBoundedGeo::SizeZ(), and util::to_string().

Referenced by dump(), and toStream().

{

  out << firstIndent << "Detector " << (fGeom ? fGeom->DetectorName() : "") << " has "
      << (fGeom ? std::to_string(fGeom->Ncryostats()) : "unknown") << " cryostats and "
      << (fAuxGeom ? std::to_string(fAuxGeom->NAuxDets()) : "unknown") << " auxiliary detectors:";

  if (fGeom) {
    geo::BoxBoundedGeo const& box = fGeom->DetectorEnclosureBox();

    out << "\n"
        << indent << "  Detector enclosure: " << box.Min() << " -- " << box.Max() << " cm => ( "
        << box.SizeX() << " x " << box.SizeY() << " x " << box.SizeZ() << " ) cm^3";
  }

} // geo::WireReadoutDumper::dumpDetectorInfo()

void geo::WireReadoutDumper::dumpTPCplane ( std::ostream &  out, geo::PlaneGeo const &  plane, std::string const &  indent, std::string const &  firstIndent  ) const

private

Dumps the information from the specified plane (including wires).

Definition at line 126 of file WireReadoutDumper.cxx.

References util::counter(), fWireGeom, geo::PlaneGeo::ID(), geo::WireGeo::MaxVerbosity, geo::PlaneGeo::MaxVerbosity, geo::PlaneGeo::Nwires(), geo::PlaneGeo::PrintPlaneInfo(), geo::WireGeo::PrintWireInfo(), geo::WireReadoutGeom::SignalType(), geo::SignalTypeName(), and geo::PlaneGeo::Wire().

Referenced by dumpCryostat(), and toStream().

{

  const unsigned int nWires = plane.Nwires();

  out << firstIndent;
  plane.PrintPlaneInfo(out, indent, plane.MaxVerbosity);
  SigType_t const sigType = fWireGeom->SignalType(plane.ID());
  out << "\n"
      << indent << "signal type: " << SignalTypeName(sigType) << " (" << static_cast<int>(sigType)
      << ")";

  for (unsigned int const wireNo : util::counter(nWires)) {
    geo::WireID const wireID{plane.ID(), wireNo};
    geo::WireGeo const& wire = plane.Wire(wireID);
    out << "\n" << indent << wireID << " ";
    wire.PrintWireInfo(out, indent, wire.MaxVerbosity);
  } // for wire

} // geo::WireReadoutDumper::dumpTPCplane()

geo::WireReadoutDumper::StreamAdapter geo::WireReadoutDumper::toStream	(	std::string	indent,
		std::string	firstIndent
	)		const

Adapter to send the dump to a C++ output stream via insertion.

Parameters

indent	(default: none) string to be prepended to all output lines
firstIndent	string to be prepended to the first line only

Returns

an opaque adapter for insertion into a C++ output stream

See also

dump()

Example: after a geo::WireReadoutDumper dumper has been initialized,

std::cout << dumper.toStream("> ");

will dump the full geometry into std::cout.

Definition at line 55 of file WireReadoutDumper.cxx.

Referenced by dump().

{
  return {this, std::move(indent), std::move(firstIndent)};
}

auto geo::WireReadoutDumper::toStream ( std::string  indent = "" ) const

inline

Adapter to send the dump to a C++ output stream via insertion.

Parameters

indent

(default: none) string to be prepended to all output lines

Returns

an opaque adapter for insertion into a C++ output stream

See also

dump()

Example: after a geo::WireReadoutDumper dumper has been initialized,

std::cout << dumper.toStream("> ");

will dump the full geometry into std::cout.

Definition at line 148 of file WireReadoutDumper.h.

References dumpAuxiliaryDetectors(), dumpCryostat(), dumpDetectorInfo(), dumpTPCplane(), operator<<, and toStream().

Referenced by toStream().

{ return toStream(indent, std::move(indent)); }

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  out, StreamAdapter const &  dumpAdapter  )

friend

Helper for geo::WireReadoutDumper::toStream().

Referenced by toStream().

Member Data Documentation

geo::AuxDetGeometryCore const* geo::WireReadoutDumper::fAuxGeom = nullptr

private

Cached auxiliary detector geometry service provider.

Definition at line 68 of file WireReadoutDumper.h.

Referenced by dump(), dumpAuxiliaryDetectors(), dumpDetectorInfo(), and WireReadoutDumper().

geo::GeometryCore const* geo::WireReadoutDumper::fGeom = nullptr

private

Cached geometry service provider.

Definition at line 62 of file WireReadoutDumper.h.

Referenced by dump(), and dumpDetectorInfo().

geo::WireReadoutGeom const* geo::WireReadoutDumper::fWireGeom = nullptr

private

Cached wire readout service provider.

Definition at line 65 of file WireReadoutDumper.h.

Referenced by dumpCryostat(), dumpTPCplane(), and WireReadoutDumper().

---

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

• larcorealg/v10_00_02/source/larcorealg/Geometry/WireReadoutDumper.h
• larcorealg/v10_00_02/source/larcorealg/Geometry/WireReadoutDumper.cxx