G4RootNtupleFileManager Class Reference

#include <G4RootNtupleFileManager.hh>

Inheritance diagram for G4RootNtupleFileManager:

Public Member Functions
virtual G4bool	ActionAtCloseFile (G4bool reset) override
virtual G4bool	ActionAtOpenFile (const G4String &fileName) override
virtual G4bool	ActionAtWrite () override
virtual std::shared_ptr< G4VNtupleManager >	CreateNtupleManager () override
	G4RootNtupleFileManager ()=delete
	G4RootNtupleFileManager (const G4AnalysisManagerState &state)
G4String	GetFileType () const
G4NtupleMergeMode	GetMergeMode () const
std::shared_ptr< G4RootNtupleManager >	GetNtupleManager () const
virtual G4bool	IsNtupleMergingSupported () const override
virtual G4bool	Reset () override
virtual void	SetBasketEntries (unsigned int basketEntries) override
virtual void	SetBasketSize (unsigned int basketSize) override
virtual void	SetBookingManager (std::shared_ptr< G4NtupleBookingManager > bookingManager)
void	SetFileManager (std::shared_ptr< G4RootFileManager > fileManager)
virtual void	SetNtupleMerging (G4bool mergeNtuples, G4int nofReducedNtupleFiles=0) override
virtual void	SetNtupleRowWise (G4bool rowWise, G4bool rowMode=true) override
virtual	~G4RootNtupleFileManager ()

Protected Member Functions
void	Message (G4int level, const G4String &action, const G4String &objectType, const G4String &objectName="", G4bool success=true) const

Protected Attributes
std::shared_ptr< G4NtupleBookingManager >	fBookingManager { nullptr }
G4String	fFileType
const G4AnalysisManagerState &	fState

Private Member Functions
G4bool	CloseNtupleFiles ()
G4int	GetNtupleFileNumber ()
void	SetNtupleMergingMode (G4bool mergeNtuples, G4int nofNtupleFiles)

Private Attributes
std::shared_ptr< G4RootFileManager >	fFileManager { nullptr }
G4bool	fIsInitialized { false }
G4int	fNofNtupleFiles { 0 }
std::shared_ptr< G4RootNtupleManager >	fNtupleManager { nullptr }
G4NtupleMergeMode	fNtupleMergeMode { G4NtupleMergeMode::kNone }
G4bool	fNtupleRowMode { true }
G4bool	fNtupleRowWise { false }
std::shared_ptr< G4RootPNtupleManager >	fSlaveNtupleManager { nullptr }

Static Private Attributes
static G4RootNtupleFileManager *	fgMasterInstance = nullptr
static constexpr std::string_view	fkClass { "G4RootNtupleFileManager" }

Friends
class	G4RootMpiNtupleFileManager

Detailed Description

Definition at line 51 of file G4RootNtupleFileManager.hh.

Constructor & Destructor Documentation

G4RootNtupleFileManager() [1/2]

G4RootNtupleFileManager::G4RootNtupleFileManager ( const G4AnalysisManagerState &  state )

explicit

Definition at line 50 of file G4RootNtupleFileManager.cc.

 : G4VNtupleFileManager(state, "root")
{
  if ( G4Threading::IsMasterThread() ) fgMasterInstance = this;
 
  // Do not merge ntuples by default
  // Merging may require user code migration as analysis manager
  // must be created both on master and workers.
  auto mergeNtuples = false;
  SetNtupleMergingMode(mergeNtuples, fNofNtupleFiles);
}

References fgMasterInstance, fNofNtupleFiles, G4Threading::IsMasterThread(), and SetNtupleMergingMode().

G4RootNtupleFileManager() [2/2]

G4RootNtupleFileManager::G4RootNtupleFileManager ( )

delete

~G4RootNtupleFileManager()

G4RootNtupleFileManager::~G4RootNtupleFileManager ( )

virtual

Definition at line 63 of file G4RootNtupleFileManager.cc.

{
  if ( fState.GetIsMaster() ) fgMasterInstance = nullptr;
}

References fgMasterInstance, G4VNtupleFileManager::fState, and G4AnalysisManagerState::GetIsMaster().

Member Function Documentation

ActionAtCloseFile()

G4bool G4RootNtupleFileManager::ActionAtCloseFile ( G4bool  reset )

overridevirtual

Implements G4VNtupleFileManager.

Definition at line 346 of file G4RootNtupleFileManager.cc.

{
  auto result = true;
 
  // close files
  if ( fNtupleMergeMode != G4NtupleMergeMode::kSlave )  {
    result &= CloseNtupleFiles();
  }
 
  if ( ! reset ) {
    // The ntuples must be always reset when closing file)
    if ( ! Reset() ) {
      Warn("Resetting data failed", fkClass, "ActionAtCloseFile");
      result = false;
    }
  }
 
  return result;
}

References CloseNtupleFiles(), fkClass, fNtupleMergeMode, kSlave, Reset(), and G4Analysis::Warn().

ActionAtOpenFile()

G4bool G4RootNtupleFileManager::ActionAtOpenFile ( const G4String &  fileName )

overridevirtual

Implements G4VNtupleFileManager.

Definition at line 288 of file G4RootNtupleFileManager.cc.

{
  // Check if fNtupleBookingManager is set
 
  if ( fNtupleMergeMode == G4NtupleMergeMode::kNone ||
       fNtupleMergeMode == G4NtupleMergeMode::kMain )  {
 
    G4String objectType = "analysis file";
    if ( fNtupleMergeMode == G4NtupleMergeMode::kMain ) {
      objectType = "main analysis file";
    }
    Message(kVL4, "open", objectType, fileName);
 
    // Creating files is triggered from CreateNtuple
    fNtupleManager->CreateNtuplesFromBooking(
      fBookingManager->GetNtupleBookingVector());
 
    Message(kVL1, "open", objectType, fileName);
  }
 
  // Creating ntuples from main is triggered from the first Fill call
  // if ( fNtupleMergeMode == G4NtupleMergeMode::kSlave )  {
  //   // G4cout << "Going to create slave ntuples from main" << G4endl;
  //   fSlaveNtupleManager->CreateNtuplesFromMain();
  // }
 
  return true;
}

References G4VNtupleFileManager::fBookingManager, fNtupleManager, fNtupleMergeMode, kMain, kNone, G4Analysis::kVL1, G4Analysis::kVL4, and G4VNtupleFileManager::Message().

ActionAtWrite()

G4bool G4RootNtupleFileManager::ActionAtWrite ( )

overridevirtual

Implements G4VNtupleFileManager.

Definition at line 318 of file G4RootNtupleFileManager.cc.

{
  if ( fNtupleMergeMode == G4NtupleMergeMode::kNone ) {
    return true;
  }
 
  auto result = true;
 
  G4String ntupleType;
  if ( fNtupleMergeMode == G4NtupleMergeMode::kMain ) ntupleType = "main ntuples";
  if ( fNtupleMergeMode == G4NtupleMergeMode::kSlave ) ntupleType = "slave ntuples";
 
  Message(kVL4, "merge", ntupleType);
 
  if ( fNtupleMergeMode == G4NtupleMergeMode::kMain )  {
    result &= fNtupleManager->Merge();
  }
 
  if ( fNtupleMergeMode == G4NtupleMergeMode::kSlave ) {
    result &= fSlaveNtupleManager->Merge();
  }
 
  Message(kVL1, "merge", ntupleType, "", result);
 
  return result;
}

References fNtupleManager, fNtupleMergeMode, fSlaveNtupleManager, kMain, kNone, kSlave, G4Analysis::kVL1, G4Analysis::kVL4, and G4VNtupleFileManager::Message().

CloseNtupleFiles()

G4bool G4RootNtupleFileManager::CloseNtupleFiles ( )

private

Definition at line 143 of file G4RootNtupleFileManager.cc.

{
 // Close ntuple files
 
  auto result = true;
  auto ntupleVector = fNtupleManager->GetNtupleDescriptionVector();
  for ( auto ntupleDescription : ntupleVector) {
    result &= fFileManager->CloseNtupleFile(ntupleDescription);
  }
 
  return result;
}

References fFileManager, and fNtupleManager.

Referenced by ActionAtCloseFile().

CreateNtupleManager()

std::shared_ptr< G4VNtupleManager > G4RootNtupleFileManager::CreateNtupleManager ( )

overridevirtual

Implements G4VNtupleFileManager.

Definition at line 223 of file G4RootNtupleFileManager.cc.

{
// Create and return ntuple manager.
// If ntuple merging is activated, managers of different types are created
// on master/worker.
 
  Message(kVL4, "create", "ntuple manager");
 
  // Check that file manager and anaysis manager are set !
 
  std::shared_ptr<G4VNtupleManager> activeNtupleManager = nullptr;
  switch ( fNtupleMergeMode )
  {
    case G4NtupleMergeMode::kNone:
      fNtupleManager
        = make_shared<G4RootNtupleManager>(
            fState, fBookingManager, 0, 0, fNtupleRowWise, fNtupleRowMode);
      fNtupleManager->SetFileManager(fFileManager);
      activeNtupleManager = fNtupleManager;
      break;
 
    case G4NtupleMergeMode::kMain: {
      G4int nofMainManagers = fNofNtupleFiles;
      if ( ! nofMainManagers ) nofMainManagers = 1;
             // create one manager if merging required into the histos & profiles files
      fNtupleManager
        = make_shared<G4RootNtupleManager>(
            fState, fBookingManager, nofMainManagers, fNofNtupleFiles, fNtupleRowWise, fNtupleRowMode);
      fNtupleManager->SetFileManager(fFileManager);
      activeNtupleManager = fNtupleManager;
      break;
    }
 
    case G4NtupleMergeMode::kSlave:
      fNtupleManager = fgMasterInstance->fNtupleManager;
        // The master class is used only in Get* functions
      auto mainNtupleManager
        = fNtupleManager->GetMainNtupleManager(GetNtupleFileNumber());
      fSlaveNtupleManager
        = make_shared<G4RootPNtupleManager>(
            fState, fBookingManager, mainNtupleManager, fNtupleRowWise, fNtupleRowMode);
      activeNtupleManager = fSlaveNtupleManager;
      break;
  }
 
  G4String mergeMode;
  switch ( fNtupleMergeMode ) {
    case G4NtupleMergeMode::kNone:
      mergeMode = "";
      break;
    case G4NtupleMergeMode::kMain:
      mergeMode = "main ";
      break;
    case G4NtupleMergeMode::kSlave:
      mergeMode = "slave ";
      break;
  }
  Message(kVL3, "create", mergeMode + "ntuple manager");
 
  fIsInitialized = true;
 
  return activeNtupleManager;
}

References G4VNtupleFileManager::fBookingManager, fFileManager, fgMasterInstance, fIsInitialized, fNofNtupleFiles, fNtupleManager, fNtupleMergeMode, fNtupleRowMode, fNtupleRowWise, fSlaveNtupleManager, G4VNtupleFileManager::fState, GetNtupleFileNumber(), kMain, kNone, kSlave, G4Analysis::kVL3, G4Analysis::kVL4, and G4VNtupleFileManager::Message().

GetFileType()

G4String G4VNtupleFileManager::GetFileType ( ) const

inlineinherited

Definition at line 107 of file G4VNtupleFileManager.hh.

                                                        {
  return fFileType;
}

References G4VNtupleFileManager::fFileType.

GetMergeMode()

G4NtupleMergeMode G4RootNtupleFileManager::GetMergeMode ( ) const

inline

Definition at line 107 of file G4RootNtupleFileManager.hh.

{ return fNtupleMergeMode; }

References fNtupleMergeMode.

GetNtupleFileNumber()

G4int G4RootNtupleFileManager::GetNtupleFileNumber ( )

private

Definition at line 131 of file G4RootNtupleFileManager.cc.

{
  if ( ! fNofNtupleFiles ) return 0;
 
  G4int nofMainManagers = fNofNtupleFiles;
  if ( ! nofMainManagers ) nofMainManagers = 1;
 
  auto fileNumber = G4Threading::G4GetThreadId() % nofMainManagers;
  return fileNumber;
}

References fNofNtupleFiles, and G4Threading::G4GetThreadId().

Referenced by CreateNtupleManager().

GetNtupleManager()

std::shared_ptr< G4RootNtupleManager > G4RootNtupleFileManager::GetNtupleManager ( ) const

inline

Definition at line 113 of file G4RootNtupleFileManager.hh.

{ return fNtupleManager; }

References fNtupleManager.

IsNtupleMergingSupported()

G4bool G4RootNtupleFileManager::IsNtupleMergingSupported ( ) const

inlineoverridevirtual

Reimplemented from G4VNtupleFileManager.

Definition at line 110 of file G4RootNtupleFileManager.hh.

{ return true; }

Message()

void G4VNtupleFileManager::Message ( G4int  level, const G4String &  action, const G4String &  objectType, const G4String &  objectName = "", G4bool  success = true  ) const

inlineprotectedinherited

Definition at line 111 of file G4VNtupleFileManager.hh.

{
  fState.Message(level, action, objectType, objectName, success);
}

References geant4_check_module_cycles::action, G4VNtupleFileManager::fState, and G4AnalysisManagerState::Message().

Referenced by ActionAtOpenFile(), ActionAtWrite(), CreateNtupleManager(), SetNtupleMergingMode(), and SetNtupleRowWise().

Reset()

G4bool G4RootNtupleFileManager::Reset ( )

overridevirtual

Implements G4VNtupleFileManager.

Definition at line 367 of file G4RootNtupleFileManager.cc.

{
// Reset ntuples
 
  auto result = true;
 
  if ( fNtupleMergeMode == G4NtupleMergeMode::kNone ||
       fNtupleMergeMode == G4NtupleMergeMode::kMain )  {
    result &= fNtupleManager->Reset();
  }
 
  return result;
}

References fNtupleManager, fNtupleMergeMode, kMain, and kNone.

Referenced by ActionAtCloseFile().

SetBasketEntries()

void G4RootNtupleFileManager::SetBasketEntries ( unsigned int  basketEntries )

overridevirtual

Reimplemented from G4VNtupleFileManager.

Definition at line 217 of file G4RootNtupleFileManager.cc.

{
  fFileManager->SetBasketEntries(basketEntries);
}

References fFileManager.

SetBasketSize()

void G4RootNtupleFileManager::SetBasketSize ( unsigned int  basketSize )

overridevirtual

Reimplemented from G4VNtupleFileManager.

Definition at line 211 of file G4RootNtupleFileManager.cc.

{
  fFileManager->SetBasketSize(basketSize);
}

References fFileManager.

SetBookingManager()

void G4VNtupleFileManager::SetBookingManager ( std::shared_ptr< G4NtupleBookingManager >  bookingManager )

inlinevirtualinherited

Definition at line 99 of file G4VNtupleFileManager.hh.

{ fBookingManager = bookingManager; }

References G4VNtupleFileManager::fBookingManager.

SetFileManager()

void G4RootNtupleFileManager::SetFileManager ( std::shared_ptr< G4RootFileManager >  fileManager )

inline

Definition at line 103 of file G4RootNtupleFileManager.hh.

{ fFileManager = fileManager; }

References fFileManager.

SetNtupleMerging()

void G4RootNtupleFileManager::SetNtupleMerging ( G4bool  mergeNtuples, G4int  nofReducedNtupleFiles = 0  )

overridevirtual

---

Reimplemented from G4VNtupleFileManager.

Definition at line 161 of file G4RootNtupleFileManager.cc.

{
  if ( fIsInitialized ) {
    Warn("Cannot change merging mode.\n"
         "The function must be called before OpenFile().",
         fkClass, "SetNtupleMerging");
    return;
  }
 
  // Set ntuple merging mode
  SetNtupleMergingMode(mergeNtuples, nofNtupleFiles);
}

References fIsInitialized, fkClass, SetNtupleMergingMode(), and G4Analysis::Warn().

SetNtupleMergingMode()

void G4RootNtupleFileManager::SetNtupleMergingMode ( G4bool  mergeNtuples, G4int  nofNtupleFiles  )

private

Definition at line 73 of file G4RootNtupleFileManager.cc.

{
  Message(kVL4, "set", "ntuple merging mode");
 
  auto canMerge = true;
 
  // Illegal situations
  if ( mergeNtuples && ( ! G4Threading::IsMultithreadedApplication() ) ) {
    Warn("Merging ntuples is not applicable in sequential application.\n"
         "Setting was ignored.",
         fkClass, "SetNtupleMergingMode");
    canMerge = false;
  }
 
  // Illegal situations
  if ( mergeNtuples && G4Threading::IsMultithreadedApplication() &&
       ( ! fgMasterInstance ) ) {
    Warn("Merging ntuples requires G4AnalysisManager instance on master.\n"
         "Setting was ignored.",
         fkClass, "SetNtupleMergingMode");
    canMerge = false;
  }
 
  G4String mergingMode;
  if ( ( ! mergeNtuples ) || ( ! canMerge ) ) {
    fNtupleMergeMode = G4NtupleMergeMode::kNone;
    mergingMode = "G4NtupleMergeMode::kNone";
  }
  else {
    // Set the number of reduced ntuple files
    fNofNtupleFiles = nofNtupleFiles;
 
    // Check the number of reduced ntuple files
    if ( fNofNtupleFiles < 0  ) {
      Warn("Number of reduced files must be [0, nofThreads].\n"
           "Cannot set  " + to_string(nofNtupleFiles) +" files.\n" +
           "Setting was ignored.",
           fkClass, "SetNtupleMergingMode");
      fNofNtupleFiles = 0;
    }
 
    // Forced merging mode
    G4bool isMaster = ! G4Threading::IsWorkerThread();
    if ( isMaster ) {
      fNtupleMergeMode = G4NtupleMergeMode::kMain;
      mergingMode = "G4NtupleMergeMode::kMain";
    } else {
      fNtupleMergeMode = G4NtupleMergeMode::kSlave;
      mergingMode = "G4NtupleMergeMode::kSlave";
    }
  }
 
  Message(kVL2, "set", "ntuple merging mode", mergingMode);
}

References fgMasterInstance, fkClass, fNofNtupleFiles, fNtupleMergeMode, G4Threading::IsMultithreadedApplication(), G4Threading::IsWorkerThread(), kMain, kNone, kSlave, G4Analysis::kVL2, G4Analysis::kVL4, G4VNtupleFileManager::Message(), and G4Analysis::Warn().

Referenced by G4RootNtupleFileManager(), and SetNtupleMerging().

SetNtupleRowWise()

void G4RootNtupleFileManager::SetNtupleRowWise ( G4bool  rowWise, G4bool  rowMode = true  )

overridevirtual

Reimplemented from G4VNtupleFileManager.

Definition at line 177 of file G4RootNtupleFileManager.cc.

{
 
  // Print info even when setting makes no effect
  // (as we do not get printed the default setting in the output)
  G4String rowWiseMode;
  if ( rowWise ) {
    rowWiseMode = "row-wise with extra branch";
  }
  else if ( rowMode ) {
    rowWiseMode = "row-wise";
  }
  else {
    rowWiseMode = "column-wise";
  }
 
  Message(kVL1, "set", "ntuple merging row mode", rowWiseMode);
 
  // Do nothing if the mode is not changed
  if ( fNtupleRowWise == rowWise && fNtupleRowMode == rowMode ) return;
 
  fNtupleRowWise = rowWise;
  fNtupleRowMode = rowMode;
 
  if ( fNtupleManager ) {
    fNtupleManager->SetNtupleRowWise(rowWise, rowMode);
  }
 
  if ( fSlaveNtupleManager ) {
    fSlaveNtupleManager->SetNtupleRowWise(rowWise, rowMode);
  }
}

References fNtupleManager, fNtupleRowMode, fNtupleRowWise, fSlaveNtupleManager, G4Analysis::kVL1, and G4VNtupleFileManager::Message().

Friends And Related Function Documentation

G4RootMpiNtupleFileManager

friend class G4RootMpiNtupleFileManager

friend

Definition at line 53 of file G4RootNtupleFileManager.hh.

Field Documentation

fBookingManager

std::shared_ptr<G4NtupleBookingManager> G4VNtupleFileManager::fBookingManager { nullptr }

protectedinherited

Definition at line 90 of file G4VNtupleFileManager.hh.

Referenced by G4CsvNtupleFileManager::ActionAtOpenFile(), G4Hdf5NtupleFileManager::ActionAtOpenFile(), ActionAtOpenFile(), G4XmlNtupleFileManager::ActionAtOpenFile(), CreateNtupleManager(), and G4VNtupleFileManager::SetBookingManager().

fFileManager

std::shared_ptr<G4RootFileManager> G4RootNtupleFileManager::fFileManager { nullptr }

private

Definition at line 100 of file G4RootNtupleFileManager.hh.

Referenced by CloseNtupleFiles(), CreateNtupleManager(), SetBasketEntries(), SetBasketSize(), and SetFileManager().

fFileType

G4String G4VNtupleFileManager::fFileType

protectedinherited

Definition at line 89 of file G4VNtupleFileManager.hh.

Referenced by G4VNtupleFileManager::GetFileType(), G4VNtupleFileManager::SetBasketEntries(), G4VNtupleFileManager::SetBasketSize(), G4VNtupleFileManager::SetNtupleMerging(), and G4VNtupleFileManager::SetNtupleRowWise().

fgMasterInstance

G4RootNtupleFileManager * G4RootNtupleFileManager::fgMasterInstance = nullptr

staticprivate

Definition at line 83 of file G4RootNtupleFileManager.hh.

Referenced by CreateNtupleManager(), G4RootNtupleFileManager(), SetNtupleMergingMode(), and ~G4RootNtupleFileManager().

fIsInitialized

G4bool G4RootNtupleFileManager::fIsInitialized { false }

private

Definition at line 93 of file G4RootNtupleFileManager.hh.

Referenced by CreateNtupleManager(), and SetNtupleMerging().

fkClass

constexpr std::string_view G4RootNtupleFileManager::fkClass { "G4RootNtupleFileManager" }

staticconstexprprivate

Definition at line 90 of file G4RootNtupleFileManager.hh.

Referenced by ActionAtCloseFile(), SetNtupleMerging(), and SetNtupleMergingMode().

fNofNtupleFiles

G4int G4RootNtupleFileManager::fNofNtupleFiles { 0 }

private

Definition at line 94 of file G4RootNtupleFileManager.hh.

Referenced by CreateNtupleManager(), G4RootNtupleFileManager(), GetNtupleFileNumber(), and SetNtupleMergingMode().

fNtupleManager

std::shared_ptr<G4RootNtupleManager> G4RootNtupleFileManager::fNtupleManager { nullptr }

private

Definition at line 98 of file G4RootNtupleFileManager.hh.

Referenced by ActionAtOpenFile(), ActionAtWrite(), CloseNtupleFiles(), CreateNtupleManager(), GetNtupleManager(), Reset(), and SetNtupleRowWise().

fNtupleMergeMode

G4NtupleMergeMode G4RootNtupleFileManager::fNtupleMergeMode { G4NtupleMergeMode::kNone }

private

Definition at line 97 of file G4RootNtupleFileManager.hh.

Referenced by ActionAtCloseFile(), ActionAtOpenFile(), ActionAtWrite(), CreateNtupleManager(), GetMergeMode(), Reset(), and SetNtupleMergingMode().

fNtupleRowMode

G4bool G4RootNtupleFileManager::fNtupleRowMode { true }

private

Definition at line 96 of file G4RootNtupleFileManager.hh.

Referenced by CreateNtupleManager(), and SetNtupleRowWise().

fNtupleRowWise

G4bool G4RootNtupleFileManager::fNtupleRowWise { false }

private

Definition at line 95 of file G4RootNtupleFileManager.hh.

Referenced by CreateNtupleManager(), and SetNtupleRowWise().

fSlaveNtupleManager

std::shared_ptr<G4RootPNtupleManager> G4RootNtupleFileManager::fSlaveNtupleManager { nullptr }

private

Definition at line 99 of file G4RootNtupleFileManager.hh.

Referenced by ActionAtWrite(), CreateNtupleManager(), and SetNtupleRowWise().

fState

const G4AnalysisManagerState& G4VNtupleFileManager::fState

protectedinherited

Definition at line 88 of file G4VNtupleFileManager.hh.

Referenced by G4CsvNtupleFileManager::CreateNtupleManager(), G4Hdf5NtupleFileManager::CreateNtupleManager(), CreateNtupleManager(), G4XmlNtupleFileManager::CreateNtupleManager(), G4VNtupleFileManager::Message(), and ~G4RootNtupleFileManager().

---

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

• source/analysis/root/include/G4RootNtupleFileManager.hh
• source/analysis/root/src/G4RootNtupleFileManager.cc