MIDSX 0.1
A x-ray transport code system for dosimetry
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
PhotonSource Class Reference

Class which represents a photon source. More...

#include <source.h>

Collaboration diagram for PhotonSource:

Public Member Functions

 PhotonSource (std::unique_ptr< EnergySpectrum > energy_spectrum, std::unique_ptr< Directionality > directionality, std::unique_ptr< SourceGeometry > source_geometry)
 Constructor for the PhotonSource class.
 
Photon generatePhoton ()
 Returns a photon generated from the photon source.
 

Private Attributes

std::unique_ptr< EnergySpectrumenergy_spectrum_
 
std::unique_ptr< Directionalitydirectionality_
 
std::unique_ptr< SourceGeometrysource_geometry_
 

Detailed Description

Class which represents a photon source.

The photon source is a combination of an energy spectrum, a directionality, and a geometry.

Definition at line 241 of file source.h.

Constructor & Destructor Documentation

◆ PhotonSource()

PhotonSource::PhotonSource ( std::unique_ptr< EnergySpectrum > energy_spectrum,
std::unique_ptr< Directionality > directionality,
std::unique_ptr< SourceGeometry > source_geometry )

Constructor for the PhotonSource class.

Parameters
energy_spectrumThe energy spectrum of the photon source.
directionalityThe directionality of the photon source.
source_geometryThe geometry of the photon source.

Member Function Documentation

◆ generatePhoton()

Photon PhotonSource::generatePhoton ( )

Returns a photon generated from the photon source.

Returns

Member Data Documentation

◆ directionality_

std::unique_ptr<Directionality> PhotonSource::directionality_
private

Definition at line 262 of file source.h.

◆ energy_spectrum_

std::unique_ptr<EnergySpectrum> PhotonSource::energy_spectrum_
private

Definition at line 261 of file source.h.

◆ source_geometry_

std::unique_ptr<SourceGeometry> PhotonSource::source_geometry_
private

Definition at line 263 of file source.h.


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