G4RootNtupleManager Class Reference

#include <G4RootNtupleManager.hh>

Inheritance diagram for G4RootNtupleManager:

Protected Member Functions
	G4RootNtupleManager (const G4AnalysisManagerState &state)
virtual	~G4RootNtupleManager ()
void	CreateNtuplesFromBooking ()
G4bool	IsEmpty () const
G4bool	Reset ()
void	SetNtupleDirectory (tools::wroot::directory *directory)
tools::wroot::ntuple *	GetNtuple () const
tools::wroot::ntuple *	GetNtuple (G4int ntupleId) const
virtual G4int	CreateNtuple (const G4String &name, const G4String &title)
virtual G4int	CreateNtupleIColumn (const G4String &name)
virtual G4int	CreateNtupleFColumn (const G4String &name)
virtual G4int	CreateNtupleDColumn (const G4String &name)
virtual void	FinishNtuple ()
virtual G4int	CreateNtupleIColumn (G4int ntupleId, const G4String &name)
virtual G4int	CreateNtupleFColumn (G4int ntupleId, const G4String &name)
virtual G4int	CreateNtupleDColumn (G4int ntupleId, const G4String &name)
virtual void	FinishNtuple (G4int ntupleId)
virtual G4bool	FillNtupleIColumn (G4int columnId, G4int value)
virtual G4bool	FillNtupleFColumn (G4int columnId, G4float value)
virtual G4bool	FillNtupleDColumn (G4int columnId, G4double value)
virtual G4bool	AddNtupleRow ()
virtual G4bool	FillNtupleIColumn (G4int ntupleId, G4int columnId, G4int value)
virtual G4bool	FillNtupleFColumn (G4int ntupleId, G4int columnId, G4float value)
virtual G4bool	FillNtupleDColumn (G4int ntupleId, G4int columnId, G4double value)
virtual G4bool	AddNtupleRow (G4int ntupleId)
virtual G4int	GetNofNtuples () const
Protected Member Functions inherited from G4VNtupleManager
	G4VNtupleManager (const G4AnalysisManagerState &state)
virtual	~G4VNtupleManager ()
G4bool	SetFirstNtupleColumnId (G4int firstId)
Protected Member Functions inherited from G4BaseAnalysisManager
void	ExceptionForHistograms (const G4String &functionName) const

Friends
class	G4RootAnalysisManager

Additional Inherited Members
Public Member Functions inherited from G4BaseAnalysisManager
	G4BaseAnalysisManager (const G4AnalysisManagerState &state)
virtual	~G4BaseAnalysisManager ()
G4bool	SetFirstId (G4int firstId)
Protected Attributes inherited from G4VNtupleManager
G4int	fFirstNtupleColumnId
G4bool	fLockFirstNtupleColumnId
Protected Attributes inherited from G4BaseAnalysisManager
const G4AnalysisManagerState &	fState
G4int	fFirstId
G4bool	fLockFirstId

Detailed Description

Definition at line 51 of file G4RootNtupleManager.hh.

Constructor & Destructor Documentation

G4RootNtupleManager::G4RootNtupleManager ( const G4AnalysisManagerState &  state )

protected

Definition at line 37 of file G4RootNtupleManager.cc.

 : G4VNtupleManager(state),
   fNtupleDirectory(0),
   fNtupleVector()
{
}

G4RootNtupleManager::~G4RootNtupleManager ( )

protectedvirtual

Definition at line 45 of file G4RootNtupleManager.cc.

{  
  std::vector<G4RootNtupleDescription*>::iterator it;  
  for (it = fNtupleVector.begin(); it != fNtupleVector.end(); it++ ) {
    delete (*it);
  }   
}

Member Function Documentation

G4bool G4RootNtupleManager::AddNtupleRow ( )

protectedvirtual

Implements G4VNtupleManager.

Definition at line 493 of file G4RootNtupleManager.cc.

{ 
  return AddNtupleRow(fFirstId);
}  

G4bool G4RootNtupleManager::AddNtupleRow ( G4int  ntupleId )

protectedvirtual

Implements G4VNtupleManager.

Definition at line 578 of file G4RootNtupleManager.cc.

References G4RootNtupleDescription::fNtuple, G4BaseAnalysisManager::fState, G4Exception(), G4AnalysisManagerState::GetVerboseL4(), JustWarning, and G4AnalysisVerbose::Message().

{ 
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) {
    G4ExceptionDescription description;
    description << " ntupleId " << ntupleId;  
    fState.GetVerboseL4()->Message("add", "ntuple row", description);
  }  
#endif

  G4RootNtupleDescription* ntupleDescription
    = GetNtupleInFunction(ntupleId, "AddNtupleRow");

  if ( ! ntupleDescription || ! ntupleDescription->fNtuple ) {
    G4ExceptionDescription description;
    description << "      " << " ntupleId " << ntupleId 
                << " does not exist. ";
    G4Exception("G4RootNtupleManager::AddNtupleRow()",
                "Analysis_W008", JustWarning, description);
    return false;
  }  
  
  G4bool result = ntupleDescription->fNtuple->add_row();
  if ( ! result ) {
    G4ExceptionDescription description;
    description << "      " << " ntupleId " << ntupleId 
                << "adding row has failed.";
    G4Exception("G4RootNtupleManager::AddNtupleRow()",
                "Analysis_W004", JustWarning, description);
  }         
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) {
    G4ExceptionDescription description;
    description << " ntupleId " << ntupleId;  
    fState.GetVerboseL4()->Message("add", "ntuple row", description, result);
  }  
#endif

  return result;
}

G4int G4RootNtupleManager::CreateNtuple ( const G4String &  name, const G4String &  title  )

protectedvirtual

Implements G4VNtupleManager.

Definition at line 252 of file G4RootNtupleManager.cc.

References G4BaseAnalysisManager::fFirstId, G4BaseAnalysisManager::fLockFirstId, G4RootNtupleDescription::fNtuple, G4RootNtupleDescription::fNtupleBooking, G4BaseAnalysisManager::fState, G4AnalysisManagerState::GetVerboseL2(), G4AnalysisManagerState::GetVerboseL4(), G4AnalysisVerbose::Message(), and title().

{
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) 
    fState.GetVerboseL4()->Message("create", "ntuple", name);
#endif

  // Create ntuple description
  G4int index = fNtupleVector.size();
  G4RootNtupleDescription* ntupleDescription
    = new G4RootNtupleDescription();
  fNtupleVector.push_back(ntupleDescription);  

  // Create ntuple booking
  ntupleDescription->fNtupleBooking = new tools::ntuple_booking();
  ntupleDescription->fNtupleBooking->m_name = name;
  ntupleDescription->fNtupleBooking->m_title = title;
           // ntuple booking object is deleted in destructor

  // Create ntuple if the file is open
  if ( fNtupleDirectory ) {
    ntupleDescription->fNtuple 
      = new tools::wroot::ntuple(*fNtupleDirectory, name, title);
           // ntuple object is deleted automatically when closing a file
  }

  fLockFirstId = true;

#ifdef G4VERBOSE
  if ( fState.GetVerboseL2() ) {
    G4ExceptionDescription description;
    description << name << " ntupleId " << index + fFirstId;
    fState.GetVerboseL2()->Message("create", "ntuple", description);
  } 
#endif

  return index + fFirstId;
}                                         

G4int G4RootNtupleManager::CreateNtupleDColumn ( const G4String &  name )

protectedvirtual

Implements G4VNtupleManager.

Definition at line 307 of file G4RootNtupleManager.cc.

{
  G4int ntupleId = fNtupleVector.size() + fFirstId - 1;
  return CreateNtupleDColumn(ntupleId, name);
}  

G4int G4RootNtupleManager::CreateNtupleDColumn ( G4int  ntupleId, const G4String &  name  )

protectedvirtual

Implements G4VNtupleManager.

Definition at line 420 of file G4RootNtupleManager.cc.

References G4VNtupleManager::fFirstNtupleColumnId, G4VNtupleManager::fLockFirstNtupleColumnId, G4RootNtupleDescription::fNtuple, G4RootNtupleDescription::fNtupleBooking, G4RootNtupleDescription::fNtupleDColumnMap, G4BaseAnalysisManager::fState, G4Exception(), G4AnalysisManagerState::GetVerboseL2(), G4AnalysisManagerState::GetVerboseL4(), JustWarning, and G4AnalysisVerbose::Message().

{
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) {
    G4ExceptionDescription description;
    description << name << " ntupleId " << ntupleId; 
    fState.GetVerboseL4()->Message("create", "ntuple D column", description);
  }  
#endif

  G4RootNtupleDescription* ntupleDescription
    = GetNtupleInFunction(ntupleId, "CreateNtupleDColumn");
  tools::ntuple_booking* ntupleBooking
    = ntupleDescription->fNtupleBooking;  

  if ( ! ntupleBooking ) {
    G4ExceptionDescription description;
    description << "      " 
                << "Ntuple " << ntupleId << " has to be created first. ";
    G4Exception("G4RootNtupleManager::CreateNtupleDColumn()",
                "Analysis_W005", JustWarning, description);
    return -1;       
  }

  // Save column info in booking
  G4int index = ntupleBooking->m_columns.size();
  ntupleBooking->add_column<double>(name);  
 
  // Create column if ntuple already exists
  if ( ntupleDescription->fNtuple ) {
    tools::wroot::ntuple::column<double>* column 
      = ntupleDescription->fNtuple->create_column<double>(name);  
    ntupleDescription->fNtupleDColumnMap[index] = column;
  }  
  
  fLockFirstNtupleColumnId = true;

#ifdef G4VERBOSE
  if ( fState.GetVerboseL2() ) {
    G4ExceptionDescription description;
    description << name << " ntupleId " << ntupleId; 
    fState.GetVerboseL2()->Message("create", "ntuple D column", description);
  }  
#endif

  return index + fFirstNtupleColumnId;       
}                                         

G4int G4RootNtupleManager::CreateNtupleFColumn ( const G4String &  name )

protectedvirtual

Implements G4VNtupleManager.

Definition at line 300 of file G4RootNtupleManager.cc.

{
  G4int ntupleId = fNtupleVector.size() + fFirstId - 1;
  return CreateNtupleFColumn(ntupleId, name);
}  

G4int G4RootNtupleManager::CreateNtupleFColumn ( G4int  ntupleId, const G4String &  name  )

protectedvirtual

Implements G4VNtupleManager.

Definition at line 370 of file G4RootNtupleManager.cc.

References G4VNtupleManager::fFirstNtupleColumnId, G4VNtupleManager::fLockFirstNtupleColumnId, G4RootNtupleDescription::fNtuple, G4RootNtupleDescription::fNtupleBooking, G4RootNtupleDescription::fNtupleFColumnMap, G4BaseAnalysisManager::fState, G4Exception(), G4AnalysisManagerState::GetVerboseL2(), G4AnalysisManagerState::GetVerboseL4(), JustWarning, and G4AnalysisVerbose::Message().

{
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) {
    G4ExceptionDescription description;
    description << name << " ntupleId " << ntupleId; 
    fState.GetVerboseL4()->Message("create", "ntuple F column", description);
  } 
#endif

  G4RootNtupleDescription* ntupleDescription
    = GetNtupleInFunction(ntupleId, "CreateNtupleFColumn");
  tools::ntuple_booking* ntupleBooking
    = ntupleDescription->fNtupleBooking;  

  if ( ! ntupleBooking ) {
    G4ExceptionDescription description;
    description << "      " 
                << "Ntuple " << ntupleId << " has to be created first. ";
    G4Exception("G4RootNtupleManager::CreateNtupleFColumn()",
                "Analysis_W005", JustWarning, description);
    return -1;       
  }

  // Save column info in booking
  G4int index = ntupleBooking->m_columns.size();
  ntupleBooking->add_column<float>(name);  
 
  // Create column if ntuple already exists
  if ( ntupleDescription->fNtuple ) {
    tools::wroot::ntuple::column<float>* column 
      = ntupleDescription->fNtuple->create_column<float>(name);  
    ntupleDescription->fNtupleFColumnMap[index] = column;
  }  

  fLockFirstNtupleColumnId = true;

#ifdef G4VERBOSE
  if ( fState.GetVerboseL2() ) {
    G4ExceptionDescription description;
    description << name << " ntupleId " << ntupleId; 
    fState.GetVerboseL2()->Message("create", "ntuple F column", description);
  }  
#endif

  return index + fFirstNtupleColumnId;       
}                                         

G4int G4RootNtupleManager::CreateNtupleIColumn ( const G4String &  name )

protectedvirtual

Implements G4VNtupleManager.

Definition at line 293 of file G4RootNtupleManager.cc.

{
  G4int ntupleId = fNtupleVector.size() + fFirstId - 1;
  return CreateNtupleIColumn(ntupleId, name);
}  

G4int G4RootNtupleManager::CreateNtupleIColumn ( G4int  ntupleId, const G4String &  name  )

protectedvirtual

Implements G4VNtupleManager.

Definition at line 320 of file G4RootNtupleManager.cc.

References G4VNtupleManager::fFirstNtupleColumnId, G4VNtupleManager::fLockFirstNtupleColumnId, G4RootNtupleDescription::fNtuple, G4RootNtupleDescription::fNtupleBooking, G4RootNtupleDescription::fNtupleIColumnMap, G4BaseAnalysisManager::fState, G4Exception(), G4AnalysisManagerState::GetVerboseL2(), G4AnalysisManagerState::GetVerboseL4(), JustWarning, and G4AnalysisVerbose::Message().

{
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) {
    G4ExceptionDescription description;
    description << name << " ntupleId " << ntupleId; 
    fState.GetVerboseL4()->Message("create", "ntuple I column", description);
  }  
#endif
  
  G4RootNtupleDescription* ntupleDescription
    = GetNtupleInFunction(ntupleId, "CreateNtupleIColumn");
  tools::ntuple_booking* ntupleBooking
    = ntupleDescription->fNtupleBooking;  

  if ( ! ntupleBooking ) {
    G4ExceptionDescription description;
    description << "      " 
                << "Ntuple " << ntupleId << " has to be created first. ";
    G4Exception("G4RootNtupleManager::CreateNtupleIColumn()",
                "Analysis_W005", JustWarning, description);
    return -1;       
  }

  // Save column info in booking
  G4int index = ntupleBooking->m_columns.size();
  ntupleBooking->add_column<int>(name);  
 
  // Create column if ntuple already exists
  if ( ntupleDescription->fNtuple ) {
    tools::wroot::ntuple::column<int>* column 
      = ntupleDescription->fNtuple->create_column<int>(name);  
    ntupleDescription->fNtupleIColumnMap[index] = column;
  }  

  fLockFirstNtupleColumnId = true;

#ifdef G4VERBOSE
  if ( fState.GetVerboseL2() ) {
    G4ExceptionDescription description;
    description << name << " ntupleId " << ntupleId; 
    fState.GetVerboseL2()->Message("create", "ntuple I column", description);
  }  
#endif

  return index + fFirstNtupleColumnId;       
}                                         

void G4RootNtupleManager::CreateNtuplesFromBooking ( )

protected

Definition at line 158 of file G4RootNtupleManager.cc.

References G4BaseAnalysisManager::fState, G4Exception(), G4AnalysisManagerState::GetVerboseL3(), G4AnalysisManagerState::GetVerboseL4(), JustWarning, and G4AnalysisVerbose::Message().

Referenced by G4RootAnalysisManager::OpenFileImpl().

{
// Create ntuple from ntuple_booking.

  if ( ! fNtupleVector.size() ) return;     
  
  std::vector<G4RootNtupleDescription*>::iterator itn;  
  for (itn = fNtupleVector.begin(); itn != fNtupleVector.end(); itn++ ) {

    tools::ntuple_booking* ntupleBooking = (*itn)->fNtupleBooking;
    if ( ! ntupleBooking ) continue;

#ifdef G4VERBOSE
    if ( fState.GetVerboseL4() ) 
      fState.GetVerboseL4()
        ->Message("create from booking", "ntuple", ntupleBooking->m_name);
#endif

    (*itn)->fNtuple
      = new tools::wroot::ntuple(*fNtupleDirectory, *ntupleBooking);
  
    if ( ntupleBooking->m_columns.size() ) {
      // store ntuple columns in local maps
      const std::vector<tools::ntuple_booking::col_t>& columns 
        = ntupleBooking->m_columns;
      std::vector<tools::ntuple_booking::col_t>::const_iterator it;
      G4int index = 0;
      for ( it = columns.begin(); it!=columns.end(); ++it) {
        if ( (*it).second == tools::_cid(int(0) ) ) {
          (*itn)->fNtupleIColumnMap[index++] 
            = (*itn)->fNtuple->find_column<int>((*it).first);
        }
        else if ( (*it).second == tools::_cid(float(0) ) ) {
          (*itn)->fNtupleFColumnMap[index++] 
            = (*itn)->fNtuple->find_column<float>((*it).first);
        } 
        else if ( (*it).second== tools::_cid(double(0))) {
          (*itn)->fNtupleDColumnMap[index++] 
            = (*itn)->fNtuple->find_column<double>((*it).first);
        }
        else {
          G4ExceptionDescription description;
          description << "      " 
                      << "Unsupported column type " << (*it).first;
          G4Exception("G4RootNtupleManager::CreateNtupleFromBooking()",
                      "Analysis_W004", JustWarning, description);
        }
      }
    }
#ifdef G4VERBOSE
    if ( fState.GetVerboseL3() ) 
      fState.GetVerboseL3()
        ->Message("create from booking", "ntuple", ntupleBooking->m_name);
#endif
  }
}   

G4bool G4RootNtupleManager::FillNtupleDColumn ( G4int  columnId, G4double  value  )

protectedvirtual

Implements G4VNtupleManager.

Definition at line 487 of file G4RootNtupleManager.cc.

{
  return FillNtupleDColumn(fFirstId, columnId, value);
}                                         

G4bool G4RootNtupleManager::FillNtupleDColumn ( G4int  ntupleId, G4int  columnId, G4double  value  )

protectedvirtual

Implements G4VNtupleManager.

Definition at line 551 of file G4RootNtupleManager.cc.

References G4BaseAnalysisManager::fState, G4Exception(), G4AnalysisManagerState::GetVerboseL4(), JustWarning, and G4AnalysisVerbose::Message().

{
  tools::wroot::ntuple::column<double>* column 
    = GetNtupleDColumn(ntupleId, columnId);
  if ( ! column ) {
    G4ExceptionDescription description;
    description << "      " << "ntupleId " <<  ntupleId
                << "column " << columnId << " does not exist.";
    G4Exception("G4RootNtupleManager::FillNtupleDColumn()",
                "Analysis_W009", JustWarning, description);
    return false;
  }  
  
  column->fill(value);
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) {
    G4ExceptionDescription description;
    description << " ntupleId " << ntupleId  
                << " columnId " << columnId << " value " << value;
    fState.GetVerboseL4()->Message("fill", "ntuple D column", description);
  }  
#endif
  return true;       
}                                         

G4bool G4RootNtupleManager::FillNtupleFColumn ( G4int  columnId, G4float  value  )

protectedvirtual

Implements G4VNtupleManager.

Definition at line 481 of file G4RootNtupleManager.cc.

{
  return FillNtupleFColumn(fFirstId, columnId, value);
}                                         

G4bool G4RootNtupleManager::FillNtupleFColumn ( G4int  ntupleId, G4int  columnId, G4float  value  )

protectedvirtual

Implements G4VNtupleManager.

Definition at line 525 of file G4RootNtupleManager.cc.

References G4BaseAnalysisManager::fState, G4Exception(), G4AnalysisManagerState::GetVerboseL4(), JustWarning, and G4AnalysisVerbose::Message().

{
  tools::wroot::ntuple::column<float>* column 
    = GetNtupleFColumn(ntupleId, columnId);
  if ( ! column ) {
    G4ExceptionDescription description;
    description << "      " << "ntupleId " <<  ntupleId
                << "column " << columnId << " does not exist.";
    G4Exception("G4RootNtupleManager::FillNtupleFColumn()",
                "Analysis_W009", JustWarning, description);
    return false;
  }  
  
  column->fill(value);
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) {
    G4ExceptionDescription description;
    description << " ntupleId " << ntupleId  
                << " columnId " << columnId << " value " << value;
    fState.GetVerboseL4()->Message("fill", "ntuple F column", description);
  }  
#endif
  return true;       
}                                         

G4bool G4RootNtupleManager::FillNtupleIColumn ( G4int  columnId, G4int  value  )

protectedvirtual

Implements G4VNtupleManager.

Definition at line 475 of file G4RootNtupleManager.cc.

{
  return FillNtupleIColumn(fFirstId, columnId, value);
}                                         

G4bool G4RootNtupleManager::FillNtupleIColumn ( G4int  ntupleId, G4int  columnId, G4int  value  )

protectedvirtual

Implements G4VNtupleManager.

Definition at line 499 of file G4RootNtupleManager.cc.

References G4BaseAnalysisManager::fState, G4Exception(), G4AnalysisManagerState::GetVerboseL4(), JustWarning, and G4AnalysisVerbose::Message().

{
  tools::wroot::ntuple::column<int>* column 
    = GetNtupleIColumn(ntupleId, columnId);
  if ( ! column ) {
    G4ExceptionDescription description;
    description << "      " << "ntupleId " <<  ntupleId
                << "column " << columnId << " does not exist.";
    G4Exception("G4RootNtupleManager::FillNtupleIColumn()",
                "Analysis_W009", JustWarning, description);
    return false;
  }  
  
  column->fill(value);
#ifdef G4VERBOSE
  if ( fState.GetVerboseL4() ) {
    G4ExceptionDescription description;
    description << " ntupleId " << ntupleId  
                << " columnId " << columnId << " value " << value;
    fState.GetVerboseL4()->Message("fill", "ntuple I column", description);
  }  
#endif
  return true;       
}                                         

void G4RootNtupleManager::FinishNtuple ( )

protectedvirtual

Implements G4VNtupleManager.

Definition at line 314 of file G4RootNtupleManager.cc.

{ 
  // nothing to be done here
}

void G4RootNtupleManager::FinishNtuple ( G4int  ntupleId )

protectedvirtual

Implements G4VNtupleManager.

Definition at line 469 of file G4RootNtupleManager.cc.

{ 
  // nothing to be done here
}

G4int G4RootNtupleManager::GetNofNtuples ( ) const

inlineprotectedvirtual

Implements G4VNtupleManager.

Definition at line 133 of file G4RootNtupleManager.hh.

{ return fNtupleVector.size(); }

tools::wroot::ntuple * G4RootNtupleManager::GetNtuple ( ) const

protected

Definition at line 237 of file G4RootNtupleManager.cc.

{
  return GetNtuple(fFirstId);
}  

tools::wroot::ntuple * G4RootNtupleManager::GetNtuple ( G4int  ntupleId ) const

protected

Definition at line 243 of file G4RootNtupleManager.cc.

References G4RootNtupleDescription::fNtuple.

{
  G4RootNtupleDescription* ntupleDescription
    = GetNtupleInFunction(ntupleId, "GetNtuple");
    
  return ntupleDescription->fNtuple;  
}  

G4bool G4RootNtupleManager::IsEmpty ( ) const

protected

Definition at line 216 of file G4RootNtupleManager.cc.

Referenced by G4RootAnalysisManager::CloseFileImpl().

{
  return ! fNtupleVector.size();
}  

G4bool G4RootNtupleManager::Reset ( )

protected

Definition at line 222 of file G4RootNtupleManager.cc.

{
// Reset ntuples

  std::vector<G4RootNtupleDescription*>::iterator it;  
  for (it = fNtupleVector.begin(); it != fNtupleVector.end(); it++ ) {
    // ntuple is deleted automatically when file is closed
    // delete (*it)->fNtuple;
    (*it)->fNtuple=0; 
  }  
  
  return true;
}  

void G4RootNtupleManager::SetNtupleDirectory ( tools::wroot::directory *  directory )

inlineprotected

Definition at line 128 of file G4RootNtupleManager.hh.

Referenced by G4RootAnalysisManager::OpenFileImpl().

                                                                    {
  fNtupleDirectory = directory;
}    

Friends And Related Function Documentation

friend class G4RootAnalysisManager

friend

Definition at line 53 of file G4RootNtupleManager.hh.

---

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

• G4RootNtupleManager.hh
• G4RootNtupleManager.cc