QweakSimAnalysis Class Reference

Handling of the output ROOT file. More...

#include <QweakSimAnalysis.hh>

Collaboration diagram for QweakSimAnalysis:

Public Member Functions
	QweakSimAnalysis (QweakSimUserInformation *)
virtual	~QweakSimAnalysis ()
void	BeginOfRun (const G4Run *aRun)
void	EndOfRun (const G4Run *aRun)
void	EndOfEvent (G4int flag)
void	SetNumberOfEventToBeProcessed (G4int n)
G4int	GetNumberOfEventToBeProcessed () const
void	SetRootFileStem (const G4String &stem)
void	SetRootFileName (const G4String &name)
void	FillRootNtuple ()
void	AutoSaveRootNtuple ()

Data Fields
QweakSimUserMainEvent *	fRootEvent

Private Member Functions
void	ConstructRootNtuple ()

Private Attributes
QweakSimAnalysisMessenger *	pAnalysisMessenger
QweakSimUserInformation *	myUserInfo
QweakSimUserRunInformation *	pUserRunInformation
G4String	fRootFileStem
G4String	fRootFileName
TTree *	fRootNtuple
TBranch *	fRootBranch
TFile *	fRootFile

Detailed Description

Handling of the output ROOT file.

Placeholder for a long explaination

Definition at line 56 of file QweakSimAnalysis.hh.

Constructor & Destructor Documentation

QweakSimAnalysis::QweakSimAnalysis

(

QweakSimUserInformation *

userInfo

)

Definition at line 35 of file QweakSimAnalysis.cc.

References fRootBranch, fRootEvent, fRootFile, fRootNtuple, myUserInfo, pAnalysisMessenger, and pUserRunInformation.

: fRootFileStem("QwSim"),fRootFileName("")
{
  G4cout << "###### Calling QweakSimAnalysis::QweakSimAnalysis()" << G4endl;

  myUserInfo = userInfo;

  // Initialize
  fRootEvent    = NULL;
  fRootNtuple   = NULL;
  fRootBranch   = NULL;
  fRootFile     = NULL;

  // Create messenger
  pAnalysisMessenger = new QweakSimAnalysisMessenger(this);

  // Create user run data
  pUserRunInformation = new QweakSimUserRunInformation();

  G4cout << "###### Leaving QweakSimAnalysis::QweakSimAnalysis()" << G4endl;
}

QweakSimAnalysis::~QweakSimAnalysis ( )

virtual

Definition at line 58 of file QweakSimAnalysis.cc.

References fRootBranch, fRootEvent, fRootFile, fRootNtuple, and pAnalysisMessenger.

{
  G4cout << "###### Calling QweakSimAnalysis::QweakSimAnalysis()" << G4endl;

  // Delete ROOT objects
  if (fRootEvent)    delete fRootEvent;
  if (fRootNtuple)   delete fRootNtuple;
  if (fRootBranch)   delete fRootBranch;
  if (fRootFile)     delete fRootFile;

  // Delete messenger
  if (pAnalysisMessenger) delete pAnalysisMessenger;

  G4cout << "###### Leaving QweakSimAnalysis::QweakSimAnalysis()" << G4endl;
}

Member Function Documentation

void QweakSimAnalysis::AutoSaveRootNtuple

(

)

Definition at line 143 of file QweakSimAnalysis.cc.

References fRootNtuple.

Referenced by QweakSimEventAction::EndOfEventAction(), and EndOfRun().

{
  // save the current ntuple:
  // In case your program crashes before closing the file holding this tree,
  // the file will be automatically recovered when you will connect the file
  // in UPDATE mode.
  // The Tree will be recovered at the status corresponding to the last AutoSave.
  //
  // if option contains "SaveSelf", gDirectory->SaveSelf() is called.
  // This allows another process to analyze the Tree while the Tree is being filled.
  //
  // see http://root.cern.ch/root/html/TTree.html#TTree:AutoSave

  // fRootNtuple -> AutoSave("SaveSelf");
  fRootNtuple -> AutoSave();
  gDirectory -> Purge(); //jpan: Purge old trees
}

Here is the caller graph for this function:

void QweakSimAnalysis::BeginOfRun

(

const G4Run *

aRun

)

Definition at line 85 of file QweakSimAnalysis.cc.

References ConstructRootNtuple(), fRootFile, fRootFileName, and fRootFileStem.

Referenced by QweakSimRunAction::BeginOfRunAction().

{
  // Get run number
  G4int runID = aRun->GetRunID();

  // Construct file name if not set explicitly
  if (fRootFileName.size() == 0)
    fRootFileName = fRootFileStem + "_" + Form("%d",runID) + ".root";

  // Create ROOT file
  G4cout << "###### Analysis: creating ROOT file " << fRootFileName << G4endl;
  fRootFile = new TFile(fRootFileName,"RECREATE","Qweak ROOT file");
  ConstructRootNtuple();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void QweakSimAnalysis::ConstructRootNtuple ( )

private

Definition at line 121 of file QweakSimAnalysis.cc.

References fRootBranch, fRootEvent, fRootNtuple, and pUserRunInformation.

Referenced by BeginOfRun().

{
  // Create ROOT tree
  fRootNtuple = new TTree("QweakSimG4_Tree","Qweak Geant4 Simulation Tree");

  // Save the file after so many bytes. Avoids complete data loss after crash
  //fRootNtuple ->SetAutoSave(1000000);  //AutoSave after every 1 Mbyte written to disk

  // Instance of data structure to be written into ROOT file
  fRootEvent  = new QweakSimUserMainEvent();

  // Create a branch with the data structure defined by fRootEvent
  int bufsize = 64000;
  int split   = 99;
  fRootBranch = fRootNtuple->Branch("QweakSimUserMainEvent", "QweakSimUserMainEvent", &fRootEvent, bufsize, split);

  // Write run data
  pUserRunInformation->Write();
}

Here is the caller graph for this function:

void QweakSimAnalysis::EndOfEvent

(

G4int

flag

)

Definition at line 114 of file QweakSimAnalysis.cc.

{
  // This member is called at the end of every event
  if (!flag) return;
}

void QweakSimAnalysis::EndOfRun

(

const G4Run *

aRun

)

Definition at line 101 of file QweakSimAnalysis.cc.

References AutoSaveRootNtuple(), fRootFile, and fRootFileName.

Referenced by QweakSimRunAction::EndOfRunAction().

{
  // Autosave one last time
  AutoSaveRootNtuple();

  // Write the data to the ROOT file
  G4cout << "###### Analysis: closing ROOT file " << fRootFileName << G4endl;
  fRootFile->Write(0,TObject::kOverwrite);
  fRootFile->Close();
  fRootFileName = "";
}

Here is the call graph for this function:

Here is the caller graph for this function:

void QweakSimAnalysis::FillRootNtuple ( )

inline

Definition at line 76 of file QweakSimAnalysis.hh.

References fRootNtuple.

Referenced by QweakSimEventAction::EndOfEventAction().

{ fRootNtuple->Fill(); }

Here is the caller graph for this function:

G4int QweakSimAnalysis::GetNumberOfEventToBeProcessed

(

)

const

Definition at line 80 of file QweakSimAnalysis.cc.

References QweakSimUserInformation::GetNumberOfEventToBeProcessed(), and myUserInfo.

                                                            {
  return myUserInfo->GetNumberOfEventToBeProcessed();
}

Here is the call graph for this function:

void QweakSimAnalysis::SetNumberOfEventToBeProcessed

(

G4int

n

)

Definition at line 77 of file QweakSimAnalysis.cc.

References myUserInfo, and QweakSimUserInformation::SetNumberOfEventToBeProcessed().

Referenced by QweakSimRunAction::BeginOfRunAction().

                                                            {
  myUserInfo->SetNumberOfEventToBeProcessed(n);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void QweakSimAnalysis::SetRootFileName ( const G4String &  name )

inline

Definition at line 74 of file QweakSimAnalysis.hh.

References fRootFileName.

Referenced by QweakSimAnalysisMessenger::SetNewValue().

{ fRootFileName = name; }

Here is the caller graph for this function:

void QweakSimAnalysis::SetRootFileStem ( const G4String &  stem )

inline

Definition at line 73 of file QweakSimAnalysis.hh.

References fRootFileStem.

Referenced by QweakSimAnalysisMessenger::SetNewValue().

{ fRootFileStem = stem; }

Here is the caller graph for this function:

Field Documentation

TBranch* QweakSimAnalysis::fRootBranch

private

Definition at line 95 of file QweakSimAnalysis.hh.

Referenced by ConstructRootNtuple(), QweakSimAnalysis(), and ~QweakSimAnalysis().

QweakSimUserMainEvent* QweakSimAnalysis::fRootEvent

Definition at line 79 of file QweakSimAnalysis.hh.

Referenced by QweakSimEventAction::CalculateKinematicVariables(), ConstructRootNtuple(), QweakSimEventAction::EndOfEventAction(), QweakSimAnalysis(), and ~QweakSimAnalysis().

TFile* QweakSimAnalysis::fRootFile

private

Definition at line 96 of file QweakSimAnalysis.hh.

Referenced by BeginOfRun(), EndOfRun(), QweakSimAnalysis(), and ~QweakSimAnalysis().

G4String QweakSimAnalysis::fRootFileName

private

Definition at line 90 of file QweakSimAnalysis.hh.

Referenced by BeginOfRun(), EndOfRun(), and SetRootFileName().

G4String QweakSimAnalysis::fRootFileStem

private

Definition at line 89 of file QweakSimAnalysis.hh.

Referenced by BeginOfRun(), and SetRootFileStem().

TTree* QweakSimAnalysis::fRootNtuple

private

Definition at line 94 of file QweakSimAnalysis.hh.

Referenced by AutoSaveRootNtuple(), ConstructRootNtuple(), FillRootNtuple(), QweakSimAnalysis(), and ~QweakSimAnalysis().

QweakSimUserInformation* QweakSimAnalysis::myUserInfo

private

Definition at line 85 of file QweakSimAnalysis.hh.

Referenced by GetNumberOfEventToBeProcessed(), QweakSimAnalysis(), and SetNumberOfEventToBeProcessed().

QweakSimAnalysisMessenger* QweakSimAnalysis::pAnalysisMessenger

private

Definition at line 83 of file QweakSimAnalysis.hh.

Referenced by QweakSimAnalysis(), and ~QweakSimAnalysis().

QweakSimUserRunInformation* QweakSimAnalysis::pUserRunInformation

private

Definition at line 87 of file QweakSimAnalysis.hh.

Referenced by ConstructRootNtuple(), and QweakSimAnalysis().

---

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

• QweakSimAnalysis.hh
• QweakSimAnalysis.cc