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

The Probe class The representation of a Probe. More...

#include <mitkPAProbe.h>

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

Public Member Functions

 mitkClassMacroItkParent (Probe, itk::LightObject)
 
 mitkNewMacro2Param (Self, std::string, bool)
 
 mitkNewMacro2Param (Self, const char *, bool)
 
LightSource::PhotonInformation GetNextPhoton (double rng1, double rnd2, double rnd3, double rnd4, double rnd5, double rnd6, double rnd7, double rnd8)
 
bool IsValid ()
 
 Probe (std::string xmlFile, bool verbose)
 
 Probe (const char *fileStream, bool verbose)
 
 ~Probe () override
 

Public Attributes

const std::string XML_TAG_PROBE
 
const std::string XML_TAG_LIGHT_SOURCE
 

Protected Member Functions

void InitProbe (TiXmlDocument document)
 

Protected Attributes

std::vector< LightSource::Pointer > m_LightSources
 
bool m_IsValid
 
double m_TotalEnergy
 
bool m_Verbose
 

Detailed Description

The Probe class The representation of a Probe.

Definition at line 34 of file mitkPAProbe.h.

Constructor & Destructor Documentation

◆ Probe() [1/2]

mitk::pa::Probe::Probe ( std::string  xmlFile,
bool  verbose 
)

Definition at line 15 of file mitkPAProbe.cpp.

References InitProbe(), and m_Verbose.

◆ Probe() [2/2]

mitk::pa::Probe::Probe ( const char *  fileStream,
bool  verbose 
)

Definition at line 40 of file mitkPAProbe.cpp.

References InitProbe(), and m_Verbose.

◆ ~Probe()

mitk::pa::Probe::~Probe ( )
override

Definition at line 65 of file mitkPAProbe.cpp.

Member Function Documentation

◆ GetNextPhoton()

mitk::pa::LightSource::PhotonInformation mitk::pa::Probe::GetNextPhoton ( double  rng1,
double  rnd2,
double  rnd3,
double  rnd4,
double  rnd5,
double  rnd6,
double  rnd7,
double  rnd8 
)

Definition at line 69 of file mitkPAProbe.cpp.

References m_LightSources, and m_TotalEnergy.

◆ InitProbe()

void mitk::pa::Probe::InitProbe ( TiXmlDocument  document)
protected

Definition at line 91 of file mitkPAProbe.cpp.

References m_IsValid, m_LightSources, m_TotalEnergy, m_Verbose, mitk::pa::LightSource::New(), XML_TAG_LIGHT_SOURCE, and XML_TAG_PROBE.

Referenced by Probe().

◆ IsValid()

bool mitk::pa::Probe::IsValid ( )

Definition at line 86 of file mitkPAProbe.cpp.

References m_IsValid.

◆ mitkClassMacroItkParent()

mitk::pa::Probe::mitkClassMacroItkParent ( Probe  ,
itk::LightObject   
)

◆ mitkNewMacro2Param() [1/2]

mitk::pa::Probe::mitkNewMacro2Param ( Self  ,
std::string  ,
bool   
)

◆ mitkNewMacro2Param() [2/2]

mitk::pa::Probe::mitkNewMacro2Param ( Self  ,
const char *  ,
bool   
)

Member Data Documentation

◆ m_IsValid

bool mitk::pa::Probe::m_IsValid
protected

Definition at line 57 of file mitkPAProbe.h.

Referenced by InitProbe(), and IsValid().

◆ m_LightSources

std::vector<LightSource::Pointer> mitk::pa::Probe::m_LightSources
protected

Definition at line 56 of file mitkPAProbe.h.

Referenced by GetNextPhoton(), and InitProbe().

◆ m_TotalEnergy

double mitk::pa::Probe::m_TotalEnergy
protected

Definition at line 58 of file mitkPAProbe.h.

Referenced by GetNextPhoton(), and InitProbe().

◆ m_Verbose

bool mitk::pa::Probe::m_Verbose
protected

Definition at line 59 of file mitkPAProbe.h.

Referenced by InitProbe(), and Probe().

◆ XML_TAG_LIGHT_SOURCE

const std::string mitk::pa::Probe::XML_TAG_LIGHT_SOURCE

Definition at line 43 of file mitkPAProbe.h.

Referenced by InitProbe().

◆ XML_TAG_PROBE

const std::string mitk::pa::Probe::XML_TAG_PROBE

Definition at line 42 of file mitkPAProbe.h.

Referenced by InitProbe().

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