Shower calibration service provider correcting according to PID. More...

#include "ShowerCalibrationGaloreFromPID.h"

Inheritance diagram for lar::example::ShowerCalibrationGaloreFromPID:

Classes
struct	CalibrationInfo_t
	Internal structure containing the calibration information. More...

struct	Config
	Collection of configuration parameters for the service. More...

Public Types
using	parameters_type = fhicl::Table< Config >
	Type describing all the parameters. More...

using	PDGID_t = int
	A type representing a particle ID in Particle Data Group convention. More...

Public Member Functions
	ShowerCalibrationGaloreFromPID (Config const &config)
	Constructor from the complete configuration object. More...

	ShowerCalibrationGaloreFromPID (fhicl::ParameterSet const &pset)
	Constructor from a parameter set. More...

virtual std::string	report () const override
	Returns a string with a short report of the current corrections. More...

void	readCalibration (std::string path)
	Reads the calibration information from the specified file. More...

template<typename Stream >
void	reportTo (Stream &&out) const
	Prints a short report of the current corrections. More...

Correction query
virtual float	correctionFactor (recob::Shower const &, PDGID_t=unknownID) const override
	Returns a correction factor for a given reconstructed shower. More...

virtual Correction_t	correction (recob::Shower const &, PDGID_t=unknownID) const override
	Returns the correction for a given reconstructed shower. More...

Static Public Member Functions
static void	verifyOrder (TGraph const *graph)

Static Public Attributes
static constexpr PDGID_t	unknownID = 0
	A mnemonic constant for unknown particle ID. More...

Private Member Functions
CalibrationInfo_t const &	selectCorrection (PDGID_t id) const
	Returns the correct CalibrationInfo_t for specified id. More...

CalibrationInfo_t	readParticleCalibration (TDirectory *SourceDir, std::string GraphName) const
	Reads and returns calibration information from the specified graph. More...

CalibrationInfo_t	readParticleCalibration (TDirectory *SourceDir, std::string GraphName, PDGID_t id) const

CalibrationInfo_t	readParticleCalibration (TDirectory *SourceDir, std::string GraphName, std::initializer_list< PDGID_t > ids) const

Static Private Member Functions
static TDirectory *	OpenROOTdirectory (std::string path)
	Opens the specified ROOT directory, as in path/to/file.root:dir/dir. More...

static std::unique_ptr< ROOT::Math::Interpolator >	createInterpolator (unsigned int N, double const x, double const y)
	Creates a ROOT interpolator from a set of N points. More...

Private Attributes
CalibrationInfo_t	Calibration_pi0
	neutral pion calibration More...

CalibrationInfo_t	Calibration_photon
	photon calibration More...

CalibrationInfo_t	Calibration_electron
	electron/positron calibration More...

CalibrationInfo_t	Calibration_muon
	muon/antimuon calibration More...

CalibrationInfo_t	Calibration_other
	default calibration More...

Detailed Description

Shower calibration service provider correcting according to PID.

The service provider computes a calibration factor for a reconstructed shower. The calibration factor depends on an hypothesis on the type of particle. The calibration factors are extracted from the specified ROOT file.

Calibration file format

Calibration is represented by a list of objects with specific names:

"Pi0" (TGraphErrors): neutral pion calibration vs. reconstructed energy
"Photon" (TGraphErrors): photon calibration vs. reconstructed energy
"Electron" (TGraphErrors): electron/positron calibration vs. reconstructed energy
"Muon" (TGraphErrors): muon/antimuon calibration vs. reconstructed energy
"Default" (TGraphErrors): other particle calibration vs. reconstructed energy

Each graph is required to hold at least one point, and its points must be already sorted by energy. Energy is measured in GeV.

Calibration factors from the input

The input calibration objects are graphs with symmetric errors. The independent variable is the best estimation of the reconstructed energy of the shower. The correction factor is interpolated (by a cubic spline) between the points in the graph; errors are likewise interpolated. If the requested energy is outside the range of the graph the correction is the same as the closest available energy point, with its uncertainty doubled every half full range of the graph. As a special case, if the graph has only one point, the correction is uniform in the full energy spectrum (including its uncertainty).

Configuration parameters

CalibrationFile (string, mandatory): path to the file containing the full shower calibration information; it is made of a file system path to the ROOT file, and an optional ROOT directory path; for example: path/to/file.root:Calibrations/Shower expects a nested ROOT directory structure Calibrations/Shower in the ROOT file path/to/file.root, where path is accessible from the usual search path in FW_SEARCH_PATH

Definition at line 121 of file ShowerCalibrationGaloreFromPID.h.

Member Typedef Documentation

using lar::example::ShowerCalibrationGaloreFromPID::parameters_type = fhicl::Table<Config>

Type describing all the parameters.

Definition at line 141 of file ShowerCalibrationGaloreFromPID.h.

using lar::example::ShowerCalibrationGalore::PDGID_t = int

inherited

A type representing a particle ID in Particle Data Group convention.

Definition at line 66 of file ShowerCalibrationGalore.h.

Constructor & Destructor Documentation

lar::example::ShowerCalibrationGaloreFromPID::ShowerCalibrationGaloreFromPID ( Config const & config )

inline

Constructor from the complete configuration object.

Definition at line 146 of file ShowerCalibrationGaloreFromPID.h.

References lar::example::ShowerCalibrationGaloreFromPID::Config::CalibrationFile.

147 { readCalibration(config.CalibrationFile()); }

lar::example::ShowerCalibrationGaloreFromPID::readCalibration

void readCalibration(std::string path)

Reads the calibration information from the specified file.

Definition: ShowerCalibrationGaloreFromPID.cxx:62

lar::example::ShowerCalibrationGaloreFromPID::ShowerCalibrationGaloreFromPID ( fhicl::ParameterSet const & pset )

inline

Constructor from a parameter set.

Definition at line 151 of file ShowerCalibrationGaloreFromPID.h.

            : ShowerCalibrationGaloreFromPID
              (parameters_type(pset, { "service_type", "service_provider" })())
            {}

Member Function Documentation

lar::example::ShowerCalibrationGalore::Correction_t lar::example::ShowerCalibrationGaloreFromPID::correction	(	recob::Shower const &	shower,
		PDGID_t	id = `unknownID`
	)		const

overridevirtual

Returns the correction for a given reconstructed shower.

Returns: the correction with its uncertainty

See also: correctionFactor()

The returned value includes a correction factor to be applied to any shower energy to calibrate it, with its global uncertainty.

Implements lar::example::ShowerCalibrationGalore.

Definition at line 50 of file ShowerCalibrationGaloreFromPID.cxx.

References recob::Shower::best_plane(), E, recob::Shower::Energy(), lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t::evalError(), lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t::evalFactor(), and readCalibration().

Referenced by correctionFactor().

 {
    CalibrationInfo_t const& corr = selectCorrection(id);
    
    double const E = shower.Energy().at(shower.best_plane());
    
    return { (float) corr.evalFactor(E), (float) corr.evalError(E) };
 } // lar::example::ShowerCalibrationGaloreFromPID::correction()

float lar::example::ShowerCalibrationGaloreFromPID::correctionFactor	(	recob::Shower const &	shower,
		PDGID_t	id = `unknownID`
	)		const

overridevirtual

Returns a correction factor for a given reconstructed shower.

LArSoft libraries.

Returns: the uniform energy correction factor

See also: correction()

The returned value includes a correction factor to be applied to the shower energy to calibrate it, but no uncertainty.

framework and utility libraries

Implements lar::example::ShowerCalibrationGalore.

Definition at line 37 of file ShowerCalibrationGaloreFromPID.cxx.

References recob::Shower::best_plane(), correction(), E, recob::Shower::Energy(), and lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t::evalFactor().

 {
    CalibrationInfo_t const& corr = selectCorrection(id);
    
    double const E = shower.Energy().at(shower.best_plane());
    
    return (float) corr.evalFactor(E);
 } // lar::example::ShowerCalibrationGaloreFromPID::correctionFactor()

std::unique_ptr< ROOT::Math::Interpolator > lar::example::ShowerCalibrationGaloreFromPID::createInterpolator	(	unsigned int	N,
		double const *	x,
		double const *	y
	)

staticprivate

Creates a ROOT interpolator from a set of N points.

Definition at line 311 of file ShowerCalibrationGaloreFromPID.cxx.

References max, x, and y.

Referenced by lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t::evalError(), and readParticleCalibration().

 {
    
    // decide the type of interpolation based on the available number of points
    ROOT::Math::Interpolation::Type type;
    if      (N >= 5) type = ROOT::Math::Interpolation::kAKIMA;
    else if (N >= 3) type = ROOT::Math::Interpolation::kCSPLINE;
    else             type = ROOT::Math::Interpolation::kLINEAR;
    
    auto interp
      = std::make_unique<ROOT::Math::Interpolator>(std::max(N, 2U), type);
    if (N > 1) interp->SetData(N, x, y);
    else { // we need to make up the second point
      double const x_p[2] = { *x, *x + 1. };
      double const y_p[2] = { *y, *y };
      interp->SetData(2, x_p, y_p);
    }
    return interp;
 } // lar::example::ShowerCalibrationGaloreFromPID::createInterpolator()

TDirectory * lar::example::ShowerCalibrationGaloreFromPID::OpenROOTdirectory ( std::string path )

staticprivate

Opens the specified ROOT directory, as in path/to/file.root:dir/dir.

Definition at line 221 of file ShowerCalibrationGaloreFromPID.cxx.

References lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t::applyTo(), dir, and lar::example::splitROOTpath().

Referenced by readParticleCalibration().

 {
    //
    // split the data file path
    //
    std::string filePath, ROOTdirPath;
    std::tie(filePath, ROOTdirPath) = splitROOTpath(path);
    
    //
    // find the ROOT file in the search path
    //
    std::string fullFilePath;
    cet::search_path sp("FW_SEARCH_PATH");
    // if we can't find the file in FW_SEARCH_PATH, we try in current directory
    if (!sp.find_file(filePath, fullFilePath)) fullFilePath = filePath;
    
    //
    // open the ROOT file (created new)
    //
    auto inputFile = std::make_unique<TFile>(fullFilePath.c_str(), "READ");
    if (!(inputFile->IsOpen())) {
       throw cet::exception("ShowerCalibrationGaloreFromPID")
          << "ShowerCalibrationGaloreFromPID::OpenROOTdirectory() can't read '"
          << fullFilePath << "' (from '" << filePath << "' specification)\n";
    }
    
    //
    // get the ROOT directory
    //
    TDirectory* dir = ROOTdirPath.empty()?
      inputFile.get(): inputFile->GetDirectory(ROOTdirPath.c_str());
    if (!dir) {
       throw cet::exception("ShowerCalibrationGaloreFromPID")
          << "ShowerCalibrationGaloreFromPID::OpenROOTdirectory() can't find '"
          << ROOTdirPath << "' in ROOT file '" << inputFile->GetPath() << "'\n";
    }
    
    //
    // return the directory
    //
    inputFile.release(); // do not delete the file any more
    return dir;
 } // lar::example::ShowerCalibrationGaloreFromPID::OpenROOTdirectory()

void lar::example::ShowerCalibrationGaloreFromPID::readCalibration ( std::string path )

Reads the calibration information from the specified file.

Definition at line 62 of file ShowerCalibrationGaloreFromPID.cxx.

References e.

Referenced by correction().

 {
    
    //
    // open the input file
    //
    TDirectory* CalibDir = nullptr;
    try {
       CalibDir = OpenROOTdirectory(path);
    }
    catch (cet::exception const& e) {
       // wrap the exception with context information
       throw cet::exception
         ("ShowerCalibrationGaloreFromPID", "readCalibration()", e)
         << "Reading calibration from: '" << path << "'";
    }
    if (!CalibDir) { // this would be actually a bug
       throw cet::exception
         ("ShowerCalibrationGaloreFromPID", "readCalibration()")
         << "Null directory reading calibration from: '" << path << "'";
    }
    
    // make sure that when this is over we are done with the ROOT file
    std::unique_ptr<TFile> InputFile(CalibDir->GetFile());
    
    //
    // read each calibration object and associate it with its particle category
    //
    
    Calibration_pi0    = readParticleCalibration(CalibDir, "Pi0",    111);
    
    Calibration_photon = readParticleCalibration(CalibDir, "Photon",  22);
    
    Calibration_electron
      = readParticleCalibration(CalibDir, "Electron", { -11, 11 });
    
    Calibration_muon   = readParticleCalibration(CalibDir, "Muon", { -13, 13 });
    
    Calibration_other  = readParticleCalibration(CalibDir, "Default", unknownID);
    
    //
    // release resources
    //
    
    // TFile freed by its unique pointer
    
 } // lar::example::ShowerCalibrationGaloreFromPID::readCalibration()

lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t lar::example::ShowerCalibrationGaloreFromPID::readParticleCalibration	(	TDirectory *	SourceDir,
		std::string	GraphName
	)		const

private

Reads and returns calibration information from the specified graph.

Definition at line 136 of file ShowerCalibrationGaloreFromPID.cxx.

References createInterpolator(), lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t::error, lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t::factor, lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t::maxE, lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t::minE, and verifyOrder().

Referenced by readParticleCalibration(), selectCorrection(), and verifyOrder().

 {
    CalibrationInfo_t info;
    
    // apply list is left empty
    
    //
    // retrieve the object
    //
    auto graph = details::readROOTobject<TGraphErrors>(SourceDir, GraphName);
    
    verifyOrder(graph.get());
    
    size_t const N = (size_t) graph->GetN();
    if (N == 0) {
       throw cet::exception("ShowerCalibrationGaloreFromPID")
         << "No point in graph " << SourceDir->GetPath() << "/" << GraphName
         << "\n";
    }
    
    // include the "error" on x in the full range
    info.minE = graph->GetX()[0];
    info.maxE = graph->GetX()[N - 1];
    
    // a spline; if there are at least 5 points, use AKIMA spline, that is
    // "stable" for outliers (reducing over/undershoot)
    // set to zero
    info.factor = createInterpolator(N, graph->GetX(), graph->GetY());
    
    // compute the error in the same way; kind of an approximation here
    info.error = createInterpolator(N, graph->GetX(), graph->GetEY());
    
    return info;
 } // lar::example::ShowerCalibrationGaloreFromPID::readParticleCalibration()

lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t lar::example::ShowerCalibrationGaloreFromPID::readParticleCalibration	(	TDirectory *	SourceDir,
		std::string	GraphName,
		PDGID_t	id
	)		const

private

Reads and returns calibration information from the specified graph and register a particle ID in it

Definition at line 200 of file ShowerCalibrationGaloreFromPID.cxx.

References lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t::applyTo(), and readParticleCalibration().

 { 
    CalibrationInfo_t info = readParticleCalibration(SourceDir, GraphName);
    info.applyTo(id);
    return info;
 } // lar::example::ShowerCalibrationGaloreFromPID::readParticleCalibration(ID)

lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t lar::example::ShowerCalibrationGaloreFromPID::readParticleCalibration	(	TDirectory *	SourceDir,
		std::string	GraphName,
		std::initializer_list< PDGID_t >	ids
	)		const

private

Reads and returns calibration information from the specified graph and register a list of particle IDs to it

Definition at line 209 of file ShowerCalibrationGaloreFromPID.cxx.

References lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t::applyTo(), OpenROOTdirectory(), and readParticleCalibration().

         {
    CalibrationInfo_t info = readParticleCalibration(SourceDir, GraphName);
    info.applyTo(ids);
    return info;
 } // lar::example::ShowerCalibrationGaloreFromPID::readParticleCalibration(IDs)

virtual std::string lar::example::ShowerCalibrationGaloreFromPID::report ( ) const

inlineoverridevirtual

Returns a string with a short report of the current corrections.

Implements lar::example::ShowerCalibrationGalore.

Definition at line 188 of file ShowerCalibrationGaloreFromPID.h.

189 { std::ostringstream sstr; reportTo(sstr); return sstr.str(); }

lar::example::ShowerCalibrationGaloreFromPID::reportTo

void reportTo(Stream &&out) const

Prints a short report of the current corrections.

Definition: ShowerCalibrationGaloreFromPID.h:322

template<typename Stream >

void lar::example::ShowerCalibrationGaloreFromPID::reportTo ( Stream && out ) const

Prints a short report of the current corrections.

Definition at line 322 of file ShowerCalibrationGaloreFromPID.h.

References lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t::reportTo().

 {
    out << "Corrections for:";
    out << "\n  - neutral pion:      ";
    Calibration_pi0.reportTo(std::forward<Stream>(out));
    out << "\n  - photon:            ";
    Calibration_photon.reportTo(std::forward<Stream>(out));
    out << "\n  - electron/positron: ";
    Calibration_electron.reportTo(std::forward<Stream>(out));
    out << "\n  - muon/antimuon:     ";
    Calibration_muon.reportTo(std::forward<Stream>(out));
    out << "\n  - other (default):   ";
    Calibration_other.reportTo(std::forward<Stream>(out));
    out << "\n";
 } // lar::example::ShowerCalibrationGaloreFromPID::report()

lar::example::ShowerCalibrationGaloreFromPID::CalibrationInfo_t const & lar::example::ShowerCalibrationGaloreFromPID::selectCorrection ( PDGID_t id ) const

private

Returns the correct CalibrationInfo_t for specified id.

Definition at line 113 of file ShowerCalibrationGaloreFromPID.cxx.

References Calibration_electron, Calibration_muon, Calibration_other, Calibration_photon, Calibration_pi0, readParticleCalibration(), and lar::example::ShowerCalibrationGalore::unknownID.

 {
    switch (id) {
       case  111: // pi0
          return Calibration_pi0;
       case   22: // photon
          return Calibration_photon;
       case  -11: // electron
       case  +11: // positron
          return Calibration_electron;
       case  -13: // muon
       case  +13: // antimuon
          return Calibration_muon;
       case unknownID:
       default:
          return Calibration_other;
    } // switch
 } // lar::example::ShowerCalibrationGaloreFromPID::selectCorrection()

void lar::example::ShowerCalibrationGaloreFromPID::verifyOrder ( TGraph const * graph )

static

Verifies that points in specified graph have increasing abscissa

Exceptions

cet::exception if points are not sorted by growing x

Definition at line 174 of file ShowerCalibrationGaloreFromPID.cxx.

References readParticleCalibration(), and x.

Referenced by readParticleCalibration().

 {
    
    if (!graph) {
       throw cet::exception("ShowerCalibrationGaloreFromPID")
          << "VerifyOrder(): invalid graph specified\n";
    }
    
    size_t const N = graph->GetN();
    if (N < 2) return;
    
    Double_t const* x = graph->GetX();
    
    for (size_t i = 1; i < N; ++i) {
       if (x[i-1] > x[i]) {
          throw cet::exception("ShowerCalibrationGaloreFromPID")
          << "VerifyOrder(): points in graph '" << graph->GetName()
          << "' are not sorted in abscissa\n";
       }
    } // while
 } // lar::example::ShowerCalibrationGaloreFromPID::verifyOrder()

Member Data Documentation

CalibrationInfo_t lar::example::ShowerCalibrationGaloreFromPID::Calibration_electron

private

electron/positron calibration

Definition at line 237 of file ShowerCalibrationGaloreFromPID.h.

Referenced by selectCorrection().

CalibrationInfo_t lar::example::ShowerCalibrationGaloreFromPID::Calibration_muon

private

muon/antimuon calibration

Definition at line 238 of file ShowerCalibrationGaloreFromPID.h.

Referenced by selectCorrection().

CalibrationInfo_t lar::example::ShowerCalibrationGaloreFromPID::Calibration_other

private

default calibration

Definition at line 239 of file ShowerCalibrationGaloreFromPID.h.

Referenced by selectCorrection().

CalibrationInfo_t lar::example::ShowerCalibrationGaloreFromPID::Calibration_photon

private

photon calibration

Definition at line 236 of file ShowerCalibrationGaloreFromPID.h.

Referenced by selectCorrection().

CalibrationInfo_t lar::example::ShowerCalibrationGaloreFromPID::Calibration_pi0

private

neutral pion calibration

Definition at line 235 of file ShowerCalibrationGaloreFromPID.h.

Referenced by selectCorrection().

constexpr PDGID_t lar::example::ShowerCalibrationGalore::unknownID = 0

staticinherited

A mnemonic constant for unknown particle ID.

Definition at line 69 of file ShowerCalibrationGalore.h.

Referenced by selectCorrection().

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

/cvmfs/larsoft.opensciencegrid.org/products/larexamples/v07_00_19/source/larexamples/Services/ShowerCalibrationGalore/Providers/ShowerCalibrationGaloreFromPID.h
/cvmfs/larsoft.opensciencegrid.org/products/larexamples/v07_00_19/source/larexamples/Services/ShowerCalibrationGalore/Providers/ShowerCalibrationGaloreFromPID.cxx

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Calibration file format

Calibration factors from the input

Configuration parameters

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation