RadioBio::Dose Class Reference

#include <Doxymodules_medical.h>

Inheritance diagram for RadioBio::Dose:

Public Member Functions
	Dose ()
	~Dose () override
void	AddFromAccumulable (G4VAccumulable *) override
void	Initialize () override
void	Compute () override
void	Reset () override
void	Store () override
void	PrintParameters () override
array_type	GetDose () const
Public Member Functions inherited from RadioBio::VRadiobiologicalQuantity
	VRadiobiologicalQuantity ()
virtual	~VRadiobiologicalQuantity ()
G4bool	IsCalculationEnabled () const
G4bool	HasBeenCalculated () const
void	SetCalculationEnabled (G4bool enabled)
void	SetVerboseLevel (G4int level)
G4int	GetVerboseLevel () const
void	SetPath (G4String fN)
void	PrintVirtualParameters ()

Private Member Functions
void	SetEnergyDeposit (const array_type Dep)
void	AddEnergyDeposit (const array_type Dep)

Private Attributes
array_type	fEnDep = {}
array_type	fDose = {}

Friends
class	RBE

Additional Inherited Members
Public Types inherited from RadioBio::VRadiobiologicalQuantity
using	array_type = std::valarray< G4double >
Protected Attributes inherited from RadioBio::VRadiobiologicalQuantity
G4UImessenger *	fMessenger = nullptr
G4int	fVerboseLevel = 1
G4bool	fInitialized = false
G4bool	fSaved = false
G4bool	fCalculated = false
G4String	fPath
G4bool	fCalculationEnabled = false

Detailed Description

Definition at line 129 of file Doxymodules_medical.h.

Constructor & Destructor Documentation

Dose()

RadioBio::Dose::Dose

(

)

Definition at line 48 of file Dose.cc.

{
  // Default output filename
  fPath = "RadioBio_Dose.out";
 
  // Create the messenger
  fMessenger = new DoseMessenger(this);
 
  // Initialize the class
  Initialize();
}

~Dose()

RadioBio::Dose::~Dose ( )

override

Definition at line 62 of file Dose.cc.

{
  delete fMessenger;
}

Member Function Documentation

AddFromAccumulable()

void RadioBio::Dose::AddFromAccumulable ( G4VAccumulable *  GenAcc )

overridevirtual

Implements RadioBio::VRadiobiologicalQuantity.

Definition at line 156 of file Dose.cc.

{
  DoseAccumulable* acc = (DoseAccumulable*)GenAcc;
  AddEnergyDeposit(acc->GetEnDeposit());
  fCalculated = false;
}

Initialize()

void RadioBio::Dose::Initialize ( )

overridevirtual

Implements RadioBio::VRadiobiologicalQuantity.

Definition at line 69 of file Dose.cc.

{
  if (fVerboseLevel > 0) G4cout << "Dose::Initialize() called" << G4endl;
 
  G4int VoxelNumber = VoxelizedSensitiveDetector::GetInstance()->GetTotalVoxelNumber();
 
  fEnDep.resize(VoxelNumber);
  fDose.resize(VoxelNumber);
  fInitialized = true;
}

Compute()

void RadioBio::Dose::Compute ( )

overridevirtual

Implements RadioBio::VRadiobiologicalQuantity.

Definition at line 82 of file Dose.cc.

{
  // Skip Dose computation if calculation not enabled.
  if (!fCalculationEnabled) {
    if (fVerboseLevel > 0) {
      G4cout << "Dose::Compute() called but skipped as calculation not enabled" << G4endl;
    }
    return;
  }
 
  if (fCalculated) return;
 
  if (fVerboseLevel > 0) G4cout << "Dose::Compute() called" << G4endl;
 
  auto voxSensDet = VoxelizedSensitiveDetector::GetInstance();
 
  if (voxSensDet == nullptr)
    G4Exception("Dose::Compute", "VoxNotInit", FatalException,
                "Calculating dose without voxelized geometry pointer!");
 
  G4double voxelMass = voxSensDet->GetVoxelMass();
 
  for (G4int v = 0; v < voxSensDet->GetTotalVoxelNumber(); v++) {
    if (fVerboseLevel > 1) G4cout << "Calculating Dose for voxel number " << v << G4endl;
 
    // compute total Dose
    fDose[v] = fEnDep[v] / voxelMass;
  }
 
  fCalculated = true;
}

Reset()

void RadioBio::Dose::Reset ( )

overridevirtual

Implements RadioBio::VRadiobiologicalQuantity.

Definition at line 165 of file Dose.cc.

{
  if (fVerboseLevel > 1) {
    G4cout << "Dose::Reset(): ";
  }
  fEnDep = 0.0;
  fDose = 0.0;
  fCalculated = false;
}

Store()

void RadioBio::Dose::Store ( )

overridevirtual

Implements RadioBio::VRadiobiologicalQuantity.

Definition at line 116 of file Dose.cc.

{
  // Skip Dose store if calculation not enabled.
  if (!fCalculationEnabled) {
    if (fVerboseLevel > 0) {
      G4cout << "Dose::Store() called but skipped as calculation not enabled" << G4endl;
    }
    return;
  }
 
  if (fSaved == true)
    G4Exception("Dose::Store", "DoseOverwrite", JustWarning,
                "Overwriting Dose file. For multiple runs, change filename.");
 
  Compute();
 
  std::ofstream ofs(fPath);
 
  if (ofs.is_open()) {
    ofs << "x_index" << std::setw(width) << "y_index" << std::setw(width) << "z_index"
        << std::setw(width) << "Dose (Gy)" << G4endl;
 
    auto voxSensDet = VoxelizedSensitiveDetector::GetInstance();
 
    for (G4int i = 0; i < voxSensDet->GetVoxelNumberAlongX(); i++)
      for (G4int j = 0; j < voxSensDet->GetVoxelNumberAlongY(); j++)
        for (G4int k = 0; k < voxSensDet->GetVoxelNumberAlongZ(); k++) {
          G4int v = voxSensDet->GetThisVoxelNumber(i, j, k);
          ofs << i << std::setw(width) << j << std::setw(width) << k << std::setw(width)
              << fDose[v] / gray << G4endl;
        }
  }
  if (fVerboseLevel > 0) {
    G4cout << "Dose: Dose written to " << fPath << G4endl;
  }
  fSaved = true;
}

PrintParameters()

void RadioBio::Dose::PrintParameters ( )

overridevirtual

Reimplemented from RadioBio::VRadiobiologicalQuantity.

Definition at line 177 of file Dose.cc.

{
  G4cout << "*******************************************" << G4endl
         << "****** Parameters of the class Dose *******" << G4endl
         << "*******************************************" << G4endl;
  PrintVirtualParameters();
}

GetDose()

array_type RadioBio::Dose::GetDose ( ) const

inline

Definition at line 66 of file Dose.hh.

    {
      return fDose;
    }

SetEnergyDeposit()

void RadioBio::Dose::SetEnergyDeposit ( const array_type  Dep )

inlineprivate

Definition at line 77 of file Dose.hh.

    {
      fEnDep = Dep;
    }

AddEnergyDeposit()

void RadioBio::Dose::AddEnergyDeposit ( const array_type  Dep )

inlineprivate

Definition at line 81 of file Dose.hh.

    {
      fEnDep += Dep;
    }

Friends And Related Symbol Documentation

RBE

friend class RBE

friend

Definition at line 51 of file Dose.hh.

Member Data Documentation

fEnDep

array_type RadioBio::Dose::fEnDep = {}

private

Definition at line 73 of file Dose.hh.

{};

fDose

array_type RadioBio::Dose::fDose = {}

private

Definition at line 74 of file Dose.hh.

{};

---

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

• .doxygen/Doxymodules_medical.h
• extended/medical/radiobiology/include/Dose.hh
• extended/medical/radiobiology/src/Dose.cc