phot::IPhotonLibrary Class Reference

Interface shared by all PhotonLibrary-like classes. More...

#include "IPhotonLibrary.h"

Inheritance diagram for phot::IPhotonLibrary:

Public Member Functions
	IPhotonLibrary ()
virtual	~IPhotonLibrary ()
virtual float	GetCount (size_t Voxel, size_t OpChannel) const =0
virtual float	GetReflCount (size_t Voxel, size_t OpChannel) const =0
virtual float	GetReflT0 (size_t Voxel, size_t OpChannel) const =0
virtual const float *	GetCounts (size_t Voxel) const =0
	Returns a pointer to NOpChannels() visibility values, one per channel. More...
virtual const float *	GetReflCounts (size_t Voxel) const =0
virtual const float *	GetReflT0s (size_t Voxel) const =0
virtual bool	hasReflected () const =0
	Returns whether the current library deals with reflected light count. More...
virtual bool	hasReflectedT0 () const =0
	Returns whether the current library deals with reflected light timing. More...
virtual int	NOpChannels () const =0
virtual int	NVoxels () const =0
size_t	LibrarySize () const
	Returns the number of elements in the library. More...

Detailed Description

Interface shared by all PhotonLibrary-like classes.

Definition at line 12 of file IPhotonLibrary.h.

Constructor & Destructor Documentation

phot::IPhotonLibrary::IPhotonLibrary ( )

inline

Definition at line 15 of file IPhotonLibrary.h.

{}

virtual phot::IPhotonLibrary::~IPhotonLibrary ( )

inlinevirtual

Definition at line 16 of file IPhotonLibrary.h.

References GetCount(), GetCounts(), GetReflCount(), GetReflCounts(), GetReflT0(), GetReflT0s(), hasReflected(), hasReflectedT0(), NOpChannels(), and NVoxels().

{}

Member Function Documentation

virtual float phot::IPhotonLibrary::GetCount ( size_t  Voxel, size_t  OpChannel  ) const

pure virtual

Implemented in phot::PhotonLibrary, and phot::PhotonLibraryHybrid.

Referenced by phot::PhotonVisibilityService::GetLibraryEntry(), and ~IPhotonLibrary().

virtual const float* phot::IPhotonLibrary::GetCounts ( size_t  Voxel ) const

pure virtual

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

Implemented in phot::PhotonLibrary, and phot::PhotonLibraryHybrid.

Referenced by phot::PhotonVisibilityService::GetLibraryEntries(), and ~IPhotonLibrary().

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

pure virtual

Implemented in phot::PhotonLibrary, and phot::PhotonLibraryHybrid.

Referenced by phot::PhotonVisibilityService::GetLibraryEntry(), and ~IPhotonLibrary().

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

pure virtual

Implemented in phot::PhotonLibrary, and phot::PhotonLibraryHybrid.

Referenced by phot::PhotonVisibilityService::GetLibraryEntries(), and ~IPhotonLibrary().

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

pure virtual

Implemented in phot::PhotonLibrary, and phot::PhotonLibraryHybrid.

Referenced by phot::PhotonVisibilityService::GetLibraryReflT0Entry(), and ~IPhotonLibrary().

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

pure virtual

Implemented in phot::PhotonLibrary, and phot::PhotonLibraryHybrid.

Referenced by phot::PhotonVisibilityService::GetLibraryReflT0Entries(), and ~IPhotonLibrary().

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

pure virtual

Returns whether the current library deals with reflected light count.

Implemented in phot::PhotonLibrary, and phot::PhotonLibraryHybrid.

Referenced by ~IPhotonLibrary().

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

pure virtual

Returns whether the current library deals with reflected light timing.

Implemented in phot::PhotonLibrary, and phot::PhotonLibraryHybrid.

Referenced by ~IPhotonLibrary().

size_t phot::IPhotonLibrary::LibrarySize ( ) const

inline

Returns the number of elements in the library.

Definition at line 37 of file IPhotonLibrary.h.

References NOpChannels(), and NVoxels().

Referenced by phot::PhotonLibrary::CreateEmptyLibrary(), and phot::PhotonLibrary::LoadLibraryFromFile().

{ return NVoxels() * NOpChannels(); }

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

pure virtual

Implemented in phot::PhotonLibrary, and phot::PhotonLibraryHybrid.

Referenced by LibrarySize(), phot::PhotonVisibilityService::NOpChannels(), and ~IPhotonLibrary().

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

pure virtual

Implemented in phot::PhotonLibrary, and phot::PhotonLibraryHybrid.

Referenced by LibrarySize(), and ~IPhotonLibrary().

---

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

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