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

Class which represents a beam directionality. More...

#include <source.h>

Collaboration diagram for BeamDirectionality:

Public Member Functions

 BeamDirectionality (Eigen::Vector3d pass_through_point)
 Constructor for the BeamDirectionality class.
 
Eigen::Vector3d sampleDirection (const Eigen::Vector3d &photon_initial_position) override
 Returns a sample from the beam directionality.
 

Private Attributes

Eigen::Vector3d pass_through_point_
 

Detailed Description

Class which represents a beam directionality.

The beam directionality is infinitely narrow and passes through a point.

Definition at line 115 of file source.h.

Constructor & Destructor Documentation

◆ BeamDirectionality()

BeamDirectionality::BeamDirectionality ( Eigen::Vector3d pass_through_point)
explicit

Constructor for the BeamDirectionality class.

Parameters
pass_through_pointThe point that the beam passes through.

Member Function Documentation

◆ sampleDirection()

Eigen::Vector3d BeamDirectionality::sampleDirection ( const Eigen::Vector3d & photon_initial_position)
overridevirtual

Returns a sample from the beam directionality.

Returns
A sample from the beam directionality.

Implements Directionality.

Member Data Documentation

◆ pass_through_point_

Eigen::Vector3d BeamDirectionality::pass_through_point_
private

Definition at line 131 of file source.h.


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