sim::LArVoxelID Class Reference

#include "LArVoxelID.h"

Public Member Functions
	LArVoxelID (const int x=0, const int y=0, const int z=0, const int t=0)
	Expert constructor based on actual bins. More...
	LArVoxelID (const TLorentzVector &v)
	Standard constructors. More...
	LArVoxelID (const double x, const double y, const double z, const double t)
virtual	~LArVoxelID ()
	Destructor. More...
int	XBin () const
int	YBin () const
int	ZBin () const
int	TBin () const
double	X () const
double	Y () const
double	Z () const
double	T () const
double	operator[] (const int) const
	operator TLorentzVector () const
	operator TVector3 () const
bool	operator< (const LArVoxelID &) const
bool	operator== (const LArVoxelID &) const
	Test for equality. Handy, but not usually necessary. More...

Private Attributes
std::vector< int >	fbins

Friends
std::ostream &	operator<< (std::ostream &output, const LArVoxelID &)

Detailed Description

Definition at line 54 of file LArVoxelID.h.

Constructor & Destructor Documentation

sim::LArVoxelID::LArVoxelID	(	const int	x = 0,
		const int	y = 0,
		const int	z = 0,
		const int	t = 0
	)

Expert constructor based on actual bins.

Definition at line 27 of file LArVoxelID.cxx.

References fbins, x, y, and z.

  {
    fbins = std::vector<int>(4);
    fbins[0] = x;
    fbins[1] = y;
    fbins[2] = z;
    fbins[3] = t;

  }

sim::LArVoxelID::LArVoxelID ( const TLorentzVector &  v )

explicit

Standard constructors.

Definition at line 42 of file LArVoxelID.cxx.

References fbins.

  {
    // Copy each axis from the vector and convert it to a bin.
    fbins = std::vector<int>(4);
    art::ServiceHandle<sim::LArVoxelCalculator> voxelCalc;
    for ( Ssiz_t a = 0; a != 4; ++a ){
      fbins[a] = voxelCalc->AxisToBin( a, coord[a] );
    }
  }

sim::LArVoxelID::LArVoxelID	(	const double	x,
		const double	y,
		const double	z,
		const double	t
	)

Definition at line 53 of file LArVoxelID.cxx.

References fbins, sim::LArVoxelCalculator::TAxisToBin(), sim::LArVoxelCalculator::XAxisToBin(), sim::LArVoxelCalculator::YAxisToBin(), and sim::LArVoxelCalculator::ZAxisToBin().

  {
    art::ServiceHandle<sim::LArVoxelCalculator> voxelCalc;

    // Convert each axis into its corresponding bin.
    fbins = std::vector<int>(4);
    fbins[0] = voxelCalc->XAxisToBin( x );
    fbins[1] = voxelCalc->YAxisToBin( y );
    fbins[2] = voxelCalc->ZAxisToBin( z );
    fbins[3] = voxelCalc->TAxisToBin( t );
  }

sim::LArVoxelID::~LArVoxelID ( )

virtual

Destructor.

Definition at line 67 of file LArVoxelID.cxx.

{}

Member Function Documentation

sim::LArVoxelID::operator TLorentzVector

(

)

const

Definition at line 172 of file LArVoxelID.cxx.

References T(), X(), Y(), and Z().

  { 
    return TLorentzVector( X(), Y(), Z(), T() ); 
  }

sim::LArVoxelID::operator TVector3

(

)

const

Definition at line 178 of file LArVoxelID.cxx.

References X(), Y(), and Z().

  { 
    return TVector3( X(), Y(), Z() ); 
  }

bool sim::LArVoxelID::operator<

(

const LArVoxelID &

other

)

const

The comparison operator. This a key function, since it establishes the sort order of the voxels in a list.

Definition at line 135 of file LArVoxelID.cxx.

References fbins.

  {
    // What is a good sort order for voxels in the list?  I'm not sure.
    // For now, pick an ordering but be prepared to change it: sort by
    // T, Z, X, then Y.

    if ( fbins[3] < other.fbins[3] ) return true;

    if ( fbins[3] == other.fbins[3] ){
      if ( fbins[2] < other.fbins[2] ) return true;
      
      if ( fbins[2] == other. fbins[2] ){
        if ( fbins[0] < other.fbins[0] ) return true;
        
        if ( fbins[0] == other.fbins[0] ){
          if ( fbins[1] < other.fbins[1] ) return true;
        }
      }
    }
    
    return false;
  }

bool sim::LArVoxelID::operator==

(

const LArVoxelID &

other

)

const

Test for equality. Handy, but not usually necessary.

Definition at line 160 of file LArVoxelID.cxx.

References fbins.

  {
    if ( fbins[0] == other.fbins[0]  &&
         fbins[1] == other.fbins[1]  &&
         fbins[2] == other.fbins[2]  &&
         fbins[3] == other.fbins[3] )
      return true;

    return false;
  }

double sim::LArVoxelID::operator[]

(

const int

i

)

const

Definition at line 100 of file LArVoxelID.cxx.

References T(), X(), Y(), and Z().

  {
    switch (i){
    case 0:
      return X(); break;
    case 1:
      return Y(); break;
    case 2:
      return Z(); break;
    case 3:
      return T(); break;
    }
    // I suppose I should put some error processing here; for now
    // I'll just return zero.
    return 0;
  }

double sim::LArVoxelID::T

(

)

const

Definition at line 93 of file LArVoxelID.cxx.

References fbins, and sim::LArVoxelCalculator::TBinToAxis().

Referenced by operator TLorentzVector(), and operator[]().

  { 
    art::ServiceHandle<sim::LArVoxelCalculator> voxelCalc;
    return voxelCalc->TBinToAxis(fbins[3]);
  }

int sim::LArVoxelID::TBin ( ) const

inline

Definition at line 146 of file LArVoxelID.h.

References fbins.

{ return fbins[3]; }

double sim::LArVoxelID::X

(

)

const

The accessors I expect to be used: The values of the co-ordinates at the bin centers.

Definition at line 72 of file LArVoxelID.cxx.

References fbins, and sim::LArVoxelCalculator::XBinToAxis().

Referenced by evd::SimulationDrawer::MCTruth3D(), evd::SimulationDrawer::MCTruthOrtho(), operator TLorentzVector(), operator TVector3(), and operator[]().

  { 
    art::ServiceHandle<sim::LArVoxelCalculator> voxelCalc;
    return voxelCalc->XBinToAxis(fbins[0]);
  }

int sim::LArVoxelID::XBin ( ) const

inline

Definition at line 143 of file LArVoxelID.h.

References fbins.

{ return fbins[0]; }

double sim::LArVoxelID::Y

(

)

const

Definition at line 79 of file LArVoxelID.cxx.

References fbins, and sim::LArVoxelCalculator::YBinToAxis().

Referenced by evd::SimulationDrawer::MCTruth3D(), evd::SimulationDrawer::MCTruthOrtho(), operator TLorentzVector(), operator TVector3(), and operator[]().

  { 
    art::ServiceHandle<sim::LArVoxelCalculator> voxelCalc;
    return voxelCalc->YBinToAxis(fbins[1]);
  }

int sim::LArVoxelID::YBin ( ) const

inline

Definition at line 144 of file LArVoxelID.h.

References fbins.

{ return fbins[1]; }

double sim::LArVoxelID::Z

(

)

const

Definition at line 86 of file LArVoxelID.cxx.

References fbins, and sim::LArVoxelCalculator::ZBinToAxis().

Referenced by evd::SimulationDrawer::MCTruth3D(), evd::SimulationDrawer::MCTruthOrtho(), operator TLorentzVector(), operator TVector3(), and operator[]().

  { 
    art::ServiceHandle<sim::LArVoxelCalculator> voxelCalc;
    return voxelCalc->ZBinToAxis(fbins[2]);
  }

int sim::LArVoxelID::ZBin ( ) const

inline

Definition at line 145 of file LArVoxelID.h.

References fbins.

{ return fbins[2]; }

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  output, const LArVoxelID &  id  )

friend

Put the contents on the output stream. We have a choice: write the bin number, or write the position represented by the bins. For now, let's pick writing the positions.

Definition at line 121 of file LArVoxelID.cxx.

  {
    output << "(" << id.X()
           << "," << id.Y()
           << "," << id.Z()
           << "," << id.T()
           << ")";

    return output;
  }

Member Data Documentation

std::vector<int> sim::LArVoxelID::fbins

private

Definition at line 91 of file LArVoxelID.h.

Referenced by LArVoxelID(), operator<(), operator==(), T(), TBin(), X(), XBin(), Y(), YBin(), Z(), and ZBin().

---

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

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