lar::example::ShowerCalibrationGalore Class Reference

Interface for a shower calibration service provider. More...

#include "ShowerCalibrationGalore.h"

Inheritance diagram for lar::example::ShowerCalibrationGalore:

Classes
struct	Correction_t
	A correction factor with global uncertainty. More...

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

Public Member Functions
virtual	~ShowerCalibrationGalore ()=default
virtual std::string	report () const =0
	Returns a string with a short report of the current corrections. More...
Correction query
virtual float	correctionFactor (recob::Shower const &shower, PDGID_t PDGID=unknownID) const =0
	Returns a correction factor for a given reconstructed shower. More...
virtual Correction_t	correction (recob::Shower const &shower, PDGID_t PDGID=unknownID) const =0
	Returns the correction for a given reconstructed shower. More...

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

Detailed Description

Interface for a shower calibration service provider.

See also

ShowerCalibrationGalore example overview

The service provider computes a calibration factor for a reconstructed shower.

It offers:

• correction() to get the calibration factor with uncertainty
• correctionFactor() to get just the calibration factor

This is an abstract interface. The corresponding art service interface is called ShowerCalibrationGaloreService.

Definition at line 44 of file ShowerCalibrationGalore.h.

Member Typedef Documentation

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

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

Definition at line 66 of file ShowerCalibrationGalore.h.

Constructor & Destructor Documentation

virtual lar::example::ShowerCalibrationGalore::~ShowerCalibrationGalore ( )

virtualdefault

Member Function Documentation

virtual Correction_t lar::example::ShowerCalibrationGalore::correction ( recob::Shower const &  shower, PDGID_t  PDGID = unknownID  ) const

pure virtual

Returns the correction for a given reconstructed shower.

Parameters

shower	the shower to be calibrated
PDGID	hypothesis on type of particle originating the shower

Returns

the correction with its uncertainty

See also

correctionFactor()

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

The particle type hypothesis argument is optional, and the invalid type 0 (unknownID) implies that no hypothesis is present.

Implemented in lar::example::ShowerCalibrationGaloreFromPID, and lar::example::ShowerCalibrationGaloreScale.

virtual float lar::example::ShowerCalibrationGalore::correctionFactor ( recob::Shower const &  shower, PDGID_t  PDGID = unknownID  ) const

pure virtual

Returns a correction factor for a given reconstructed shower.

Parameters

shower	the shower to be calibrated
PDGID	hypothesis on type of particle originating the shower

Returns

the 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.

The particle type hypothesis argument is optional, and the invalid type 0 (unknownID) implies that no hypothesis is present.

Implemented in lar::example::ShowerCalibrationGaloreFromPID, and lar::example::ShowerCalibrationGaloreScale.

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

pure virtual

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

Implemented in lar::example::ShowerCalibrationGaloreFromPID, and lar::example::ShowerCalibrationGaloreScale.

Member Data Documentation

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

static

A mnemonic constant for unknown particle ID.

Definition at line 69 of file ShowerCalibrationGalore.h.

Referenced by lar::example::ShowerCalibrationGaloreFromPID::selectCorrection().

---

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

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