Medical Imaging Interaction Toolkit  2018.4.99-389bf124
Medical Imaging Interaction Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
mitk::pa::LightSource Class Reference

The LightSource class The representation of a LightSource. More...

#include <mitkPALightSource.h>

Inheritance diagram for mitk::pa::LightSource:
Inheritance graph
[legend]
Collaboration diagram for mitk::pa::LightSource:
Collaboration graph
[legend]

Classes

struct  PhotonInformation
 
struct  TransformResult
 

Public Types

enum  SpawnType { POINT, RECTANGLE, CIRCLE }
 
enum  DistributionMode { UNIFORM, GAUSSIAN }
 

Public Member Functions

 mitkClassMacroItkParent (LightSource, itk::Object)
 
 mitkNewMacro2Param (Self, TiXmlElement *, bool)
 
PhotonInformation GetNextPhoton (double rnd1, double rnd2, double rnd3, double rnd4, double rnd5, double gau1, double gau2)
 
bool IsValid ()
 
 LightSource (TiXmlElement *element, bool verbose)
 
 LightSource ()
 
 ~LightSource () override
 
void ParseAngle (TiXmlElement *direction, std::string angle)
 
virtual SpawnType GetSpawnType ()
 
virtual void SetSpawnType (SpawnType _arg)
 
virtual double GetSpawnLocationX ()
 
virtual void SetSpawnLocationX (double _arg)
 
virtual double GetSpawnLocationY ()
 
virtual void SetSpawnLocationY (double _arg)
 
virtual double GetSpawnLocationZ ()
 
virtual void SetSpawnLocationZ (double _arg)
 
virtual double GetSpawnLocationXLength ()
 
virtual void SetSpawnLocationXLength (double _arg)
 
virtual double GetSpawnLocationYLength ()
 
virtual void SetSpawnLocationYLength (double _arg)
 
virtual double GetSpawnLocationZLength ()
 
virtual void SetSpawnLocationZLength (double _arg)
 
virtual double GetSpawnLocationRadius ()
 
virtual void SetSpawnLocationRadius (double _arg)
 
virtual double GetEnergy ()
 
virtual void SetEnergy (double _arg)
 
virtual double GetAngleXMinimum ()
 
virtual void SetAngleXMinimum (double _arg)
 
virtual double GetAngleXMaximum ()
 
virtual void SetAngleXMaximum (double _arg)
 
virtual double GetAngleYMinimum ()
 
virtual void SetAngleYMinimum (double _arg)
 
virtual double GetAngleYMaximum ()
 
virtual void SetAngleYMaximum (double _arg)
 
virtual DistributionMode GetAngleXMode ()
 
virtual void SetAngleXMode (DistributionMode _arg)
 
virtual DistributionMode GetAngleYMode ()
 
virtual void SetAngleYMode (DistributionMode _arg)
 
virtual bool GetVerbose ()
 
virtual void SetVerbose (bool _arg)
 

Static Public Member Functions

static Pointer New ()
 

Public Attributes

const std::string XML_TAG_X_ANGLE
 
const std::string XML_TAG_Y_ANGLE
 
const std::string XML_TAG_PHOTON_DIRECTION
 
const std::string XML_TAG_MINIMUM
 
const std::string XML_TAG_MAXIMUM
 
const std::string XML_TAG_MODE
 
const std::string XML_TAG_ENERGY
 
const std::string XML_TAG_SPAWN_TYPE
 
const std::string XML_TAG_SPAWN_TYPE_POINT
 
const std::string XML_TAG_SPAWN_TYPE_RECTANGLE
 
const std::string XML_TAG_SPAWN_TYPE_CIRCLE
 
const std::string XML_TAG_X
 
const std::string XML_TAG_Y
 
const std::string XML_TAG_Z
 
const std::string XML_TAG_R
 
const std::string XML_TAG_X_LENGTH
 
const std::string XML_TAG_Y_LENGTH
 
const std::string XML_TAG_Z_LENGTH
 

Protected Member Functions

void ParsePhotonDirection (TiXmlElement *element)
 
void ParseEnergy (TiXmlElement *element)
 
void ParsePhotonSpawnArea (TiXmlElement *element)
 
TransformResult BoxMuellerTransform (double u1, double u2, double mu, double sigma)
 

Protected Attributes

const double TWO_PI
 
SpawnType m_SpawnType
 
double m_SpawnLocationX
 
double m_SpawnLocationY
 
double m_SpawnLocationZ
 
double m_SpawnLocationXLength
 
double m_SpawnLocationYLength
 
double m_SpawnLocationZLength
 
double m_SpawnLocationRadius
 
double m_Energy
 
double m_AngleXMinimum
 
double m_AngleXMaximum
 
double m_AngleYMinimum
 
double m_AngleYMaximum
 
DistributionMode m_AngleXMode
 
DistributionMode m_AngleYMode
 
bool m_IsValid
 
bool m_Verbose
 

Detailed Description

The LightSource class The representation of a LightSource.

Definition at line 33 of file mitkPALightSource.h.

Member Enumeration Documentation

◆ DistributionMode

enum mitk::pa::LightSource::DistributionMode
Enumerator
UNIFORM 
GAUSSIAN 

Definition at line 65 of file mitkPALightSource.h.

◆ SpawnType

enum mitk::pa::LightSource::SpawnType
Enumerator
POINT 
RECTANGLE 
CIRCLE 

Definition at line 60 of file mitkPALightSource.h.

Constructor & Destructor Documentation

◆ LightSource() [1/2]

mitk::pa::LightSource::LightSource ( TiXmlElement *  element,
bool  verbose 
)

Definition at line 21 of file mitkPALightSource.cpp.

References m_IsValid, m_Verbose, ParseEnergy(), ParsePhotonDirection(), and ParsePhotonSpawnArea().

◆ LightSource() [2/2]

mitk::pa::LightSource::LightSource ( )

Definition at line 16 of file mitkPALightSource.cpp.

◆ ~LightSource()

mitk::pa::LightSource::~LightSource ( )
override

Definition at line 41 of file mitkPALightSource.cpp.

Member Function Documentation

◆ BoxMuellerTransform()

mitk::pa::LightSource::TransformResult mitk::pa::LightSource::BoxMuellerTransform ( double  u1,
double  u2,
double  mu,
double  sigma 
)
protected

Definition at line 45 of file mitkPALightSource.cpp.

References TWO_PI, mitk::pa::LightSource::TransformResult::z0, and mitk::pa::LightSource::TransformResult::z1.

Referenced by GetNextPhoton().

◆ GetAngleXMaximum()

virtual double mitk::pa::LightSource::GetAngleXMaximum ( )
virtual

◆ GetAngleXMinimum()

virtual double mitk::pa::LightSource::GetAngleXMinimum ( )
virtual

◆ GetAngleXMode()

virtual DistributionMode mitk::pa::LightSource::GetAngleXMode ( )
virtual

◆ GetAngleYMaximum()

virtual double mitk::pa::LightSource::GetAngleYMaximum ( )
virtual

◆ GetAngleYMinimum()

virtual double mitk::pa::LightSource::GetAngleYMinimum ( )
virtual

◆ GetAngleYMode()

virtual DistributionMode mitk::pa::LightSource::GetAngleYMode ( )
virtual

◆ GetEnergy()

virtual double mitk::pa::LightSource::GetEnergy ( )
virtual

◆ GetNextPhoton()

mitk::pa::LightSource::PhotonInformation mitk::pa::LightSource::GetNextPhoton ( double  rnd1,
double  rnd2,
double  rnd3,
double  rnd4,
double  rnd5,
double  gau1,
double  gau2 
)

Definition at line 341 of file mitkPALightSource.cpp.

References BoxMuellerTransform(), CIRCLE, GAUSSIAN, m_AngleXMaximum, m_AngleXMinimum, m_AngleXMode, m_AngleYMaximum, m_AngleYMinimum, m_AngleYMode, m_SpawnLocationRadius, m_SpawnLocationX, m_SpawnLocationXLength, m_SpawnLocationY, m_SpawnLocationYLength, m_SpawnLocationZ, m_SpawnLocationZLength, m_SpawnType, m_Verbose, POINT, RECTANGLE, TWO_PI, UNIFORM, mitk::pa::LightSource::PhotonInformation::xAngle, mitk::pa::LightSource::PhotonInformation::xPosition, mitk::pa::LightSource::PhotonInformation::yAngle, mitk::pa::LightSource::PhotonInformation::yPosition, mitk::pa::LightSource::TransformResult::z0, mitk::pa::LightSource::TransformResult::z1, mitk::pa::LightSource::PhotonInformation::zAngle, and mitk::pa::LightSource::PhotonInformation::zPosition.

◆ GetSpawnLocationRadius()

virtual double mitk::pa::LightSource::GetSpawnLocationRadius ( )
virtual

◆ GetSpawnLocationX()

virtual double mitk::pa::LightSource::GetSpawnLocationX ( )
virtual

◆ GetSpawnLocationXLength()

virtual double mitk::pa::LightSource::GetSpawnLocationXLength ( )
virtual

◆ GetSpawnLocationY()

virtual double mitk::pa::LightSource::GetSpawnLocationY ( )
virtual

◆ GetSpawnLocationYLength()

virtual double mitk::pa::LightSource::GetSpawnLocationYLength ( )
virtual

◆ GetSpawnLocationZ()

virtual double mitk::pa::LightSource::GetSpawnLocationZ ( )
virtual

◆ GetSpawnLocationZLength()

virtual double mitk::pa::LightSource::GetSpawnLocationZLength ( )
virtual

◆ GetSpawnType()

virtual SpawnType mitk::pa::LightSource::GetSpawnType ( )
virtual

◆ GetVerbose()

virtual bool mitk::pa::LightSource::GetVerbose ( )
virtual

◆ IsValid()

bool mitk::pa::LightSource::IsValid ( )

Definition at line 407 of file mitkPALightSource.cpp.

References m_IsValid.

◆ mitkClassMacroItkParent()

mitk::pa::LightSource::mitkClassMacroItkParent ( LightSource  ,
itk::Object   
)

◆ mitkNewMacro2Param()

mitk::pa::LightSource::mitkNewMacro2Param ( Self  ,
TiXmlElement *  ,
bool   
)

◆ New()

static Pointer mitk::pa::LightSource::New ( )
static

Referenced by mitk::pa::Probe::InitProbe().

◆ ParseAngle()

void mitk::pa::LightSource::ParseAngle ( TiXmlElement *  direction,
std::string  angle 
)

Definition at line 86 of file mitkPALightSource.cpp.

References m_AngleXMaximum, m_AngleXMinimum, m_AngleXMode, m_AngleYMaximum, m_AngleYMinimum, m_AngleYMode, m_Verbose, XML_TAG_MAXIMUM, XML_TAG_MINIMUM, XML_TAG_MODE, XML_TAG_X_ANGLE, and XML_TAG_Y_ANGLE.

Referenced by ParsePhotonDirection().

◆ ParseEnergy()

void mitk::pa::LightSource::ParseEnergy ( TiXmlElement *  element)
protected

Definition at line 175 of file mitkPALightSource.cpp.

References m_Energy, m_Verbose, and XML_TAG_ENERGY.

Referenced by LightSource().

◆ ParsePhotonDirection()

void mitk::pa::LightSource::ParsePhotonDirection ( TiXmlElement *  element)
protected

Definition at line 53 of file mitkPALightSource.cpp.

References m_AngleXMaximum, m_AngleXMinimum, m_AngleXMode, m_AngleYMaximum, m_AngleYMinimum, m_AngleYMode, m_Verbose, ParseAngle(), XML_TAG_PHOTON_DIRECTION, XML_TAG_X_ANGLE, and XML_TAG_Y_ANGLE.

Referenced by LightSource().

◆ ParsePhotonSpawnArea()

void mitk::pa::LightSource::ParsePhotonSpawnArea ( TiXmlElement *  element)
protected

Definition at line 193 of file mitkPALightSource.cpp.

References m_IsValid, m_SpawnLocationRadius, m_SpawnLocationX, m_SpawnLocationXLength, m_SpawnLocationY, m_SpawnLocationYLength, m_SpawnLocationZ, m_SpawnLocationZLength, m_SpawnType, m_Verbose, XML_TAG_R, XML_TAG_SPAWN_TYPE, XML_TAG_SPAWN_TYPE_CIRCLE, XML_TAG_SPAWN_TYPE_POINT, XML_TAG_SPAWN_TYPE_RECTANGLE, XML_TAG_X, XML_TAG_X_LENGTH, XML_TAG_Y, XML_TAG_Y_LENGTH, XML_TAG_Z, and XML_TAG_Z_LENGTH.

Referenced by LightSource().

◆ SetAngleXMaximum()

virtual void mitk::pa::LightSource::SetAngleXMaximum ( double  _arg)
virtual

◆ SetAngleXMinimum()

virtual void mitk::pa::LightSource::SetAngleXMinimum ( double  _arg)
virtual

◆ SetAngleXMode()

virtual void mitk::pa::LightSource::SetAngleXMode ( DistributionMode  _arg)
virtual

◆ SetAngleYMaximum()

virtual void mitk::pa::LightSource::SetAngleYMaximum ( double  _arg)
virtual

◆ SetAngleYMinimum()

virtual void mitk::pa::LightSource::SetAngleYMinimum ( double  _arg)
virtual

◆ SetAngleYMode()

virtual void mitk::pa::LightSource::SetAngleYMode ( DistributionMode  _arg)
virtual

◆ SetEnergy()

virtual void mitk::pa::LightSource::SetEnergy ( double  _arg)
virtual

◆ SetSpawnLocationRadius()

virtual void mitk::pa::LightSource::SetSpawnLocationRadius ( double  _arg)
virtual

◆ SetSpawnLocationX()

virtual void mitk::pa::LightSource::SetSpawnLocationX ( double  _arg)
virtual

◆ SetSpawnLocationXLength()

virtual void mitk::pa::LightSource::SetSpawnLocationXLength ( double  _arg)
virtual

◆ SetSpawnLocationY()

virtual void mitk::pa::LightSource::SetSpawnLocationY ( double  _arg)
virtual

◆ SetSpawnLocationYLength()

virtual void mitk::pa::LightSource::SetSpawnLocationYLength ( double  _arg)
virtual

◆ SetSpawnLocationZ()

virtual void mitk::pa::LightSource::SetSpawnLocationZ ( double  _arg)
virtual

◆ SetSpawnLocationZLength()

virtual void mitk::pa::LightSource::SetSpawnLocationZLength ( double  _arg)
virtual

◆ SetSpawnType()

virtual void mitk::pa::LightSource::SetSpawnType ( SpawnType  _arg)
virtual

◆ SetVerbose()

virtual void mitk::pa::LightSource::SetVerbose ( bool  _arg)
virtual

Member Data Documentation

◆ m_AngleXMaximum

double mitk::pa::LightSource::m_AngleXMaximum
protected

Definition at line 156 of file mitkPALightSource.h.

Referenced by GetNextPhoton(), ParseAngle(), and ParsePhotonDirection().

◆ m_AngleXMinimum

double mitk::pa::LightSource::m_AngleXMinimum
protected

Definition at line 155 of file mitkPALightSource.h.

Referenced by GetNextPhoton(), ParseAngle(), and ParsePhotonDirection().

◆ m_AngleXMode

DistributionMode mitk::pa::LightSource::m_AngleXMode
protected

Definition at line 159 of file mitkPALightSource.h.

Referenced by GetNextPhoton(), ParseAngle(), and ParsePhotonDirection().

◆ m_AngleYMaximum

double mitk::pa::LightSource::m_AngleYMaximum
protected

Definition at line 158 of file mitkPALightSource.h.

Referenced by GetNextPhoton(), ParseAngle(), and ParsePhotonDirection().

◆ m_AngleYMinimum

double mitk::pa::LightSource::m_AngleYMinimum
protected

Definition at line 157 of file mitkPALightSource.h.

Referenced by GetNextPhoton(), ParseAngle(), and ParsePhotonDirection().

◆ m_AngleYMode

DistributionMode mitk::pa::LightSource::m_AngleYMode
protected

Definition at line 160 of file mitkPALightSource.h.

Referenced by GetNextPhoton(), ParseAngle(), and ParsePhotonDirection().

◆ m_Energy

double mitk::pa::LightSource::m_Energy
protected

Definition at line 153 of file mitkPALightSource.h.

Referenced by ParseEnergy().

◆ m_IsValid

bool mitk::pa::LightSource::m_IsValid
protected

Definition at line 162 of file mitkPALightSource.h.

Referenced by IsValid(), LightSource(), and ParsePhotonSpawnArea().

◆ m_SpawnLocationRadius

double mitk::pa::LightSource::m_SpawnLocationRadius
protected

Definition at line 151 of file mitkPALightSource.h.

Referenced by GetNextPhoton(), and ParsePhotonSpawnArea().

◆ m_SpawnLocationX

double mitk::pa::LightSource::m_SpawnLocationX
protected

Definition at line 145 of file mitkPALightSource.h.

Referenced by GetNextPhoton(), and ParsePhotonSpawnArea().

◆ m_SpawnLocationXLength

double mitk::pa::LightSource::m_SpawnLocationXLength
protected

Definition at line 148 of file mitkPALightSource.h.

Referenced by GetNextPhoton(), and ParsePhotonSpawnArea().

◆ m_SpawnLocationY

double mitk::pa::LightSource::m_SpawnLocationY
protected

Definition at line 146 of file mitkPALightSource.h.

Referenced by GetNextPhoton(), and ParsePhotonSpawnArea().

◆ m_SpawnLocationYLength

double mitk::pa::LightSource::m_SpawnLocationYLength
protected

Definition at line 149 of file mitkPALightSource.h.

Referenced by GetNextPhoton(), and ParsePhotonSpawnArea().

◆ m_SpawnLocationZ

double mitk::pa::LightSource::m_SpawnLocationZ
protected

Definition at line 147 of file mitkPALightSource.h.

Referenced by GetNextPhoton(), and ParsePhotonSpawnArea().

◆ m_SpawnLocationZLength

double mitk::pa::LightSource::m_SpawnLocationZLength
protected

Definition at line 150 of file mitkPALightSource.h.

Referenced by GetNextPhoton(), and ParsePhotonSpawnArea().

◆ m_SpawnType

SpawnType mitk::pa::LightSource::m_SpawnType
protected

Definition at line 144 of file mitkPALightSource.h.

Referenced by GetNextPhoton(), and ParsePhotonSpawnArea().

◆ m_Verbose

bool mitk::pa::LightSource::m_Verbose
protected

Definition at line 163 of file mitkPALightSource.h.

Referenced by GetNextPhoton(), LightSource(), ParseAngle(), ParseEnergy(), ParsePhotonDirection(), and ParsePhotonSpawnArea().

◆ TWO_PI

const double mitk::pa::LightSource::TWO_PI
protected

Definition at line 142 of file mitkPALightSource.h.

Referenced by BoxMuellerTransform(), and GetNextPhoton().

◆ XML_TAG_ENERGY

const std::string mitk::pa::LightSource::XML_TAG_ENERGY

Definition at line 47 of file mitkPALightSource.h.

Referenced by ParseEnergy().

◆ XML_TAG_MAXIMUM

const std::string mitk::pa::LightSource::XML_TAG_MAXIMUM

Definition at line 45 of file mitkPALightSource.h.

Referenced by ParseAngle().

◆ XML_TAG_MINIMUM

const std::string mitk::pa::LightSource::XML_TAG_MINIMUM

Definition at line 44 of file mitkPALightSource.h.

Referenced by ParseAngle().

◆ XML_TAG_MODE

const std::string mitk::pa::LightSource::XML_TAG_MODE

Definition at line 46 of file mitkPALightSource.h.

Referenced by ParseAngle().

◆ XML_TAG_PHOTON_DIRECTION

const std::string mitk::pa::LightSource::XML_TAG_PHOTON_DIRECTION

Definition at line 43 of file mitkPALightSource.h.

Referenced by ParsePhotonDirection().

◆ XML_TAG_R

const std::string mitk::pa::LightSource::XML_TAG_R

Definition at line 55 of file mitkPALightSource.h.

Referenced by ParsePhotonSpawnArea().

◆ XML_TAG_SPAWN_TYPE

const std::string mitk::pa::LightSource::XML_TAG_SPAWN_TYPE

Definition at line 48 of file mitkPALightSource.h.

Referenced by ParsePhotonSpawnArea().

◆ XML_TAG_SPAWN_TYPE_CIRCLE

const std::string mitk::pa::LightSource::XML_TAG_SPAWN_TYPE_CIRCLE

Definition at line 51 of file mitkPALightSource.h.

Referenced by ParsePhotonSpawnArea().

◆ XML_TAG_SPAWN_TYPE_POINT

const std::string mitk::pa::LightSource::XML_TAG_SPAWN_TYPE_POINT

Definition at line 49 of file mitkPALightSource.h.

Referenced by ParsePhotonSpawnArea().

◆ XML_TAG_SPAWN_TYPE_RECTANGLE

const std::string mitk::pa::LightSource::XML_TAG_SPAWN_TYPE_RECTANGLE

Definition at line 50 of file mitkPALightSource.h.

Referenced by ParsePhotonSpawnArea().

◆ XML_TAG_X

const std::string mitk::pa::LightSource::XML_TAG_X

Definition at line 52 of file mitkPALightSource.h.

Referenced by ParsePhotonSpawnArea().

◆ XML_TAG_X_ANGLE

const std::string mitk::pa::LightSource::XML_TAG_X_ANGLE

Definition at line 41 of file mitkPALightSource.h.

Referenced by ParseAngle(), and ParsePhotonDirection().

◆ XML_TAG_X_LENGTH

const std::string mitk::pa::LightSource::XML_TAG_X_LENGTH

Definition at line 56 of file mitkPALightSource.h.

Referenced by ParsePhotonSpawnArea().

◆ XML_TAG_Y

const std::string mitk::pa::LightSource::XML_TAG_Y

Definition at line 53 of file mitkPALightSource.h.

Referenced by ParsePhotonSpawnArea().

◆ XML_TAG_Y_ANGLE

const std::string mitk::pa::LightSource::XML_TAG_Y_ANGLE

Definition at line 42 of file mitkPALightSource.h.

Referenced by ParseAngle(), and ParsePhotonDirection().

◆ XML_TAG_Y_LENGTH

const std::string mitk::pa::LightSource::XML_TAG_Y_LENGTH

Definition at line 57 of file mitkPALightSource.h.

Referenced by ParsePhotonSpawnArea().

◆ XML_TAG_Z

const std::string mitk::pa::LightSource::XML_TAG_Z

Definition at line 54 of file mitkPALightSource.h.

Referenced by ParsePhotonSpawnArea().

◆ XML_TAG_Z_LENGTH

const std::string mitk::pa::LightSource::XML_TAG_Z_LENGTH

Definition at line 58 of file mitkPALightSource.h.

Referenced by ParsePhotonSpawnArea().

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