gVirtualXRay  2.0.10
VirtualX-RayImagingLibraryonGPU
Public Member Functions | Protected Attributes | Friends
gVirtualXRay::AttenuationCoefficient Class Reference

AttenuationCoefficient is a class to handle an attenuation coefficient. More...

#include <AttenuationCoefficient.h>

Collaboration diagram for gVirtualXRay::AttenuationCoefficient:
Collaboration graph

Public Member Functions

 AttenuationCoefficient (const RATIONAL_NUMBER &anEnergy=0, const RATIONAL_NUMBER &anAttenuationCoefficient=0)
 Default constructor. More...
 
RATIONAL_NUMBER getEnergy () const
 Accessor on the energy. More...
 
RATIONAL_NUMBER getAttenuationCoefficient () const
 Accessor on the attenuation coefficient. More...
 

Protected Attributes

RATIONAL_NUMBER m_energy
 Energy. More...
 
RATIONAL_NUMBER m_mu
 Attenuation coefficient corresponding to m_energy. More...
 

Friends

std::istream & operator>> (std::istream &is, AttenuationCoefficient &obj)
 operator>> More...
 
std::ostream & operator<< (std::ostream &os, const AttenuationCoefficient &obj)
 operator<< More...
 

Detailed Description

AttenuationCoefficient is a class to handle an attenuation coefficient.

Definition at line 126 of file AttenuationCoefficient.h.

Constructor & Destructor Documentation

◆ AttenuationCoefficient()

gVirtualXRay::AttenuationCoefficient::AttenuationCoefficient ( const RATIONAL_NUMBER anEnergy = 0,
const RATIONAL_NUMBER anAttenuationCoefficient = 0 
)
inline

Default constructor.

Parameters
anEnergythe energy (default value: 0)
anAttenuationCoefficientthe attenuation coefficient (default value: 0)

Definition at line 69 of file AttenuationCoefficient.inl.

Member Function Documentation

◆ getAttenuationCoefficient()

RATIONAL_NUMBER gVirtualXRay::AttenuationCoefficient::getAttenuationCoefficient ( ) const
inline

Accessor on the attenuation coefficient.

Returns
the attenuation coefficient

Definition at line 87 of file AttenuationCoefficient.inl.

◆ getEnergy()

RATIONAL_NUMBER gVirtualXRay::AttenuationCoefficient::getEnergy ( ) const
inline

Accessor on the energy.

Returns
the energy

Definition at line 79 of file AttenuationCoefficient.inl.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
const AttenuationCoefficient obj 
)
friend

operator<<

Parameters
osthe output stream
objthe record to store in the stream
Returns
the output stream

Definition at line 110 of file AttenuationCoefficient.inl.

◆ operator>>

std::istream& operator>> ( std::istream &  is,
AttenuationCoefficient obj 
)
friend

operator>>

Parameters
isthe input stream
objthe record to load from the stream
Returns
the input stream

Definition at line 95 of file AttenuationCoefficient.inl.

Field Documentation

◆ m_energy

RATIONAL_NUMBER gVirtualXRay::AttenuationCoefficient::m_energy
protected

Energy.

Definition at line 164 of file AttenuationCoefficient.h.

◆ m_mu

RATIONAL_NUMBER gVirtualXRay::AttenuationCoefficient::m_mu
protected

Attenuation coefficient corresponding to m_energy.

Definition at line 168 of file AttenuationCoefficient.h.


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