phot::PhotonLibrary Class Reference

#include "PhotonLibrary.h"

Inheritance diagram for phot::PhotonLibrary:

Public Member Functions
	PhotonLibrary ()=default
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)
virtual int	NOpChannels () const override
virtual int	NVoxels () const override
size_t	LibrarySize () const
	Returns the number of elements in the library. More...

Private Member Functions
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...

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 = false
	Whether the current library deals with reflected light timing. More...
size_t	fHasTiming = 0
	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

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 18 of file PhotonLibrary.h.

Constructor & Destructor Documentation

phot::PhotonLibrary::PhotonLibrary ( )

default

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 104 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().

Referenced by hasReflectedT0(), and phot::PhotonVisibilityService::LoadLibrary().

    {
    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 404 of file PhotonLibrary.cxx.

References 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
    
    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 262 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 345 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 279 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 388 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 288 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 396 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 271 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 353 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 361 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)));
  }

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

inlineoverridevirtual

Returns whether the current library deals with reflected light count.

Implements phot::IPhotonLibrary.

Definition at line 54 of file PhotonLibrary.h.

References fHasReflected.

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 57 of file PhotonLibrary.h.

References CreateEmptyLibrary(), fHasReflectedT0, LoadLibraryFromFile(), NVoxels(), and StoreLibraryToFile().

Referenced by StoreLibraryToFile().

{ return fHasReflectedT0; }

bool phot::PhotonLibrary::hasTiming ( ) const

inline

Returns whether the current library deals with time propagation distributions.

Definition at line 51 of file PhotonLibrary.h.

References fHasTiming.

Referenced by StoreLibraryToFile().

{ return fHasTiming; }

size_t phot::IPhotonLibrary::LibrarySize ( ) const

inlineinherited

Returns the number of elements in the library.

Definition at line 37 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 135 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, phot::IPhotonLibrary::LibrarySize(), n, NVoxels(), util::LazyVector< T, A >::resize(), uncheckedAccess(), uncheckedAccessRefl(), uncheckedAccessReflT(), and uncheckedAccessTimingTF1().

Referenced by hasReflectedT0(), and 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;
      
    try
      {
        f  =  TFile::Open(LibraryFile.c_str());
        tt =  (TTree*)f->Get("PhotonLibraryData");
        if (!tt) { // Library not in the top directory
            TKey *key = f->FindKeyAny("PhotonLibraryData");
            if (key) 
                tt = (TTree*)key->ReadObj();
            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;
      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
    
    mf::LogInfo("PhotonLibrary") <<"Photon lookup table size : "<<  NVoxels << " voxels,  " << fNOpChannels<<" channels";

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

  }

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

inlineoverridevirtual

Implements phot::IPhotonLibrary.

Definition at line 65 of file PhotonLibrary.h.

References fNOpChannels.

Referenced by CreateEmptyLibrary().

{ return fNOpChannels; }

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

inlineoverridevirtual

Implements phot::IPhotonLibrary.

Definition at line 66 of file PhotonLibrary.h.

References fNVoxels.

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

{ return fNVoxels; }

TTree* phot::PhotonLibrary::ProduceTTree

(

)

const

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

Definition at line 298 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 326 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 335 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 307 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 316 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;
  }

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

inlinestaticprivate

Converts size_t into integer.

Definition at line 145 of file PhotonLibrary.h.

Referenced by StoreLibraryToFile().

                                      {
    return (val <= INT_MAX) ? (int)((ssize_t)val) : -1; }

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

Definition at line 23 of file PhotonLibrary.cxx.

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

Referenced by hasReflectedT0(), and phot::PhotonVisibilityService::StoreLibrary().

  {
    mf::LogInfo("PhotonLibrary") << "Writing photon library to input file: " << LibraryFile.c_str()<<std::endl;

    art::ServiceHandle<art::TFileService> tfs;

    TTree *tt = tfs->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();
        }
      } 
    }
  }

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

inlineprivate

Unchecked access to a visibility datum.

Definition at line 94 of file PhotonLibrary.h.

References uncheckedIndex().

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 98 of file PhotonLibrary.h.

References uncheckedIndex().

      { 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 102 of file PhotonLibrary.h.

References uncheckedIndex().

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 106 of file PhotonLibrary.h.

References uncheckedIndex().

    { 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 110 of file PhotonLibrary.h.

References uncheckedIndex().

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 114 of file PhotonLibrary.h.

References uncheckedIndex().

    { 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 119 of file PhotonLibrary.h.

References uncheckedIndex().

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 123 of file PhotonLibrary.h.

References uncheckedIndex().

    { 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 128 of file PhotonLibrary.h.

References uncheckedIndex().

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 132 of file PhotonLibrary.h.

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

    {
      // 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 90 of file PhotonLibrary.h.

Referenced by GetCounts(), GetReflCounts(), GetReflT0s(), GetTimingPars(), GetTimingTF1s(), uncheckedAccess(), uncheckedAccessRefl(), uncheckedAccessReflT(), uncheckedAccessTimingPar(), and uncheckedAccessTimingTF1().

      { return Voxel * fNOpChannels + OpChannel; }

Member Data Documentation

bool phot::PhotonLibrary::fHasReflected = false

private

Whether the current library deals with reflected light counts.

Definition at line 70 of file PhotonLibrary.h.

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

bool phot::PhotonLibrary::fHasReflectedT0 = false

private

Whether the current library deals with reflected light timing.

Definition at line 71 of file PhotonLibrary.h.

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

size_t phot::PhotonLibrary::fHasTiming = 0

private

Whether the current library deals with time propagation distribution.

Definition at line 73 of file PhotonLibrary.h.

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

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

private

Definition at line 78 of file PhotonLibrary.h.

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

size_t phot::PhotonLibrary::fNOpChannels

private

Definition at line 86 of file PhotonLibrary.h.

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

size_t phot::PhotonLibrary::fNVoxels

private

Definition at line 87 of file PhotonLibrary.h.

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

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

private

Definition at line 79 of file PhotonLibrary.h.

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

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

private

Definition at line 80 of file PhotonLibrary.h.

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

std::string phot::PhotonLibrary::fTimingParFormula

private

Definition at line 83 of file PhotonLibrary.h.

Referenced by LoadLibraryFromFile().

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

private

Definition at line 81 of file PhotonLibrary.h.

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

size_t phot::PhotonLibrary::fTimingParNParameters

private

Definition at line 84 of file PhotonLibrary.h.

Referenced by LoadLibraryFromFile().

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

private

Definition at line 82 of file PhotonLibrary.h.

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

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

staticprivate

Name of the optical channel number in the input tree.

Definition at line 139 of file PhotonLibrary.h.

Referenced by ExtractNOpChannels(), and StoreLibraryToFile().

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larsim/v07_09_00/source/larsim/PhotonPropagation/PhotonLibrary.h
• /cvmfs/larsoft.opensciencegrid.org/products/larsim/v07_09_00/source/larsim/PhotonPropagation/PhotonLibrary.cxx