Photon Class Reference

#include <Photon.h>

List of all members.

Public Member Functions
	Photon ()
	Photon (const Vector3 &pos, const Vector3 &dir, const Vector3 &pow)
	Photon (const Photon &src)
Photon &	operator= (const Photon &)
virtual	~Photon ()
Vector3	getDirection () const
Vector3	getLocation () const
Vector3	getPower () const
void	setLocation (const Vector3 &loc)
Protected Attributes
float	_position [3]
Vector3	_power
unsigned char	_phi
	azimuth angle with respect to Z coord !!!
unsigned char	_theta
	elevation angle with respect to Z coord !!!
short	_plane
Static Protected Attributes
static const double	COS_THETA [256]
static const double	SIN_THETA [256]
static const double	COS_PHI [256]
static const double	SIN_PHI [256]
Friends
class	PhotonMap
ostream &	operator<< (ostream &out, const Photon &photon)

---

Detailed Description

Definition at line 14 of file Photon.h.

---

Constructor & Destructor Documentation

Photon (   )

Implicit constructor sets all values to zero Definition at line 194 of file Photon.cc. References Photon::_phi, Photon::_plane, Photon::_position, Photon::_power, and Photon::_theta.

Photon (  const Vector3 &  pos, const Vector3 &  dir, const Vector3 &  pow )

Constructor. Parameters: pos  Photon's location dir  Photon's normalized directon pow  Phoron's power (color) Definition at line 205 of file Photon.cc. References Photon::_phi, Photon::_plane, Photon::_position, Photon::_power, Photon::_theta, and M_PI.

Photon (  const Photon &  src  )

Cloning constructor Parameters: src  Source photon Definition at line 223 of file Photon.cc. References Photon::_phi, Photon::_plane, Photon::_position, Photon::_power, and Photon::_theta.

virtual ~Photon (   )  [inline, virtual]

Definition at line 53 of file Photon.h.

---

Member Function Documentation

Vector3 getDirection (   )  const [inline]

Returns: Photon's direction in world coordinates Definition at line 58 of file Photon.h. References Photon::_phi, Photon::_theta, Photon::COS_PHI, Photon::COS_THETA, Photon::SIN_PHI, and Photon::SIN_THETA.

Vector3 getLocation (   )  const [inline]

Returns: Photon's location in the world coordinates Definition at line 68 of file Photon.h. References Photon::_position.

Vector3 getPower (   )  const [inline]

Returns: Photon's power Definition at line 75 of file Photon.h. References Photon::_power.

Photon & operator= (  const Photon &   )

Definition at line 234 of file Photon.cc. References Photon::_phi, Photon::_plane, Photon::_position, Photon::_power, and Photon::_theta.

void setLocation (  const Vector3 &  loc  )  [inline]

Sets nre location. Parameters: loc  New location Definition at line 82 of file Photon.h. References Photon::_position.

---

Friends And Related Function Documentation

ostream& operator<< (  ostream &  out, const Photon &  photon )  [friend]

Parameters: out  ostream photon  photon to print out Returns: reference to changed output stream Definition at line 93 of file Photon.h.

friend class PhotonMap [friend]

Definition at line 15 of file Photon.h.

---

Member Data Documentation

unsigned char _phi [protected]

azimuth angle with respect to Z coord !!! Definition at line 25 of file Photon.h. Referenced by Photon::getDirection(), Photon::operator=(), and Photon::Photon().

short _plane [protected]

Definition at line 27 of file Photon.h. Referenced by PhotonMap::_balance_segment(), PhotonMap::_locate_photons(), Photon::operator=(), and Photon::Photon().

float _position[3] [protected]

Definition at line 23 of file Photon.h. Referenced by PhotonMap::_balance_segment(), PhotonMap::_locate_photons(), PhotonMap::_median_split(), Photon::getLocation(), Photon::operator=(), Photon::Photon(), and Photon::setLocation().

Vector3 _power [protected]

Definition at line 24 of file Photon.h. Referenced by Photon::getPower(), Photon::operator=(), and Photon::Photon().

unsigned char _theta [protected]

elevation angle with respect to Z coord !!! Definition at line 26 of file Photon.h. Referenced by Photon::getDirection(), Photon::operator=(), and Photon::Photon().

const double COS_PHI [static, protected]

Definition at line 20 of file Photon.h. Referenced by Photon::getDirection().

const double COS_THETA [static, protected]

Definition at line 18 of file Photon.h. Referenced by Photon::getDirection().

const double SIN_PHI [static, protected]

Definition at line 21 of file Photon.h. Referenced by Photon::getDirection().

const double SIN_THETA [static, protected]

Definition at line 19 of file Photon.h. Referenced by Photon::getDirection().

---

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

• esg/include/esg/energy/Photon.h
• esg/src/Photon.cc

---