phot::PhotonLibraryHybrid Class Reference

TODO doc. More...

#include "PhotonLibraryHybrid.h"

Inheritance diagram for phot::PhotonLibraryHybrid:

Classes
struct	Exception
struct	FitFunc
struct	OpDetRecord

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
	PhotonLibraryHybrid (const std::string &fname, const sim::PhotonVoxelDef &voxdef)
virtual	~PhotonLibraryHybrid ()
virtual float	GetCount (size_t Voxel, size_t OpChannel) const override
virtual const float *	GetCounts (size_t Voxel) const override
	Returns a pointer to NOpChannels() visibility values, one per channel. More...
virtual bool	hasReflected () const override
	Don't implement reflected light. More...
virtual const float *	GetReflCounts (size_t Voxel) const override
virtual float	GetReflCount (size_t Voxel, size_t OpChannel) const override
virtual bool	hasReflectedT0 () const override
	Don't implement reflected light timing. More...
virtual const float *	GetReflT0s (size_t Voxel) const override
virtual float	GetReflT0 (size_t Voxel, size_t OpChannel) const override
virtual int	NOpChannels () const override
virtual int	NVoxels () const override
virtual bool	isVoxelValid (size_t Voxel) const
size_t	LibrarySize () const
	Returns the number of elements in the library. More...

Protected Attributes
const sim::PhotonVoxelDef &	fVoxDef
std::vector< OpDetRecord >	fRecords

Detailed Description

TODO doc.

Definition at line 19 of file PhotonLibraryHybrid.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::PhotonLibraryHybrid::PhotonLibraryHybrid	(	const std::string &	fname,
		const sim::PhotonVoxelDef &	voxdef
	)

Definition at line 25 of file PhotonLibraryHybrid.cxx.

References dir, phot::PhotonLibraryHybrid::OpDetRecord::exceptions, f, phot::PhotonLibraryHybrid::OpDetRecord::fit, fRecords, geo::GeometryCore::NOpDets(), NVoxels(), and vox.

    : fVoxDef(voxdef)
  {
    TFile f(fname.c_str());
    !f.IsZombie() || fatal("Could not open PhotonLibrary " + fname);

    for (int opdetIdx = 0; true; ++opdetIdx) {
      const std::string dirname = TString::Format("opdet_%d", opdetIdx).Data();
      TDirectory* dir = (TDirectory*)f.Get(dirname.c_str());
      if (!dir) break; // Ran out of opdets

      OpDetRecord rec;

      TVectorD* fit = (TVectorD*)dir->Get("fit");
      fit || fatal("Didn't find " + dirname + "/fit in " + fname);
      rec.fit = FitFunc((*fit)[0], (*fit)[1]);

      TTree* tr = (TTree*)dir->Get("tr");
      tr || fatal("Didn't find " + dirname + "/tr in " + fname);
      int vox;
      float vis;
      tr->SetBranchAddress("vox", &vox);
      tr->SetBranchAddress("vis", &vis);

      rec.exceptions.reserve(tr->GetEntries());
      for (int i = 0; i < tr->GetEntries(); ++i) {
        tr->GetEntry(i);
        vox < NVoxels() || fatal("Voxel out of range");
        rec.exceptions.emplace_back(vox, vis);
      }
      rec.exceptions.shrink_to_fit(); // In case we don't trust reserve()

      // In case they weren't sorted in the file
      std::sort(rec.exceptions.begin(), rec.exceptions.end());

      fRecords.push_back(rec);
    } // end for opdetIdx

    !fRecords.empty() || fatal("No opdet_*/ directories in " + fname);

    art::ServiceHandle<geo::Geometry const> geom;
    geom->NOpDets() == fRecords.size() || fatal("Number of opdets mismatch");

    fRecords.shrink_to_fit(); // save memory
  }

phot::PhotonLibraryHybrid::~PhotonLibraryHybrid ( )

virtual

Definition at line 73 of file PhotonLibraryHybrid.cxx.

{}

Member Function Documentation

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

overridevirtual

Implements phot::IPhotonLibrary.

Definition at line 95 of file PhotonLibraryHybrid.cxx.

References larg4::dist(), geo::OpDetGeo::DistanceToPoint(), phot::PhotonLibraryHybrid::FitFunc::Eval(), phot::PhotonLibraryHybrid::OpDetRecord::exceptions, phot::PhotonLibraryHybrid::OpDetRecord::fit, fRecords, fVoxDef, sim::PhotonVoxel::GetCenter(), sim::PhotonVoxelDef::GetPhotonVoxel(), NOpChannels(), NVoxels(), geo::GeometryCore::OpDetGeoFromOpDet(), and vox.

Referenced by GetCounts().

  {
    int(vox) < NVoxels() || fatal("GetCount(): Voxel out of range");
    int(opchan) < NOpChannels() || fatal("GetCount(): OpChan out of range");

    const OpDetRecord& rec = fRecords[opchan];

    auto it2 = std::lower_bound(rec.exceptions.begin(), rec.exceptions.end(), vox);
    if (it2->vox == vox) return it2->vis;

    // Otherwise, we use the interpolation, which requires a distance

    static art::ServiceHandle<geo::Geometry const> geom;
    const geo::OpDetGeo& opdet = geom->OpDetGeoFromOpDet(opchan);

    const auto voxvec = fVoxDef.GetPhotonVoxel(vox).GetCenter();

    const double dist = opdet.DistanceToPoint(voxvec);

    return rec.fit.Eval(dist);
  }

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

overridevirtual

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

Implements phot::IPhotonLibrary.

Definition at line 82 of file PhotonLibraryHybrid.cxx.

References GetCount(), and NOpChannels().

  {
    // The concept of GetCounts() conflicts fairly badly with how this library
    // works. This is probably the best we can do.

    static float* counts = 0;
    if (!counts) counts = new float[NOpChannels()];
    for (int od = 0; od < NOpChannels(); ++od)
      counts[od] = GetCount(vox, od);
    return counts;
  }

virtual float phot::PhotonLibraryHybrid::GetReflCount ( size_t  Voxel, size_t  OpChannel  ) const

inlineoverridevirtual

Implements phot::IPhotonLibrary.

Definition at line 32 of file PhotonLibraryHybrid.h.

{ return 0; }

virtual const float* phot::PhotonLibraryHybrid::GetReflCounts ( size_t  Voxel ) const

inlineoverridevirtual

Implements phot::IPhotonLibrary.

Definition at line 31 of file PhotonLibraryHybrid.h.

{ return 0; }

virtual float phot::PhotonLibraryHybrid::GetReflT0 ( size_t  Voxel, size_t  OpChannel  ) const

inlineoverridevirtual

Implements phot::IPhotonLibrary.

Definition at line 37 of file PhotonLibraryHybrid.h.

{ return 0; }

virtual const float* phot::PhotonLibraryHybrid::GetReflT0s ( size_t  Voxel ) const

inlineoverridevirtual

Implements phot::IPhotonLibrary.

Definition at line 36 of file PhotonLibraryHybrid.h.

{ return 0; }

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

inlineoverridevirtual

Don't implement reflected light.

Implements phot::IPhotonLibrary.

Definition at line 30 of file PhotonLibraryHybrid.h.

{ return false; }

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

inlineoverridevirtual

Don't implement reflected light timing.

Implements phot::IPhotonLibrary.

Definition at line 35 of file PhotonLibraryHybrid.h.

{ return false; }

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

inlinevirtualinherited

Reimplemented in phot::PhotonLibrary.

Definition at line 50 of file IPhotonLibrary.h.

References phot::IPhotonLibrary::NVoxels().

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

{ return Voxel < (std::size_t)NVoxels(); }

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 phot::PhotonLibrary::CreateEmptyLibrary(), and phot::PhotonLibrary::LoadLibraryFromFile().

{ return NVoxels() * NOpChannels(); }

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

inlineoverridevirtual

Implements phot::IPhotonLibrary.

Definition at line 39 of file PhotonLibraryHybrid.h.

Referenced by GetCount(), and GetCounts().

{ return fRecords.size(); }

int phot::PhotonLibraryHybrid::NVoxels ( ) const

overridevirtual

Implements phot::IPhotonLibrary.

Definition at line 76 of file PhotonLibraryHybrid.cxx.

References fVoxDef, and sim::PhotonVoxelDef::GetNVoxels().

Referenced by GetCount(), and PhotonLibraryHybrid().

  {
    return fVoxDef.GetNVoxels();
  }

Member Data Documentation

std::vector<OpDetRecord> phot::PhotonLibraryHybrid::fRecords

protected

Definition at line 70 of file PhotonLibraryHybrid.h.

Referenced by GetCount(), and PhotonLibraryHybrid().

const sim::PhotonVoxelDef& phot::PhotonLibraryHybrid::fVoxDef

protected

Definition at line 43 of file PhotonLibraryHybrid.h.

Referenced by GetCount(), and NVoxels().

---

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

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