phot::PhotonLibrary Class Reference

#include "PhotonLibrary.h"

Inheritance diagram for phot::PhotonLibrary:

Public Types
using	Counts_t = const float *
	Type for visibility count per optical channel. More...
using	T0s_t = const float *
	Type for time of arrival per optical channel. More...
using	Params_t = std::vector< float > const *
using	Functions_t = TF1 *

Public Member Functions
	PhotonLibrary (art::TFileDirectory *pDir=nullptr)
	If no valid pDir is provided, storage features will not be supported. More...
TTree *	ProduceTTree () const
virtual float	GetCount (size_t Voxel, size_t OpChannel) const override
void	SetCount (size_t Voxel, size_t OpChannel, float Count)
float	GetTimingPar (size_t Voxel, size_t OpChannel, size_t parnum) const
void	SetTimingPar (size_t Voxel, size_t OpChannel, float Count, size_t parnum)
void	SetTimingTF1 (size_t Voxel, size_t OpChannel, TF1 func)
virtual float	GetReflCount (size_t Voxel, size_t OpChannel) const override
void	SetReflCount (size_t Voxel, size_t OpChannel, float Count)
virtual float	GetReflT0 (size_t Voxel, size_t OpChannel) const override
void	SetReflT0 (size_t Voxel, size_t OpChannel, float reflT0)
virtual float const *	GetCounts (size_t Voxel) const override
	Returns a pointer to NOpChannels() visibility values, one per channel. More...
const std::vector< float > *	GetTimingPars (size_t Voxel) const
TF1 *	GetTimingTF1s (size_t Voxel) const
virtual float const *	GetReflCounts (size_t Voxel) const override
virtual float const *	GetReflT0s (size_t Voxel) const override
bool	hasTiming () const
	Returns whether the current library deals with time propagation distributions. More...
virtual bool	hasReflected () const override
	Returns whether the current library deals with reflected light count. More...
virtual bool	hasReflectedT0 () const override
	Returns whether the current library deals with reflected light timing. More...
void	StoreLibraryToFile (std::string LibraryFile, bool storeReflected=false, bool storeReflT0=false, size_t storeTiming=0) const
void	LoadLibraryFromFile (std::string LibraryFile, size_t NVoxels, bool storeReflected=false, bool storeReflT0=false, size_t storeTiming=0, int maxrange=200)
void	CreateEmptyLibrary (size_t NVoxels, size_t NChannels, bool storeReflected=false, bool storeReflT0=false, size_t storeTiming=0)
size_t	LibrarySize () const
	Returns the number of elements in the library. More...
Metadata: voxel information
bool	hasVoxelDef () const
	Returns whether voxel metadata is available. More...
sim::PhotonVoxelDef const &	GetVoxelDef () const
void	SetVoxelDef (sim::PhotonVoxelDef const &voxelDef)

Private Member Functions
virtual int	NOpChannels () const override
virtual int	NVoxels () const override
virtual bool	isVoxelValid (size_t Voxel) const override
bool	isVoxelValidImpl (size_t Voxel) const
size_t	uncheckedIndex (size_t Voxel, size_t OpChannel) const
	Returns the index of visibility of specified voxel and cell. More...
float	uncheckedAccess (size_t Voxel, size_t OpChannel) const
	Unchecked access to a visibility datum. More...
float &	uncheckedAccess (size_t Voxel, size_t OpChannel)
	Unchecked access to a visibility datum. More...
float	uncheckedAccessRefl (size_t Voxel, size_t OpChannel) const
	Unchecked access to a reflected visibility datum. More...
float &	uncheckedAccessRefl (size_t Voxel, size_t OpChannel)
	Unchecked access to a reflected visibility datum. More...
float	uncheckedAccessReflT (size_t Voxel, size_t OpChannel) const
	Unchecked access to a reflected T0 visibility datum. More...
float &	uncheckedAccessReflT (size_t Voxel, size_t OpChannel)
	Unchecked access to a reflected T0 visibility datum. More...
float	uncheckedAccessTimingPar (size_t Voxel, size_t OpChannel, size_t parnum) const
	Unchecked access to a parameter the time distribution. More...
float &	uncheckedAccessTimingPar (size_t Voxel, size_t OpChannel, size_t parnum)
	Unchecked access to a parameter of the time distribution. More...
TF1 &	uncheckedAccessTimingTF1 (size_t Voxel, size_t OpChannel)
	Unchecked access to a parameter of the time distribution. More...
const TF1 &	uncheckedAccessTimingTF1 (size_t Voxel, size_t OpChannel) const
	Unchecked access to a parameter of the time distribution. More...
void	LoadMetadata (TDirectory &srcDir)
	Reads the metadata from specified ROOT directory and sets it as current. More...
void	StoreMetadata () const
	Writes the current metadata (if any) into the ROOT output file. More...

Static Private Member Functions
static size_t	ExtractNOpChannels (TTree *tree)
	Returns the number of optical channels in the specified tree. More...
static int	size_t2int (size_t val)
	Converts size_t into integer. More...

Private Attributes
bool	fHasReflected = false
	Whether the current library deals with reflected light counts. More...
bool	fHasReflectedT0
	Whether the current library deals with reflected light timing. More...
size_t	fHasTiming
	Whether the current library deals with time propagation distribution. More...
util::LazyVector< float >	fLookupTable
util::LazyVector< float >	fReflLookupTable
util::LazyVector< float >	fReflTLookupTable
util::LazyVector< std::vector< float > >	fTimingParLookupTable
util::LazyVector< TF1 >	fTimingParTF1LookupTable
std::string	fTimingParFormula
size_t	fTimingParNParameters
size_t	fNOpChannels
size_t	fNVoxels
std::optional< sim::PhotonVoxelDef >	fVoxelDef
	Voxel definition loaded from library metadata. More...
art::TFileDirectory *	fDir = nullptr
	ROOT directory where to write data. More...

Static Private Attributes
static std::string const	OpChannelBranchName = "OpChannel"
	Name of the optical channel number in the input tree. More...

Detailed Description

Definition at line 25 of file PhotonLibrary.h.

Member Typedef Documentation

using phot::IPhotonLibrary::Counts_t = const float*

inherited

Type for visibility count per optical channel.

Definition at line 17 of file IPhotonLibrary.h.

using phot::IPhotonLibrary::Functions_t = TF1*

inherited

Type for parametrization function (which is not part of this interface yet).

Definition at line 28 of file IPhotonLibrary.h.

using phot::IPhotonLibrary::Params_t = std::vector<float> const*

inherited

Type for function parameters (which is not part of this interface yet).

Definition at line 24 of file IPhotonLibrary.h.

using phot::IPhotonLibrary::T0s_t = const float*

inherited

Type for time of arrival per optical channel.

Definition at line 20 of file IPhotonLibrary.h.

Constructor & Destructor Documentation

phot::PhotonLibrary::PhotonLibrary

(

art::TFileDirectory *

pDir = nullptr

)

If no valid pDir is provided, storage features will not be supported.

Definition at line 45 of file PhotonLibrary.cxx.

: fDir(pDir) {}

Member Function Documentation

void phot::PhotonLibrary::CreateEmptyLibrary	(	size_t	NVoxels,
		size_t	NChannels,
		bool	storeReflected = false,
		bool	storeReflT0 = false,
		size_t	storeTiming = 0
	)

Definition at line 131 of file PhotonLibrary.cxx.

References util::LazyVector< T, A >::clear(), fHasReflected, fHasReflectedT0, fHasTiming, fLookupTable, fNOpChannels, fNVoxels, fReflLookupTable, fReflTLookupTable, fTimingParLookupTable, fTimingParTF1LookupTable, phot::IPhotonLibrary::LibrarySize(), NOpChannels(), NVoxels(), and util::LazyVector< T, A >::resize().

  {
    fLookupTable.clear();
    fReflLookupTable.clear();
    fReflTLookupTable.clear();
    fTimingParLookupTable.clear();
    fTimingParTF1LookupTable.clear();

    fNVoxels = NVoxels;
    fNOpChannels = NOpChannels;

    fLookupTable.resize(LibrarySize());
    fHasReflected = storeReflected;
    if (storeReflected) fReflLookupTable.resize(LibrarySize());
    fHasReflectedT0 = storeReflT0;
    if (storeReflT0) fReflTLookupTable.resize(LibrarySize());
    fHasTiming = storeTiming;
    if (storeTiming != 0) {
      fTimingParLookupTable.resize(LibrarySize());
      fTimingParTF1LookupTable.resize(LibrarySize());
    }
  }

size_t phot::PhotonLibrary::ExtractNOpChannels ( TTree *  tree )

staticprivate

Returns the number of optical channels in the specified tree.

Definition at line 557 of file PhotonLibrary.cxx.

References MF_LOG_DEBUG, art::errors::NotFound, and OpChannelBranchName.

Referenced by LoadLibraryFromFile().

  {
    TBranch* channelBranch = tree->GetBranch(OpChannelBranchName.c_str());
    if (!channelBranch) {
      throw art::Exception(art::errors::NotFound)
        << "Tree '" << tree->GetName() << "' has no branch 'OpChannel'";
    }

    // fix a new local address for the branch
    char* oldAddress = channelBranch->GetAddress();
    Int_t channel;
    channelBranch->SetAddress(&channel);
    Int_t maxChannel = -1;

    // read all the channel values and pick the largest one
    Long64_t iEntry = 0;
    while (channelBranch->GetEntry(iEntry++)) {
      if (channel > maxChannel) maxChannel = channel;
    } // while

    MF_LOG_DEBUG("PhotonLibrary") << "Detected highest channel to be " << maxChannel << " from "
                                  << iEntry << " tree entries";

    // restore the old branch address
    channelBranch->SetAddress(oldAddress);

    return size_t(maxChannel + 1);

  } // PhotonLibrary::ExtractNOpChannels()

float phot::PhotonLibrary::GetCount ( size_t  Voxel, size_t  OpChannel  ) const

overridevirtual

Implements phot::IPhotonLibrary.

Definition at line 305 of file PhotonLibrary.cxx.

References fNOpChannels, fNVoxels, and uncheckedAccess().

  {
    if ((Voxel >= fNVoxels) || (OpChannel >= fNOpChannels))
      return 0;
    else
      return uncheckedAccess(Voxel, OpChannel);
  }

float const * phot::PhotonLibrary::GetCounts ( size_t  Voxel ) const

overridevirtual

Returns a pointer to NOpChannels() visibility values, one per channel.

Implements phot::IPhotonLibrary.

Definition at line 392 of file PhotonLibrary.cxx.

References util::LazyVector< T, A >::data_address(), fLookupTable, fNVoxels, and uncheckedIndex().

  {
    if (Voxel >= fNVoxels)
      return nullptr;
    else
      return fLookupTable.data_address(uncheckedIndex(Voxel, 0));
  }

float phot::PhotonLibrary::GetReflCount ( size_t  Voxel, size_t  OpChannel  ) const

overridevirtual

Implements phot::IPhotonLibrary.

Definition at line 322 of file PhotonLibrary.cxx.

References fNOpChannels, fNVoxels, and uncheckedAccessRefl().

  {
    if ((Voxel >= fNVoxels) || (OpChannel >= fNOpChannels))
      return 0;
    else
      return uncheckedAccessRefl(Voxel, OpChannel);
  }

float const * phot::PhotonLibrary::GetReflCounts ( size_t  Voxel ) const

overridevirtual

Implements phot::IPhotonLibrary.

Definition at line 440 of file PhotonLibrary.cxx.

References util::LazyVector< T, A >::data_address(), fNVoxels, fReflLookupTable, and uncheckedIndex().

  {
    if (Voxel >= fNVoxels)
      return nullptr;
    else
      return fReflLookupTable.data_address(uncheckedIndex(Voxel, 0));
  }

float phot::PhotonLibrary::GetReflT0 ( size_t  Voxel, size_t  OpChannel  ) const

overridevirtual

Implements phot::IPhotonLibrary.

Definition at line 331 of file PhotonLibrary.cxx.

References fNOpChannels, fNVoxels, and uncheckedAccessReflT().

  {
    if ((Voxel >= fNVoxels) || (OpChannel >= fNOpChannels))
      return 0;
    else
      return uncheckedAccessReflT(Voxel, OpChannel);
  }

float const * phot::PhotonLibrary::GetReflT0s ( size_t  Voxel ) const

overridevirtual

Implements phot::IPhotonLibrary.

Definition at line 450 of file PhotonLibrary.cxx.

References util::LazyVector< T, A >::data_address(), fNVoxels, fReflTLookupTable, and uncheckedIndex().

  {
    if (Voxel >= fNVoxels)
      return nullptr;
    else
      return fReflTLookupTable.data_address(uncheckedIndex(Voxel, 0));
  }

float phot::PhotonLibrary::GetTimingPar	(	size_t	Voxel,
		size_t	OpChannel,
		size_t	parnum
	)		const

Definition at line 314 of file PhotonLibrary.cxx.

References fNOpChannels, fNVoxels, and uncheckedAccessTimingPar().

Referenced by phot::PhotonVisibilityService::GetLibraryTimingParEntry().

  {
    if ((Voxel >= fNVoxels) || (OpChannel >= fNOpChannels))
      return 0;
    else
      return uncheckedAccessTimingPar(Voxel, OpChannel, parnum);
  } //----------------------------------------------------

const std::vector< float > * phot::PhotonLibrary::GetTimingPars

(

size_t

Voxel

)

const

Definition at line 402 of file PhotonLibrary.cxx.

References util::LazyVector< T, A >::data_address(), fNVoxels, fTimingParLookupTable, and uncheckedIndex().

Referenced by phot::PhotonVisibilityService::GetLibraryTimingParEntries().

  {
    if (Voxel >= fNVoxels)
      return nullptr;
    else
      return fTimingParLookupTable.data_address(uncheckedIndex(Voxel, 0));
  }

TF1 * phot::PhotonLibrary::GetTimingTF1s

(

size_t

Voxel

)

const

Definition at line 412 of file PhotonLibrary.cxx.

References util::LazyVector< T, A >::data_address(), fNVoxels, fTimingParTF1LookupTable, and uncheckedIndex().

Referenced by phot::PhotonVisibilityService::GetLibraryTimingTF1Entries().

  {
    if (Voxel >= fNVoxels) return nullptr;
    /*
     * Sorry, Universe, but we can't undergo ROOT's bad design hell.
     * TF1::GetRandom() is non-const member, because it uses some internal
     * integral information which can be produced on the spot instead than
     * always be present. That's called caching, it's Good, but it must not
     * interfere with constantness of the interface (in fact, this is one of
     * the few acceptable uses of `mutable` members).
     * Because of this, this method can't return a constant `TF1`, therefore
     * it can't be constant, therefore the underlying access returning a
     * constant object is not acceptable.
     * So I do the Bad thing.
     * Plus I opened JIRA ROOT-9549
     * (https://sft.its.cern.ch/jira/browse/ROOT-9549).
     * After that is solved, this method should become:
     *
     * TF1 const* PhotonLibrary::GetTimingTF1s(size_t Voxel) const
     *
     * and the users should update their code accordingly.
     */
    else
      return const_cast<TF1*>(fTimingParTF1LookupTable.data_address(uncheckedIndex(Voxel, 0)));
  }

sim::PhotonVoxelDef const& phot::PhotonLibrary::GetVoxelDef ( ) const

inline

Returns the current voxel metadata (undefined behaviour if none).

See also

hasVoxelDef()

Definition at line 89 of file PhotonLibrary.h.

Referenced by phot::PhotonVisibilityService::LoadLibrary(), LoadLibraryFromFile(), and StoreMetadata().

    {
      assert(fVoxelDef);
      return *fVoxelDef;
    }

virtual bool phot::PhotonLibrary::hasReflected ( ) const

inlineoverridevirtual

Returns whether the current library deals with reflected light count.

Implements phot::IPhotonLibrary.

Definition at line 59 of file PhotonLibrary.h.

Referenced by StoreLibraryToFile().

{ return fHasReflected; }

virtual bool phot::PhotonLibrary::hasReflectedT0 ( ) const

inlineoverridevirtual

Returns whether the current library deals with reflected light timing.

Implements phot::IPhotonLibrary.

Definition at line 62 of file PhotonLibrary.h.

Referenced by StoreLibraryToFile().

{ return fHasReflectedT0; }

bool phot::PhotonLibrary::hasTiming ( ) const

inline

Returns whether the current library deals with time propagation distributions.

Definition at line 56 of file PhotonLibrary.h.

Referenced by StoreLibraryToFile().

{ return fHasTiming; }

bool phot::PhotonLibrary::hasVoxelDef ( ) const

inline

Returns whether voxel metadata is available.

Definition at line 85 of file PhotonLibrary.h.

Referenced by phot::PhotonVisibilityService::LoadLibrary(), LoadLibraryFromFile(), and StoreMetadata().

{ return fVoxelDef.has_value(); }

virtual bool phot::PhotonLibrary::isVoxelValid ( size_t  Voxel ) const

inlineoverrideprivatevirtual

Reimplemented from phot::IPhotonLibrary.

Definition at line 106 of file PhotonLibrary.h.

{ return isVoxelValidImpl(Voxel); }

bool phot::PhotonLibrary::isVoxelValidImpl ( size_t  Voxel ) const

inlineprivate

Definition at line 134 of file PhotonLibrary.h.

{ return Voxel < fNVoxels; }

size_t phot::IPhotonLibrary::LibrarySize ( ) const

inlineinherited

Returns the number of elements in the library.

Definition at line 53 of file IPhotonLibrary.h.

References phot::IPhotonLibrary::NOpChannels(), and phot::IPhotonLibrary::NVoxels().

Referenced by CreateEmptyLibrary(), and LoadLibraryFromFile().

{ return NVoxels() * NOpChannels(); }

void phot::PhotonLibrary::LoadLibraryFromFile	(	std::string	LibraryFile,
		size_t	NVoxels,
		bool	storeReflected = false,
		bool	storeReflT0 = false,
		size_t	storeTiming = 0,
		int	maxrange = 200
	)

Definition at line 161 of file PhotonLibrary.cxx.

References util::LazyVector< T, A >::clear(), util::LazyVector< T, A >::data_init(), ExtractNOpChannels(), f, fHasReflected, fHasReflectedT0, fHasTiming, fLookupTable, fNOpChannels, fNVoxels, fReflLookupTable, fReflTLookupTable, fTimingParFormula, fTimingParLookupTable, fTimingParNParameters, fTimingParTF1LookupTable, GetVoxelDef(), hasVoxelDef(), phot::IPhotonLibrary::LibrarySize(), LoadMetadata(), n, NVoxels(), util::LazyVector< T, A >::resize(), uncheckedAccess(), uncheckedAccessRefl(), uncheckedAccessReflT(), and uncheckedAccessTimingTF1().

Referenced by phot::PhotonVisibilityService::LoadLibrary().

  {
    fLookupTable.clear();
    fReflLookupTable.clear();
    fReflTLookupTable.clear();
    fTimingParLookupTable.clear();
    fTimingParTF1LookupTable.clear();

    mf::LogInfo("PhotonLibrary") << "Reading photon library from input file: "
                                 << LibraryFile.c_str() << std::endl;

    TFile* f = nullptr;
    TTree* tt = nullptr;
    TDirectory* pSrcDir = nullptr;

    try {
      f = TFile::Open(LibraryFile.c_str());
      tt = (TTree*)f->Get("PhotonLibraryData");
      if (tt) { pSrcDir = f; }
      else { // Library not in the top directory
        TKey* key = f->FindKeyAny("PhotonLibraryData");
        if (key) {
          tt = (TTree*)key->ReadObj();
          pSrcDir = key->GetMotherDir();
        }
        else {
          mf::LogError("PhotonLibrary") << "PhotonLibraryData not found in file" << LibraryFile;
        }
      }
    }
    catch (...) {
      throw cet::exception("PhotonLibrary")
        << "Error in ttree load, reading photon library: " << LibraryFile << "\n";
    }

    Int_t Voxel;
    Int_t OpChannel;
    Float_t Visibility;
    Float_t ReflVisibility;
    Float_t ReflTfirst;
    std::vector<Float_t> timing_par;

    tt->SetBranchAddress("Voxel", &Voxel);
    tt->SetBranchAddress("OpChannel", &OpChannel);
    tt->SetBranchAddress("Visibility", &Visibility);

    fHasTiming = getTiming;

    fHasReflected = getReflected;
    if (getReflected) tt->SetBranchAddress("ReflVisibility", &ReflVisibility);
    fHasReflectedT0 = getReflT0;
    if (getReflT0) tt->SetBranchAddress("ReflTfirst", &ReflTfirst);

    fNVoxels = NVoxels;
    fNOpChannels = PhotonLibrary::ExtractNOpChannels(tt); // EXPENSIVE!!!

    // with STL vectors, where `resize()` directly controls the allocation of
    // memory, reserving the space is redundant; not so with `util::LazyVector`,
    // where `resize()` never increases the memory; `data_init()` allocates
    // all the storage we need at once, effectively suppressing the laziness
    // of the vector (by design, that was only relevant in `CreateEmptyLibrary()`)
    fLookupTable.resize(LibrarySize());
    fLookupTable.data_init(LibrarySize());

    if (fHasTiming != 0) {
      timing_par.resize(getTiming);
      tt->SetBranchAddress("timing_par", timing_par.data());
      fTimingParNParameters = fHasTiming;
      // should be pSrcDir->Get()? kept as is for backward compatibility
      TNamed* n = (TNamed*)f->Get("fTimingParFormula");
      if (!n)
        mf::LogError("PhotonLibrary")
          << "Error reading the photon propagation formula. Please check the photon library."
          << std::endl;
      fTimingParFormula = n->GetTitle();
      fTimingParTF1LookupTable.resize(LibrarySize());
      fTimingParTF1LookupTable.data_init(LibrarySize());
      mf::LogInfo("PhotonLibrary")
        << "Time parametrization is activated. Using the formula: " << fTimingParFormula << " with "
        << fTimingParNParameters << " parameters." << std::endl;
    }
    if (fHasReflected) {
      fReflLookupTable.resize(LibrarySize());
      fReflLookupTable.data_init(LibrarySize());
    }
    if (fHasReflectedT0) {
      fReflTLookupTable.resize(LibrarySize());
      fReflTLookupTable.data_init(LibrarySize());
    }

    size_t NEntries = tt->GetEntries();

    for (size_t i = 0; i != NEntries; ++i) {

      tt->GetEntry(i);

      // Set the visibility at this optical channel
      uncheckedAccess(Voxel, OpChannel) = Visibility;

      if (fHasReflected) uncheckedAccessRefl(Voxel, OpChannel) = ReflVisibility;
      if (fHasReflectedT0) uncheckedAccessReflT(Voxel, OpChannel) = ReflTfirst;
      if (fHasTiming != 0) {
        // TODO: use TF1::Copy
        TF1 timingfunction(Form("timing_%i_%i", Voxel, OpChannel),
                           fTimingParFormula.c_str(),
                           timing_par[0],
                           fTimingMaxRange);
        timingfunction.SetParameter(
          0,
          0.0); //first parameter is now in the range. Let's do this to keep compatible with old libraries.
        for (size_t k = 1; k < fTimingParNParameters; k++) {
          timingfunction.SetParameter(k, timing_par[k]);
        }

        uncheckedAccessTimingTF1(Voxel, OpChannel) = timingfunction;
      }
    } // for entries

    LoadMetadata(*pSrcDir);
    {
      mf::LogInfo log("PhotonLibrary");
      log << "Photon lookup table size : " << NVoxels << " voxels,  " << fNOpChannels
          << " channels";
      if (hasVoxelDef())
        log << "; " << GetVoxelDef();
      else
        log << " (no voxel geometry included)";
    }

    try {
      f->Close();
    }
    catch (...) {
      mf::LogError("PhotonLibrary") << "Error in closing file : " << LibraryFile;
    }
  }

void phot::PhotonLibrary::LoadMetadata ( TDirectory &  srcDir )

private

Reads the metadata from specified ROOT directory and sets it as current.

Definition at line 459 of file PhotonLibrary.cxx.

References fVoxelDef.

Referenced by LoadLibraryFromFile().

  {

    constexpr std::size_t NExpectedKeys = 9U;

    std::vector<std::string> missingKeys;

    RooReader<RooInt, Int_t> readInt{srcDir, missingKeys};
    RooReader<RooDouble, Double_t> readDouble{srcDir, missingKeys};

    // FIXME: Not sure initializing to 0 is appropriate.
    double xMin{};
    double xMax{};
    int xN{};
    double yMin{};
    double yMax{};
    int yN{};
    double zMin{};
    double zMax{};
    int zN{};
    if (auto metaValue = readDouble("MinX")) xMin = *metaValue;
    if (auto metaValue = readDouble("MaxX")) xMax = *metaValue;
    if (auto metaValue = readInt("NDivX")) xN = *metaValue;
    if (auto metaValue = readDouble("MinY")) yMin = *metaValue;
    if (auto metaValue = readDouble("MaxY")) yMax = *metaValue;
    if (auto metaValue = readInt("NDivY")) yN = *metaValue;
    if (auto metaValue = readDouble("MinZ")) zMin = *metaValue;
    if (auto metaValue = readDouble("MaxZ")) zMax = *metaValue;
    if (auto metaValue = readInt("NDivZ")) zN = *metaValue;

    if (!missingKeys.empty()) {
      if (missingKeys.size() != NExpectedKeys) {
        mf::LogError log("PhotonLibrary");
        log << "Photon library at '" << srcDir.GetPath() << "' is missing " << missingKeys.size()
            << " metadata elements:";
        for (auto const& key : missingKeys)
          log << " '" << key << "'";
      }
      else {
        mf::LogTrace("PhotonLibrary") << "No voxel metadata found in '" << srcDir.GetPath() << "'";
      }
      return;
    } // if missing keys

    fVoxelDef.emplace(xMin, xMax, xN, yMin, yMax, yN, zMin, zMax, zN);

  } // PhotonLibrary::LoadMetadata()

virtual int phot::PhotonLibrary::NOpChannels ( ) const

inlineoverrideprivatevirtual

Implements phot::IPhotonLibrary.

Definition at line 103 of file PhotonLibrary.h.

Referenced by CreateEmptyLibrary().

{ return fNOpChannels; }

virtual int phot::PhotonLibrary::NVoxels ( ) const

inlineoverrideprivatevirtual

Implements phot::IPhotonLibrary.

Definition at line 104 of file PhotonLibrary.h.

Referenced by CreateEmptyLibrary(), and LoadLibraryFromFile().

{ return fNVoxels; }

TTree* phot::PhotonLibrary::ProduceTTree

(

)

const

void phot::PhotonLibrary::SetCount	(	size_t	Voxel,
		size_t	OpChannel,
		float	Count
	)

Definition at line 341 of file PhotonLibrary.cxx.

References fNOpChannels, fNVoxels, and uncheckedAccess().

Referenced by phot::PhotonVisibilityService::SetLibraryEntry().

  {
    if ((Voxel >= fNVoxels) || (OpChannel >= fNOpChannels))
      mf::LogError("PhotonLibrary")
        << "Error - attempting to set count in voxel " << Voxel << " which is out of range";
    else
      uncheckedAccess(Voxel, OpChannel) = Count;
  }

void phot::PhotonLibrary::SetReflCount	(	size_t	Voxel,
		size_t	OpChannel,
		float	Count
	)

Definition at line 371 of file PhotonLibrary.cxx.

References fNOpChannels, fNVoxels, and uncheckedAccessRefl().

Referenced by phot::PhotonVisibilityService::SetLibraryEntry().

  {
    if ((Voxel >= fNVoxels) || (OpChannel >= fNOpChannels))
      mf::LogError("PhotonLibrary")
        << "Error - attempting to set count in voxel " << Voxel << " which is out of range";
    else
      uncheckedAccessRefl(Voxel, OpChannel) = Count;
  }

void phot::PhotonLibrary::SetReflT0	(	size_t	Voxel,
		size_t	OpChannel,
		float	reflT0
	)

Definition at line 381 of file PhotonLibrary.cxx.

References fNOpChannels, fNVoxels, and uncheckedAccessReflT().

Referenced by phot::PhotonVisibilityService::SetLibraryReflT0Entry().

  {
    if ((Voxel >= fNVoxels) || (OpChannel >= fNOpChannels))
      mf::LogError("PhotonLibrary")
        << "Error - attempting to set count in voxel " << Voxel << " which is out of range";
    else
      uncheckedAccessReflT(Voxel, OpChannel) = Count;
  }

void phot::PhotonLibrary::SetTimingPar	(	size_t	Voxel,
		size_t	OpChannel,
		float	Count,
		size_t	parnum
	)

Definition at line 351 of file PhotonLibrary.cxx.

References fNOpChannels, fNVoxels, and uncheckedAccessTimingPar().

Referenced by phot::PhotonVisibilityService::SetLibraryTimingParEntry().

  {
    if ((Voxel >= fNVoxels) || (OpChannel >= fNOpChannels))
      mf::LogError("PhotonLibrary") << "Error - attempting to set timing t0 count in voxel "
                                    << Voxel << " which is out of range";
    else
      uncheckedAccessTimingPar(Voxel, OpChannel, parnum) = Count;
  }

void phot::PhotonLibrary::SetTimingTF1	(	size_t	Voxel,
		size_t	OpChannel,
		TF1	func
	)

Definition at line 361 of file PhotonLibrary.cxx.

References fNOpChannels, fNVoxels, and uncheckedAccessTimingTF1().

Referenced by phot::PhotonVisibilityService::SetLibraryTimingTF1Entry().

  {
    if ((Voxel >= fNVoxels) || (OpChannel >= fNOpChannels))
      mf::LogError("PhotonLibrary") << "Error - attempting to set a propagation function in voxel "
                                    << Voxel << " which is out of range";
    else
      uncheckedAccessTimingTF1(Voxel, OpChannel) = func;
  }

void phot::PhotonLibrary::SetVoxelDef ( sim::PhotonVoxelDef const &  voxelDef )

inline

Copies the specified voxel definition into our own (overwrites the existing metadata if any).

Definition at line 97 of file PhotonLibrary.h.

Referenced by phot::PhotonVisibilityService::LoadLibrary().

{ fVoxelDef = voxelDef; }

static int phot::PhotonLibrary::size_t2int ( size_t  val )

inlinestaticprivate

Converts size_t into integer.

Definition at line 216 of file PhotonLibrary.h.

Referenced by StoreLibraryToFile().

    {
      constexpr size_t int_max_as_size_t{std::numeric_limits<int>::max()};
      return val <= int_max_as_size_t ? static_cast<int>(val) : -1;
    }

void phot::PhotonLibrary::StoreLibraryToFile	(	std::string	LibraryFile,
		bool	storeReflected = false,
		bool	storeReflT0 = false,
		size_t	storeTiming = 0
	)		const

Definition at line 49 of file PhotonLibrary.cxx.

References fDir, fLookupTable, fNOpChannels, fNVoxels, fReflLookupTable, fTimingParLookupTable, hasReflected(), hasReflectedT0(), hasTiming(), OpChannelBranchName, util::LazyVector< T, A >::size(), size_t2int(), StoreMetadata(), uncheckedAccess(), uncheckedAccessRefl(), uncheckedAccessReflT(), and uncheckedAccessTimingPar().

Referenced by phot::PhotonVisibilityService::StoreLibrary().

  {
    mf::LogInfo("PhotonLibrary") << "Writing photon library to file";

    if (!fDir) {
      throw cet::exception("PhotonLibrary")
        << "StoreLibraryToFile(): no ROOT file provided, can't store anything.\n";
    }

    TTree* tt = fDir->make<TTree>("PhotonLibraryData", "PhotonLibraryData");

    Int_t Voxel = 0;
    Int_t OpChannel = 0;
    Float_t Visibility = 0;
    Float_t ReflVisibility = 0;
    Float_t ReflTfirst = 0;
    Float_t* timing_par = nullptr;

    tt->Branch("Voxel", &Voxel, "Voxel/I");
    tt->Branch(OpChannelBranchName.c_str(), &OpChannel, (OpChannelBranchName + "/I").c_str());
    tt->Branch("Visibility", &Visibility, "Visibility/F");

    if (storeTiming != 0) {
      if (!hasTiming()) {
        // if this happens, you need to call CreateEmptyLibrary() with storeReflected set true
        throw cet::exception("PhotonLibrary")
          << "StoreLibraryToFile() requested to store the time propagation distribution "
             "parameters, which was not simulated.";
      }
      tt->Branch("timing_par", timing_par, Form("timing_par[%i]/F", size_t2int(storeTiming)));
      if (fLookupTable.size() != fTimingParLookupTable.size())
        throw cet::exception(" Photon Library ")
          << "Time propagation lookup table is different size than Direct table \n"
          << "this should not be happening. ";
    }

    if (storeReflected) {
      if (!hasReflected()) {
        // if this happens, you need to call CreateEmptyLibrary() with storeReflected set true
        throw cet::exception("PhotonLibrary")
          << "StoreLibraryToFile() requested to store reflected light, which was not simulated.";
      }
      tt->Branch("ReflVisibility", &ReflVisibility, "ReflVisibility/F");
      if (fLookupTable.size() != fReflLookupTable.size())
        throw cet::exception(" Photon Library ")
          << "Reflected light lookup table is different size than Direct table \n"
          << "this should not be happening. ";
    }
    if (storeReflT0) {
      if (!hasReflectedT0()) {
        // if this happens, you need to call CreateEmptyLibrary() with storeReflectedT0 set true
        throw cet::exception("PhotonLibrary") << "StoreLibraryToFile() requested to store "
                                                 "reflected light timing, which was not simulated.";
      }
      tt->Branch("ReflTfirst", &ReflTfirst, "ReflTfirst/F");
    }
    for (size_t ivox = 0; ivox != fNVoxels; ++ivox) {
      for (size_t ichan = 0; ichan != fNOpChannels; ++ichan) {
        Visibility = uncheckedAccess(ivox, ichan);
        if (storeReflected) ReflVisibility = uncheckedAccessRefl(ivox, ichan);
        if (storeReflT0) ReflTfirst = uncheckedAccessReflT(ivox, ichan);
        if (storeTiming != 0) {
          for (size_t i = 0; i < storeTiming; i++)
            timing_par[i] = uncheckedAccessTimingPar(ivox, ichan, i);
        }
        if (Visibility > 0 || ReflVisibility > 0) {
          Voxel = ivox;
          OpChannel = ichan;
          // visibility(ies) is(are) already set
          tt->Fill();
        }
      }
    }

    StoreMetadata();
  }

void phot::PhotonLibrary::StoreMetadata ( ) const

private

Writes the current metadata (if any) into the ROOT output file.

Definition at line 508 of file PhotonLibrary.cxx.

References fDir, fNOpChannels, fNVoxels, sim::PhotonVoxelDef::GetRegionLowerCorner(), sim::PhotonVoxelDef::GetRegionUpperCorner(), sim::PhotonVoxelDef::GetSteps(), GetVoxelDef(), sim::PhotonVoxelDef::GetVoxelSize(), and hasVoxelDef().

Referenced by StoreLibraryToFile().

  {

    assert(fDir);

    // NVoxels
    fDir->makeAndRegister<RooInt>("NVoxels", "Total number of voxels in the library", fNVoxels);

    // NChannels
    fDir->makeAndRegister<RooInt>(
      "NChannels", "Total number of optical detector channels in the library", fNOpChannels);

    if (!hasVoxelDef()) return;
    sim::PhotonVoxelDef const& voxelDef = GetVoxelDef();

    // lower point
    geo::Point_t const& lower = voxelDef.GetRegionLowerCorner();
    fDir->makeAndRegister<RooDouble>(
      "MinX", "Lower x coordinate covered by the library (world coordinates, cm)", lower.X());
    fDir->makeAndRegister<RooDouble>(
      "MinY", "Lower y coordinate covered by the library (world coordinates, cm)", lower.Y());
    fDir->makeAndRegister<RooDouble>(
      "MinZ", "Lower z coordinate covered by the library (world coordinates, cm)", lower.Z());

    // upper point
    geo::Point_t const& upper = voxelDef.GetRegionUpperCorner();
    fDir->makeAndRegister<RooDouble>(
      "MaxX", "Upper x coordinate covered by the library (world coordinates, cm)", upper.X());
    fDir->makeAndRegister<RooDouble>(
      "MaxY", "Upper y coordinate covered by the library (world coordinates, cm)", upper.Y());
    fDir->makeAndRegister<RooDouble>(
      "MaxZ", "Upper z coordinate covered by the library (world coordinates, cm)", upper.Z());

    // steps
    geo::Vector_t const& stepSizes = voxelDef.GetVoxelSize();
    fDir->makeAndRegister<RooDouble>("StepX", "Size on x direction of a voxel (cm)", stepSizes.X());
    fDir->makeAndRegister<RooDouble>("StepY", "Size on y direction of a voxel (cm)", stepSizes.Y());
    fDir->makeAndRegister<RooDouble>("StepZ", "Size on z direction of a voxel (cm)", stepSizes.Z());

    // divisions
    auto const& steps = voxelDef.GetSteps();
    fDir->makeAndRegister<RooInt>("NDivX", "Steps on the x direction", steps[0]);
    fDir->makeAndRegister<RooInt>("NDivY", "Steps on the y direction", steps[1]);
    fDir->makeAndRegister<RooInt>("NDivZ", "Steps on the z direction", steps[2]);

  } // PhotonLibrary::StoreMetadata()

float phot::PhotonLibrary::uncheckedAccess ( size_t  Voxel, size_t  OpChannel  ) const

inlineprivate

Unchecked access to a visibility datum.

Definition at line 143 of file PhotonLibrary.h.

Referenced by GetCount(), LoadLibraryFromFile(), SetCount(), and StoreLibraryToFile().

    {
      return fLookupTable[uncheckedIndex(Voxel, OpChannel)];
    }

float& phot::PhotonLibrary::uncheckedAccess ( size_t  Voxel, size_t  OpChannel  )

inlineprivate

Unchecked access to a visibility datum.

Definition at line 149 of file PhotonLibrary.h.

    {
      return fLookupTable[uncheckedIndex(Voxel, OpChannel)];
    }

float phot::PhotonLibrary::uncheckedAccessRefl ( size_t  Voxel, size_t  OpChannel  ) const

inlineprivate

Unchecked access to a reflected visibility datum.

Definition at line 155 of file PhotonLibrary.h.

Referenced by GetReflCount(), LoadLibraryFromFile(), SetReflCount(), and StoreLibraryToFile().

    {
      return fReflLookupTable[uncheckedIndex(Voxel, OpChannel)];
    }

float& phot::PhotonLibrary::uncheckedAccessRefl ( size_t  Voxel, size_t  OpChannel  )

inlineprivate

Unchecked access to a reflected visibility datum.

Definition at line 161 of file PhotonLibrary.h.

    {
      return fReflLookupTable[uncheckedIndex(Voxel, OpChannel)];
    }

float phot::PhotonLibrary::uncheckedAccessReflT ( size_t  Voxel, size_t  OpChannel  ) const

inlineprivate

Unchecked access to a reflected T0 visibility datum.

Definition at line 167 of file PhotonLibrary.h.

Referenced by GetReflT0(), LoadLibraryFromFile(), SetReflT0(), and StoreLibraryToFile().

    {
      return fReflTLookupTable[uncheckedIndex(Voxel, OpChannel)];
    }

float& phot::PhotonLibrary::uncheckedAccessReflT ( size_t  Voxel, size_t  OpChannel  )

inlineprivate

Unchecked access to a reflected T0 visibility datum.

Definition at line 173 of file PhotonLibrary.h.

    {
      return fReflTLookupTable[uncheckedIndex(Voxel, OpChannel)];
    }

float phot::PhotonLibrary::uncheckedAccessTimingPar ( size_t  Voxel, size_t  OpChannel, size_t  parnum  ) const

inlineprivate

Unchecked access to a parameter the time distribution.

Definition at line 179 of file PhotonLibrary.h.

Referenced by GetTimingPar(), SetTimingPar(), and StoreLibraryToFile().

    {
      return fTimingParLookupTable[uncheckedIndex(Voxel, OpChannel)][parnum];
    }

float& phot::PhotonLibrary::uncheckedAccessTimingPar ( size_t  Voxel, size_t  OpChannel, size_t  parnum  )

inlineprivate

Unchecked access to a parameter of the time distribution.

Definition at line 185 of file PhotonLibrary.h.

    {
      return fTimingParLookupTable[uncheckedIndex(Voxel, OpChannel)][parnum];
    }

TF1& phot::PhotonLibrary::uncheckedAccessTimingTF1 ( size_t  Voxel, size_t  OpChannel  )

inlineprivate

Unchecked access to a parameter of the time distribution.

Definition at line 191 of file PhotonLibrary.h.

Referenced by LoadLibraryFromFile(), and SetTimingTF1().

    {
      return fTimingParTF1LookupTable[uncheckedIndex(Voxel, OpChannel)];
    }

const TF1& phot::PhotonLibrary::uncheckedAccessTimingTF1 ( size_t  Voxel, size_t  OpChannel  ) const

inlineprivate

Unchecked access to a parameter of the time distribution.

Definition at line 197 of file PhotonLibrary.h.

References util::LazyVector< T, A >::data_address().

    {
      // note that this will produce a segmentation fault if the formula is not there
      return *(fTimingParTF1LookupTable.data_address(uncheckedIndex(Voxel, OpChannel)));
    }

size_t phot::PhotonLibrary::uncheckedIndex ( size_t  Voxel, size_t  OpChannel  ) const

inlineprivate

Returns the index of visibility of specified voxel and cell.

Definition at line 137 of file PhotonLibrary.h.

Referenced by GetCounts(), GetReflCounts(), GetReflT0s(), GetTimingPars(), and GetTimingTF1s().

    {
      return Voxel * fNOpChannels + OpChannel;
    }

Member Data Documentation

art::TFileDirectory* phot::PhotonLibrary::fDir = nullptr

private

ROOT directory where to write data.

Definition at line 132 of file PhotonLibrary.h.

Referenced by StoreLibraryToFile(), and StoreMetadata().

bool phot::PhotonLibrary::fHasReflected = false

private

Whether the current library deals with reflected light counts.

Definition at line 108 of file PhotonLibrary.h.

Referenced by CreateEmptyLibrary(), and LoadLibraryFromFile().

bool phot::PhotonLibrary::fHasReflectedT0

private

Initial value:

=
      false

Whether the current library deals with reflected light timing.

Definition at line 109 of file PhotonLibrary.h.

Referenced by CreateEmptyLibrary(), and LoadLibraryFromFile().

size_t phot::PhotonLibrary::fHasTiming

private

Initial value:

=
      0

Whether the current library deals with time propagation distribution.

Definition at line 112 of file PhotonLibrary.h.

Referenced by CreateEmptyLibrary(), and LoadLibraryFromFile().

util::LazyVector<float> phot::PhotonLibrary::fLookupTable

private

Definition at line 117 of file PhotonLibrary.h.

Referenced by CreateEmptyLibrary(), GetCounts(), LoadLibraryFromFile(), and StoreLibraryToFile().

size_t phot::PhotonLibrary::fNOpChannels

private

Definition at line 125 of file PhotonLibrary.h.

Referenced by CreateEmptyLibrary(), GetCount(), GetReflCount(), GetReflT0(), GetTimingPar(), LoadLibraryFromFile(), SetCount(), SetReflCount(), SetReflT0(), SetTimingPar(), SetTimingTF1(), StoreLibraryToFile(), and StoreMetadata().

size_t phot::PhotonLibrary::fNVoxels

private

Definition at line 126 of file PhotonLibrary.h.

Referenced by CreateEmptyLibrary(), GetCount(), GetCounts(), GetReflCount(), GetReflCounts(), GetReflT0(), GetReflT0s(), GetTimingPar(), GetTimingPars(), GetTimingTF1s(), LoadLibraryFromFile(), SetCount(), SetReflCount(), SetReflT0(), SetTimingPar(), SetTimingTF1(), StoreLibraryToFile(), and StoreMetadata().

util::LazyVector<float> phot::PhotonLibrary::fReflLookupTable

private

Definition at line 118 of file PhotonLibrary.h.

Referenced by CreateEmptyLibrary(), GetReflCounts(), LoadLibraryFromFile(), and StoreLibraryToFile().

util::LazyVector<float> phot::PhotonLibrary::fReflTLookupTable

private

Definition at line 119 of file PhotonLibrary.h.

Referenced by CreateEmptyLibrary(), GetReflT0s(), and LoadLibraryFromFile().

std::string phot::PhotonLibrary::fTimingParFormula

private

Definition at line 122 of file PhotonLibrary.h.

Referenced by LoadLibraryFromFile().

util::LazyVector<std::vector<float> > phot::PhotonLibrary::fTimingParLookupTable

private

Definition at line 120 of file PhotonLibrary.h.

Referenced by CreateEmptyLibrary(), GetTimingPars(), LoadLibraryFromFile(), and StoreLibraryToFile().

size_t phot::PhotonLibrary::fTimingParNParameters

private

Definition at line 123 of file PhotonLibrary.h.

Referenced by LoadLibraryFromFile().

util::LazyVector<TF1> phot::PhotonLibrary::fTimingParTF1LookupTable

private

Definition at line 121 of file PhotonLibrary.h.

Referenced by CreateEmptyLibrary(), GetTimingTF1s(), and LoadLibraryFromFile().

std::optional<sim::PhotonVoxelDef> phot::PhotonLibrary::fVoxelDef

private

Voxel definition loaded from library metadata.

Definition at line 129 of file PhotonLibrary.h.

Referenced by LoadMetadata().

std::string const phot::PhotonLibrary::OpChannelBranchName = "OpChannel"

staticprivate

Name of the optical channel number in the input tree.

Definition at line 210 of file PhotonLibrary.h.

Referenced by ExtractNOpChannels(), and StoreLibraryToFile().

---

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

• larsim/v09_43_00/source/larsim/PhotonPropagation/PhotonLibrary.h
• larsim/v09_43_00/source/larsim/PhotonPropagation/PhotonLibrary.cxx