DicomRun Class Reference

DicomRun class. More...

#include <Doxymodules_medical.h>

Inheritance diagram for DicomRun:

Public Member Functions
	DicomRun ()
	(Description) DicomRun Class is for accumulating scored quantities which is scored using G4MutiFunctionalDetector and G4VPrimitiveScorer.
	DicomRun (const std::vector< G4String > mfdName)
virtual	~DicomRun ()
virtual void	RecordEvent (const G4Event *)
size_t	GetNumberOfHitsMap () const
G4THitsMap< G4double > *	GetHitsMap (G4int i) const
G4THitsMap< G4double > *	GetHitsMap (const G4String &detName, const G4String &colName) const
G4THitsMap< G4double > *	GetHitsMap (const G4String &fullName) const
void	ConstructMFD (const std::vector< G4String > &)
virtual void	Merge (const G4Run *)

Private Attributes
std::vector< G4String >	fCollName
std::vector< G4int >	fCollID
std::vector< G4THitsMap< G4double > * >	fRunMap

Detailed Description

DicomRun class.

Example implementation for multi-functional-detector and primitive scorer. This DicomRun class has collections which accumulate a event information into a run information.

Definition at line 32 of file Doxymodules_medical.h.

Constructor & Destructor Documentation

DicomRun() [1/2]

DicomRun::DicomRun

(

)

(Description) DicomRun Class is for accumulating scored quantities which is scored using G4MutiFunctionalDetector and G4VPrimitiveScorer.

Accumulation is done using G4THitsMap object.

The constructor DicomRun(const std::vector<G4String> mfdName) needs a vector filled with MultiFunctionalDetector names which was assigned at instantiation of MultiFunctionalDetector(MFD). Then DicomRun constructor automatically scans primitive scorers in the MFD, and obtains collectionIDs of all collections associated to those primitive scorers. Futhermore, the G4THitsMap objects for accumulating during a RUN are automatically created too. (*) Collection Name is same as primitive scorer name.

The resultant information is kept inside DicomRun objects as data members. std::vector<G4String> fCollName; // Collection Name, std::vector<G4int> fCollID; // Collection ID, std::vector<G4THitsMap<G4double>*> fRunMap; // HitsMap for RUN.

The resualtant HitsMap objects are obtain using access method, GetHitsMap(..).

Definition at line 66 of file DicomRun.cc.

: G4Run()
{ }

DicomRun() [2/2]

DicomRun::DicomRun

(

const std::vector< G4String >

mfdName

)

Definition at line 74 of file DicomRun.cc.

                                                   : G4Run()
{
    ConstructMFD(mfdName);
}

~DicomRun()

DicomRun::~DicomRun ( )

virtual

Definition at line 83 of file DicomRun.cc.

{
  //--- Clear HitsMap for RUN
  size_t Nmap = fRunMap.size();
  for ( size_t i = 0; i < Nmap; ++i)
  {
    if(fRunMap[i] ) fRunMap[i]->clear();
  }
  fCollName.clear();
  fCollID.clear();
  fRunMap.clear();
}

Member Function Documentation

RecordEvent()

void DicomRun::RecordEvent ( const G4Event *  aEvent )

virtual

Reimplemented in Dicom2Run.

Definition at line 157 of file DicomRun.cc.

{
  // disable below because this is done in G4Run::RecordEvent(aEvent);
  //numberOfEvent++;  // This is an original line.
  
  //G4cout << "Dicom Run :: Recording event " << aEvent->GetEventID() 
  //<< "..." << G4endl;
  //=============================
  // HitsCollection of This Event
  //============================
  G4HCofThisEvent* HCE = aEvent->GetHCofThisEvent();
  if (!HCE) return;
  
  //=======================================================
  // Sum up HitsMap of this Event  into HitsMap of this RUN
  //=======================================================
  size_t Ncol = fCollID.size();
  for ( size_t i = 0; i < Ncol ; ++i )  // Loop over HitsCollection
  {
    G4THitsMap<G4double>* EvtMap = nullptr;
    if ( fCollID[i] >= 0 )           // Collection is attached to HCE
    {
      EvtMap = static_cast<G4THitsMap<G4double>*>(HCE->GetHC(fCollID[i]));
    }
    else
    {
      G4cout <<" Error EvtMap Not Found "<< i << G4endl;
    }
    if ( EvtMap )
    {
      //=== Sum up HitsMap of this event to HitsMap of RUN.===
      *fRunMap[i] += *EvtMap;
      //G4cout << "Summing EvtMap into RunMap at " << i << "..." << G4endl;
      //======================================================
    } //else {
    //G4cout << "Null pointer to EvtMap at " << i << "..." << G4endl;
    //}
  }
  
  G4Run::RecordEvent(aEvent);
  
}

GetNumberOfHitsMap()

size_t DicomRun::GetNumberOfHitsMap ( ) const

inline

Definition at line 67 of file DicomRun.hh.

{return fRunMap.size();}

GetHitsMap() [1/3]

G4THitsMap< G4double > * DicomRun::GetHitsMap ( G4int  i ) const

inline

Definition at line 71 of file DicomRun.hh.

{return fRunMap[i];}

GetHitsMap() [2/3]

G4THitsMap< G4double > * DicomRun::GetHitsMap	(	const G4String &	detName,
		const G4String &	colName
	)		const

Definition at line 224 of file DicomRun.cc.

{
  G4String fullName = detName+"/"+colName;
  return GetHitsMap(fullName);
}

GetHitsMap() [3/3]

G4THitsMap< G4double > * DicomRun::GetHitsMap

(

const G4String &

fullName

)

const

Definition at line 235 of file DicomRun.cc.

{
  
  //G4THitsMap<G4double>* hitsmap = 0;
  
  size_t Ncol = fCollName.size();
  for ( size_t i = 0; i < Ncol; ++i)
  {
    if ( fCollName[i] == fullName )
    {
      return fRunMap[i];
            //if(hitsmap) { *hitsmap += *fRunMap[i]; }
            //if(!hitsmap) { hitsmap = fRunMap[i]; }
    }
  }
  
  G4Exception("DicomRun", fullName.c_str(), JustWarning,
              "GetHitsMap failed to locate the requested HitsMap");
  return nullptr;
}

ConstructMFD()

void DicomRun::ConstructMFD

(

const std::vector< G4String > &

mfdName

)

Definition at line 100 of file DicomRun.cc.

{
 
  G4SDManager* SDman = G4SDManager::GetSDMpointer();
  //=================================================
  //  Initalize RunMaps for accumulation.
  //  Get CollectionIDs for HitCollections.
  //=================================================
  size_t Nmfd = mfdName.size();
  for ( size_t idet = 0; idet < Nmfd ; ++idet)  // Loop for all MFD.
  {
    G4String detName = mfdName[idet];
    //--- Seek and Obtain MFD objects from SDmanager.
    G4MultiFunctionalDetector* mfd =
      (G4MultiFunctionalDetector*)(SDman->FindSensitiveDetector(detName));
    //
    if ( mfd )
    {
      //--- Loop over the registered primitive scorers.
      for (G4int icol = 0; icol < mfd->GetNumberOfPrimitives(); ++icol)
      {
        // Get Primitive Scorer object.
        G4VPrimitiveScorer* scorer = mfd->GetPrimitive(icol);
        // collection name and collectionID for HitsCollection,
        // where type of HitsCollection is G4THitsMap in case 
        // of primitive scorer.
        // The collection name is given by <MFD name>/<Primitive 
        // Scorer name>.
        G4String collectionName = scorer->GetName();
        G4String fullCollectionName = detName+"/"+collectionName;
        G4int    collectionID = SDman->GetCollectionID(fullCollectionName);
        //
        if ( collectionID >= 0 )
        {
          G4cout << "++ "<<fullCollectionName<< " id " << collectionID 
                 << G4endl;
          // Store obtained HitsCollection information into data members.
          // And, creates new G4THitsMap for accumulating quantities during RUN.
          fCollName.push_back(fullCollectionName);
          fCollID.push_back(collectionID);
          fRunMap.push_back(new G4THitsMap<G4double>(detName,collectionName));
        }
        else
        {
          G4cout << "** collection " << fullCollectionName << " not found. "
                 <<G4endl;
        }
      }
    }
  }
}

Merge()

void DicomRun::Merge ( const G4Run *  aRun )

virtual

Reimplemented in Dicom2Run.

Definition at line 202 of file DicomRun.cc.

{
  const DicomRun* localRun = static_cast<const DicomRun*>(aRun);
  Copy(fCollName, localRun->fCollName);
  Copy(fCollID, localRun->fCollID);
  size_t ncopies = Copy(fRunMap, localRun->fRunMap);
  // copy function returns the fRunMap size if all data is copied
  // so this loop isn't executed the first time around
  for(size_t i = ncopies; i < fRunMap.size(); ++i)
  {
    *fRunMap[i] += *localRun->fRunMap[i];
  }
  G4Run::Merge(aRun);
}

Member Data Documentation

fCollName

std::vector<G4String> DicomRun::fCollName

private

Definition at line 82 of file DicomRun.hh.

fCollID

std::vector<G4int> DicomRun::fCollID

private

Definition at line 83 of file DicomRun.hh.

fRunMap

std::vector<G4THitsMap<G4double>*> DicomRun::fRunMap

private

Definition at line 84 of file DicomRun.hh.

---

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

• .doxygen/Doxymodules_medical.h
• extended/medical/DICOM/include/DicomRun.hh
• extended/medical/DICOM/src/DicomRun.cc