sim::PhotonVoxelDef Class Reference

#include "PhotonVoxels.h"

Classes
struct	NeiInfo

Public Member Functions
	PhotonVoxelDef (double xMin, double xMax, int xN, double yMin, double yMax, int yN, double zMin, double zMax, int z)
	PhotonVoxelDef ()
TVector3	GetRegionUpperCorner () const
TVector3	GetRegionLowerCorner () const
TVector3	GetSteps () const
TVector3	GetVoxelSize () const
int	GetNVoxels () const
int	GetVoxelID (const TVector3 &) const
int	GetVoxelID (double const *) const
bool	IsLegalVoxelID (int) const
void	GetNeighboringVoxelIDs (const TVector3 &v, std::vector< NeiInfo > &ret) const
PhotonVoxel	GetPhotonVoxel (int ID) const
std::vector< int >	GetVoxelCoords (int ID) const
PhotonVoxel	GetContainingVoxel (TVector3) const
bool	operator== (const PhotonVoxelDef &rhs) const
bool	operator!= (const PhotonVoxelDef &rhs) const

Private Attributes
TVector3	fLowerCorner
TVector3	fUpperCorner
int	fxSteps
int	fySteps
int	fzSteps

Detailed Description

Definition at line 42 of file PhotonVoxels.h.

Constructor & Destructor Documentation

sim::PhotonVoxelDef::PhotonVoxelDef	(	double	xMin,
		double	xMax,
		int	xN,
		double	yMin,
		double	yMax,
		int	yN,
		double	zMin,
		double	zMax,
		int	z
	)

Definition at line 57 of file PhotonVoxels.cxx.

  {
    fxSteps = xN;
    fySteps = yN;
    fzSteps = zN;
    
    
    fLowerCorner = TVector3(xMin,yMin,zMin);
    fUpperCorner = TVector3(xMax,yMax,zMax);
  }

sim::PhotonVoxelDef::PhotonVoxelDef

(

)

Definition at line 77 of file PhotonVoxels.cxx.

  {
  }

Member Function Documentation

PhotonVoxel sim::PhotonVoxelDef::GetContainingVoxel

(

TVector3

)

const

void sim::PhotonVoxelDef::GetNeighboringVoxelIDs	(	const TVector3 &	v,
		std::vector< NeiInfo > &	ret
	)		const

Definition at line 146 of file PhotonVoxels.cxx.

References d, e, max, min, n, and w.

Referenced by phot::PhotonVisibilityService::GetVisibility(), and GetVoxelID().

  {
    ret.clear();
    ret.reserve(8);

    // Position in voxel coordinates including floating point part
    double rStepD[3];
    for(int i = 0; i < 3; ++i){
      // If we're outside the cuboid we have values for, return empty vector,
      // ie failure.
      if(v[i] < fLowerCorner[i] || v[i] > fUpperCorner[i]) return;// {};
      // Figure out our position wrt to the centres of the voxels
      rStepD[i] = ((v[i]-fLowerCorner[i]) / (fUpperCorner[i]-fLowerCorner[i]) * GetSteps()[i] ) - 0.5;
    }

    // The neighbours are the 8 corners of a cube around this point
    for(int dx = 0; dx <= 1; ++dx){
      for(int dy = 0; dy <= 1; ++dy){
        for(int dz = 0; dz <= 1; ++dz){
          // The full 3D step
          const int dr[3] = {dx, dy, dz};

          // The integer-only position of the current corner
          int rStepI[3];
          for(int d = 0; d < 3; ++d){
            // Round down to get the "lower left" corner
            rStepI[d] = int(rStepD[d]);
            // Ensure we'll stay in-bounds
            rStepI[d] = std::max(0, rStepI[d]);
            rStepI[d] = std::min(rStepI[d], int(GetSteps()[d])-2);
            // Adjust to the corner we're actually considering
            rStepI[d] += dr[d];
          }

          double w = 1;
          for(int d = 0; d < 3; ++d){
            // These expressions will interpolate when between the 8 corners,
            // and extrapolate in the half-voxel space around the edges.
            if(dr[d] == 0)
              w *= 1+rStepI[d]-rStepD[d];
            else
              w *= 1-rStepI[d]+rStepD[d];
          }

          const int id = (rStepI[0] +
                          rStepI[1] * (fxSteps) +
                          rStepI[2] * (fxSteps * fySteps));

          ret.emplace_back(id, w);
        }
      }
    }

    // Sanity check the weights sum to 1
    double wSum = 0;
    for(const NeiInfo& n: ret) wSum += n.weight;
    if(fabs(wSum-1) > 1e-3){
      std::cout << "PhotonVoxelDef::GetNeighboringVoxelIDs(): "
                << "Weights sum to " << wSum << " (should be 1). "
                << "Weights are:";
      for(const NeiInfo& n: ret) std::cout << " " << n.weight;
      std::cout << " Aborting." << std::endl;
      abort();
    }
  }

int sim::PhotonVoxelDef::GetNVoxels

(

)

const

Definition at line 109 of file PhotonVoxels.cxx.

Referenced by phot::PhotonLibraryAnalyzer::beginJob(), phot::CreateHybridLibrary::CreateHybridLibrary(), evgen::LightSource::LightSource(), phot::PhotonVisibilityService::LoadLibrary(), and phot::PhotonLibraryHybrid::NVoxels().

  {
    return fxSteps * fySteps * fzSteps;
  }

PhotonVoxel sim::PhotonVoxelDef::GetPhotonVoxel

(

int

ID

)

const

Definition at line 223 of file PhotonVoxels.cxx.

References sim::PhotonVoxel::PhotonVoxel().

Referenced by phot::CreateHybridLibrary::CreateHybridLibrary(), phot::PhotonLibraryHybrid::GetCount(), and evgen::LightSource::produce().

  {
    //    float TempID = (float) ID;

    // Decompose ID into steps in each direction
    int xStep =  ID % fxSteps ;
    int yStep =  ((ID - xStep ) / fxSteps) % fySteps ;
    int zStep =  ((ID - xStep - (yStep * fxSteps)) / (fySteps * fxSteps)) % fzSteps ;


    TVector3 VoxelSize = GetVoxelSize();

    double xMin = VoxelSize[0] * (xStep)   + fLowerCorner[0];
    double xMax = VoxelSize[0] * (xStep+1) + fLowerCorner[0];
    double yMin = VoxelSize[1] * (yStep)   + fLowerCorner[1];
    double yMax = VoxelSize[1] * (yStep+1) + fLowerCorner[1];
    double zMin = VoxelSize[2] * (zStep)   + fLowerCorner[2];
    double zMax = VoxelSize[2] * (zStep+1) + fLowerCorner[2];


   
    return PhotonVoxel(xMin, xMax, yMin, yMax, zMin, zMax);
  }

TVector3 sim::PhotonVoxelDef::GetRegionLowerCorner

(

)

const

Definition at line 82 of file PhotonVoxels.cxx.

Referenced by phot::PhotonLibraryAnalyzer::beginJob(), and operator==().

  {
    return fLowerCorner;
  }

TVector3 sim::PhotonVoxelDef::GetRegionUpperCorner

(

)

const

Definition at line 88 of file PhotonVoxels.cxx.

Referenced by phot::PhotonLibraryAnalyzer::beginJob(), and operator==().

  {
    return fUpperCorner;
  }

TVector3 sim::PhotonVoxelDef::GetSteps

(

)

const

Definition at line 94 of file PhotonVoxels.cxx.

Referenced by phot::PhotonLibraryAnalyzer::beginJob(), and operator==().

  {
    TVector3 Steps = TVector3(fxSteps, fySteps, fzSteps);
    return Steps;
  }

std::vector< int > sim::PhotonVoxelDef::GetVoxelCoords

(

int

ID

)

const

Definition at line 253 of file PhotonVoxels.cxx.

Referenced by phot::PhotonLibraryAnalyzer::beginJob().

  {
    std::vector<int> ReturnVector;
    ReturnVector.resize(3);
    ReturnVector.at(0) =  ID % fxSteps ;
    ReturnVector.at(1) =  ((ID - ReturnVector.at(0) ) / fxSteps) % fySteps ;
    ReturnVector.at(2) =  ((ID - ReturnVector.at(0) - (ReturnVector.at(1) * fxSteps)) / (fySteps * fxSteps)) % fzSteps ;
    return ReturnVector;
    
  }

int sim::PhotonVoxelDef::GetVoxelID

(

const TVector3 &

p

)

const

Definition at line 115 of file PhotonVoxels.cxx.

Referenced by phot::PhotonVisibilityService::GetAllVisibilities(), phot::PhotonVisibilityService::GetReflT0s(), phot::PhotonVisibilityService::GetTimingPar(), phot::PhotonVisibilityService::GetTimingTF1(), and phot::PhotonVisibilityService::GetVisibility().

  {
    const double xyz[3] = {p.X(), p.Y(), p.Z()};
    return GetVoxelID(xyz);
  }

int sim::PhotonVoxelDef::GetVoxelID

(

double const *

Position

)

const

Definition at line 122 of file PhotonVoxels.cxx.

References GetNeighboringVoxelIDs().

  {
    // figure out how many steps this point is in the x,y,z directions
    int xStep = int ((Position[0]-fLowerCorner[0]) / (fUpperCorner[0]-fLowerCorner[0]) * fxSteps );
    int yStep = int ((Position[1]-fLowerCorner[1]) / (fUpperCorner[1]-fLowerCorner[1]) * fySteps );
    int zStep = int ((Position[2]-fLowerCorner[2]) / (fUpperCorner[2]-fLowerCorner[2]) * fzSteps );

    // check if point lies within the voxelized region
    if((0 <= xStep) && (xStep < fxSteps) &&
       (0 <= yStep) && (yStep < fySteps) &&
       (0 <= zStep) && (zStep < fzSteps) ){
      // if within bounds, generate the voxel ID
      return (xStep
              + yStep * (fxSteps)
              + zStep * (fxSteps * fySteps));
      }
    else{
      // out of bounds
      return -1;
    }
  }

TVector3 sim::PhotonVoxelDef::GetVoxelSize

(

)

const

Definition at line 213 of file PhotonVoxels.cxx.

Referenced by evgen::LightSource::LightSource().

  {
    TVector3 TheSize = TVector3((GetRegionUpperCorner()[0]-GetRegionLowerCorner()[0]) / fxSteps,
                                (GetRegionUpperCorner()[1]-GetRegionLowerCorner()[1]) / fySteps,
                                (GetRegionUpperCorner()[2]-GetRegionLowerCorner()[2]) / fzSteps);
    return TheSize;
  }

bool sim::PhotonVoxelDef::IsLegalVoxelID

(

int

ID

)

const

Definition at line 248 of file PhotonVoxels.cxx.

  {
    return (( ID > -1) && (ID<GetNVoxels()));
  }

bool sim::PhotonVoxelDef::operator!= ( const PhotonVoxelDef &  rhs ) const

inline

Definition at line 95 of file PhotonVoxels.h.

      { return ! ((*this)==rhs); }

bool sim::PhotonVoxelDef::operator==

(

const PhotonVoxelDef &

rhs

)

const

Definition at line 101 of file PhotonVoxels.cxx.

References GetRegionLowerCorner(), GetRegionUpperCorner(), and GetSteps().

  {
    return ( ( GetRegionUpperCorner() == right.GetRegionUpperCorner() ) &&
             ( GetRegionLowerCorner() == right.GetRegionLowerCorner() ) &&
             ( GetSteps() == right.GetSteps()) );
  }

Member Data Documentation

TVector3 sim::PhotonVoxelDef::fLowerCorner

private

Definition at line 57 of file PhotonVoxels.h.

TVector3 sim::PhotonVoxelDef::fUpperCorner

private

Definition at line 58 of file PhotonVoxels.h.

int sim::PhotonVoxelDef::fxSteps

private

Definition at line 59 of file PhotonVoxels.h.

int sim::PhotonVoxelDef::fySteps

private

Definition at line 60 of file PhotonVoxels.h.

int sim::PhotonVoxelDef::fzSteps

private

Definition at line 61 of file PhotonVoxels.h.

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larsim/v07_09_00/source/larsim/Simulation/PhotonVoxels.h
• /cvmfs/larsoft.opensciencegrid.org/products/larsim/v07_09_00/source/larsim/Simulation/PhotonVoxels.cxx