gVirtualXRay  2.0.10
VirtualX-RayImagingLibraryonGPU
Public Member Functions | Static Public Member Functions | Friends
gVirtualXRay::MaterialSet Class Reference

MaterialSet is a class to manage a table of materials. More...

#include <MaterialSet.h>

Collaboration diagram for gVirtualXRay::MaterialSet:
Collaboration graph

Public Member Functions

 ~MaterialSet ()
 Destructor. More...
 
void clearMemory ()
 Clear all the memory. More...
 
void loadFromFile (const std::string &aFileName)
 Load a file containing materials. More...
 
void loadMaterialSetFromMemory ()
 Load the table of materials. More...
 
void addMaterial (const TissueMaterial &aMaterial)
 Add a material to the list. More...
 
const TissueMaterialgetMaterial (short aHUValue) const
 Get the material corresponding to a given HU value. More...
 
float getMuMinEnergy () const
 Accessor on the lower energy cutoff for attenuation coefficient. More...
 
float getMuMaxEnergy () const
 Accessor on the higher energy cutoff for attenuation coefficient. More...
 
short getMinHU () const
 Accessor on the minimum Hounsfield unit that the material set can handle. More...
 
short getMaxHU () const
 Accessor on the maximum Hounsfield unit that the material set can handle. More...
 
unsigned int getMaterialNumber () const
 Accessor on the number of materials in the set. More...
 

Static Public Member Functions

static MaterialSetgetInstance ()
 

Friends

std::ostream & operator<< (std::ostream &anOutputSream, const MaterialSet &anMaterialSet)
 operator << More...
 

Detailed Description

MaterialSet is a class to manage a table of materials.

Definition at line 94 of file MaterialSet.h.

Constructor & Destructor Documentation

◆ ~MaterialSet()

gVirtualXRay::MaterialSet::~MaterialSet ( )
inline

Destructor.

Definition at line 84 of file MaterialSet.inl.

Member Function Documentation

◆ addMaterial()

void gVirtualXRay::MaterialSet::addMaterial ( const TissueMaterial aMaterial)

Add a material to the list.

◆ clearMemory()

void gVirtualXRay::MaterialSet::clearMemory ( )
inline

Clear all the memory.

Definition at line 92 of file MaterialSet.inl.

◆ getInstance()

static MaterialSet& gVirtualXRay::MaterialSet::getInstance ( )
static

◆ getMaterial()

const TissueMaterial& gVirtualXRay::MaterialSet::getMaterial ( short  aHUValue) const

Get the material corresponding to a given HU value.

◆ getMaterialNumber()

unsigned int gVirtualXRay::MaterialSet::getMaterialNumber ( ) const
inline

Accessor on the number of materials in the set.

Definition at line 128 of file MaterialSet.inl.

◆ getMaxHU()

short gVirtualXRay::MaterialSet::getMaxHU ( ) const
inline

Accessor on the maximum Hounsfield unit that the material set can handle.

Definition at line 121 of file MaterialSet.inl.

◆ getMinHU()

short gVirtualXRay::MaterialSet::getMinHU ( ) const
inline

Accessor on the minimum Hounsfield unit that the material set can handle.

Definition at line 115 of file MaterialSet.inl.

◆ getMuMaxEnergy()

float gVirtualXRay::MaterialSet::getMuMaxEnergy ( ) const
inline

Accessor on the higher energy cutoff for attenuation coefficient.

Definition at line 108 of file MaterialSet.inl.

◆ getMuMinEnergy()

float gVirtualXRay::MaterialSet::getMuMinEnergy ( ) const
inline

Accessor on the lower energy cutoff for attenuation coefficient.

Definition at line 100 of file MaterialSet.inl.

◆ loadFromFile()

void gVirtualXRay::MaterialSet::loadFromFile ( const std::string &  aFileName)

Load a file containing materials.

◆ loadMaterialSetFromMemory()

void gVirtualXRay::MaterialSet::loadMaterialSetFromMemory ( )

Load the table of materials.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  anOutputSream,
const MaterialSet anMaterialSet 
)
friend

operator <<

Definition at line 136 of file MaterialSet.inl.


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