lar::example Namespace Reference

LArSoft examples. More...

Namespaces
	details
	Implementation detail namespace (content is not documented)
	tests
	Tests for LArSoft examples.

Classes
class	AnalysisExample
	Example analyzer module. More...
class	AtomicNumber
	Provides information about the active material in the TPC. More...
class	CheatTrack
	Pseudo-track object for TotallyCheatTracks example. More...
struct	CoordRange
	Range of coordinates. More...
struct	CoordRangeCells
	Range of coordinates. More...
class	Disturbance
	A silly module. More...
class	Exploder
	A buggy module. More...
class	PointIsolationAlg
	Algorithm to detect isolated space points. More...
struct	PositionExtractor
	Helper extractor for point coordinates. More...
struct	PositionExtractor< recob::SpacePoint >
	Specialization of PositionExtractor for recob::SpacePoint. More...
struct	PositionExtractor< std::array< T, 3U > >
	Specialisation of PositionExtractor for C++ array: { x, y, z }. More...
struct	PositionExtractor< std::vector< T > >
struct	PositionExtractor< T * >
	Specialisation of PositionExtractor for C array: { x, y, z }. More...
class	RemoveIsolatedSpacePoints
	art module: removes isolated space points. More...
class	ShowerCalibrationGalore
	Interface for a shower calibration service provider. More...
class	ShowerCalibrationGaloreFromPID
	Shower calibration service provider correcting according to PID. More...
class	ShowerCalibrationGaloreScale
	A shower calibration service provider applying a uniform scale. More...
class	ShowerCalibrationGaloreScaleService
	A shower calibration art service returning a single factor. More...
class	SpacePartition
	A container of points sorted in cells. More...
class	SpacePointIsolationAlg
	Algorithm to detect isolated space points. More...
class	TotallyCheatTracker
	Module: creates tracks from simulated particles. More...
class	TotallyCheatTrackingAlg
	Reconstructs tracks from simulated particles. More...

Typedefs
using	AtomicNumberService = lar::SimpleServiceProviderWrapper< AtomicNumber >
	Service giving access to AtomicNumber service provider. More...
using	ShowerCalibrationGaloreFromPIDService = lar::ServiceProviderImplementationWrapper< ShowerCalibrationGaloreFromPID, ShowerCalibrationGaloreService >
	Service for shower energy calibration according to particle type. More...
using	ShowerCalibrationGaloreService = lar::ServiceProviderInterfaceWrapper< ShowerCalibrationGalore >
	Interface for a shower calibration art service. More...

Functions
template<typename Stream >
Stream &	operator<< (Stream &&out, ShowerCalibrationGalore::Correction_t const &corr)
	Output operator for the correction type. More...
std::pair< std::string, std::string >	splitROOTpath (std::string path)
	Splits path into ROOT file name and directory path. More...

Detailed Description

LArSoft examples.

Typedef Documentation

using lar::example::AtomicNumberService = typedef lar::SimpleServiceProviderWrapper<AtomicNumber>

Service giving access to AtomicNumber service provider.

See also

AtomicNumber, AtomicNumber example overview

Access the provider with the standard LArSoft access pattern:

auto const* atomicNumber
  = lar::providerFrom<lar::example::AtomicNumberService>();

Definition at line 38 of file AtomicNumberService.h.

using lar::example::ShowerCalibrationGaloreFromPIDService = typedef lar::ServiceProviderImplementationWrapper <ShowerCalibrationGaloreFromPID, ShowerCalibrationGaloreService>

Service for shower energy calibration according to particle type.

See also

ShowerCalibrationGalore example overview

See the ShowerCalibrationGaloreFromPID provider documentation for configuration instructions and implementation details.

See the ShowerCalibrationGalore provider class documentation for an explanation of the interface.

Use this service and its provider by its interface only:

lar::example::ShowerCalibrationGalore const* calib
  = lar::providerFrom<lar::example::ShowerCalibrationGaloreService>();

The code does not need to mention, nor to include, nor to link to ShowerCalibrationGaloreFromPIDService service.

Configuration parameters

In addition to the service provider:

• service_provider must be set to "ShowerCalibrationGaloreFromPIDService" in order to tell art to load this implementation.

Definition at line 56 of file ShowerCalibrationGaloreFromPIDService.h.

using lar::example::ShowerCalibrationGaloreService = typedef lar::ServiceProviderInterfaceWrapper<ShowerCalibrationGalore>

Interface for a shower calibration art service.

See also

ShowerCalibrationGalore example overview

Services derived from this interface just return a provider implementing the ShowerCalibrationGalore service provider interface.

Implementations of this service must override ShowerCalibrationGaloreService::do_provider().

Definition at line 38 of file ShowerCalibrationGaloreService.h.

Function Documentation

template<typename Stream >

Stream& lar::example::operator<<	(	Stream &&	out,
		ShowerCalibrationGalore::Correction_t const &	corr
	)

Output operator for the correction type.

Definition at line 130 of file ShowerCalibrationGalore.h.

         {
            out << corr.factor << " +/- " << corr.error;
            return out;
         } // operator<< (Correction_t)

std::pair< std::string, std::string > lar::example::splitROOTpath

(

std::string

path

)

Splits path into ROOT file name and directory path.

Definition at line 335 of file ShowerCalibrationGaloreFromPID.cxx.

                                        {
   const std::string suffix = ".root";

   // find the ROOT file name
   std::string::size_type iSuffix = std::string::npos;
   do {
      iSuffix = path.rfind(suffix, iSuffix);
      if (iSuffix == std::string::npos) return {}; // failure: no suffix

      // if it's not "suffix:" or "suffix/" or at end of string, it's not it
      auto iAfter = iSuffix + suffix.length();
      if ((iAfter < path.length())
         && (path[iAfter] != '/')
         && (path[iAfter] != ':')
         )
      {
         // oops... this suffix is invalid; keep searching
         if (iSuffix == 0) return {}; // failure: no suffix
         --iSuffix;
         continue;
      }

      // we found a proper suffix
      std::pair<std::string, std::string> result;

      result.first = path.substr(0U, iAfter); // file path
      if (iAfter < path.length())
         result.second = path.substr(iAfter + 1, path.length()); // ROOT dir
      return result;

   } while (true);
} // lar::example::splitROOTpath()