A utility class to facilitate creating the GENIE MC Ntuple from the output GENIE GHEP event records. More...

#include <NtpWriter.h>

Collaboration diagram for genie::NtpWriter:

Public Member Functions
	NtpWriter (NtpMCFormat_t fmt=kNFGHEP, Long_t runnu=0, Long_t runseed=-1)

	~NtpWriter ()
	initialize the ntuple writer More...

void	Initialize (void)
	add event More...

void	AddEventRecord (int ievent, const EventRecord *ev_rec)
	save the event tree More...

void	Save (void)
	get the even tree More...

TTree *	EventTree (void)

void	CustomizeFilename (string filename)

void	CustomizeFilenamePrefix (string prefix)

Private Member Functions
void	SetDefaultFilename (string filename_prefix="gntp")

void	OpenFile (string filename)

void	CreateTree (void)

void	CreateTreeHeader (void)

void	CreateEventBranch (void)

void	CreateGHEPEventBranch (void)

Private Attributes
NtpMCFormat_t	fNtpFormat
	enumeration of event formats More...

Long_t	fRunNu
	run nu More...

Long_t	fRunSeed
	run seed More...

string	fOutFilename
	output filename More...

TFile *	fOutFile
	output file More...

TTree *	fOutTree
	output tree More...

TBranch *	fEventBranch
	the generated event branch More...

NtpMCEventRecord *	fNtpMCEventRecord

NtpMCTreeHeader *	fNtpMCTreeHeader

Detailed Description

A utility class to facilitate creating the GENIE MC Ntuple from the output GENIE GHEP event records.

Author: Costas Andreopoulos <c.andreopoulos cern.ch> University of Liverpool

Created:: October 1, 2004

License:: Copyright (c) 2003-2024, The GENIE Collaboration For the full text of the license visit http://copyright.genie-mc.org

Definition at line 39 of file NtpWriter.h.

Constructor & Destructor Documentation

NtpWriter::NtpWriter	(	NtpMCFormat_t	fmt = `kNFGHEP`,
		Long_t	runnu = `0`,
		Long_t	runseed = `-1`
	)

Definition at line 35 of file NtpWriter.cxx.

References genie::NtpMCFormat::AsString(), fNtpFormat, LOG, pNOTICE, and SetDefaultFilename().

                                                                  :
 fNtpFormat(fmt),
 fRunNu(runnu),
 fRunSeed(seed),
 fOutFile(0),
 fOutTree(0),
 fEventBranch(0),
 fNtpMCEventRecord(0),
 fNtpMCTreeHeader(0)
 {
   LOG("Ntp", pNOTICE) << "Run number: " << runnu;
   LOG("Ntp", pNOTICE)
     << "Requested G/ROOT tree format: " << NtpMCFormat::AsString(fNtpFormat);
 
   this->SetDefaultFilename();
 }

NtpWriter::~NtpWriter ( )

initialize the ntuple writer

Definition at line 52 of file NtpWriter.cxx.

 {
 
 }

Member Function Documentation

void NtpWriter::AddEventRecord	(	int	ievent,
		const EventRecord *	ev_rec
	)

save the event tree

Definition at line 57 of file NtpWriter.cxx.

References genie::NtpMCEventRecord::Fill(), fNtpFormat, fNtpMCEventRecord, fOutTree, genie::kNFGHEP, LOG, pERROR, and pINFO.

Referenced by ConvertToGHepMock(), GenerateEventsAtFixedInitState(), main(), and RunCherryPicker().

 {
   LOG("Ntp", pINFO) << "Adding event " << ievent << " to output tree";
 
   if(!ev_rec) {
     LOG("Ntp", pERROR) << "NULL input EventRecord!";
     return;
   }
   if(!fOutTree) {
     LOG("Ntp", pERROR) << "No open output TTree to add the input EventRecord!";
     return;
   }
 
   switch (fNtpFormat) {
      case kNFGHEP:
           fNtpMCEventRecord = new NtpMCEventRecord();
           fNtpMCEventRecord->Fill(ievent, ev_rec);
           fOutTree->Fill();
           delete fNtpMCEventRecord;
           fNtpMCEventRecord = 0;
           break;
      default:
         break;
   }
 }

void NtpWriter::CreateEventBranch ( void )

private

Definition at line 175 of file NtpWriter.cxx.

References CreateGHEPEventBranch(), fEventBranch, fNtpFormat, genie::kNFGHEP, LOG, and pERROR.

Referenced by Initialize().

 {
   switch (fNtpFormat) {
      case kNFGHEP:
         this->CreateGHEPEventBranch();
         break;
      default:
         LOG("Ntp", pERROR)
            << "Unknown TTree format. Can not create TBranches";
         break;
   }
   assert(fEventBranch);
   fEventBranch->SetAutoDelete(kFALSE);
 }

void NtpWriter::CreateGHEPEventBranch ( void )

private

Definition at line 190 of file NtpWriter.cxx.

References fEventBranch, fNtpMCEventRecord, fOutTree, LOG, and pINFO.

Referenced by CreateEventBranch().

 {
   LOG("Ntp", pINFO) << "Creating a NtpMCEventRecord TBranch";
 
   fNtpMCEventRecord = 0;
   TTree::SetBranchStyle(1);
 
 #if ROOT_VERSION_CODE >= ROOT_VERSION(6,0,0)
   int split = 0;
 #else
   int split = 1;
 #endif
 
   fEventBranch = fOutTree->Branch("gmcrec",
       "genie::NtpMCEventRecord", &fNtpMCEventRecord, 32000, split);
   // was split=1 ... but, at least w/ ROOT 6.06/04, this generates
   //   Warning in <TTree::Bronch>: genie::NtpMCEventRecord cannot be split, resetting splitlevel to 0
   // which the art framework turns into a fatal error
 }

void NtpWriter::CreateTree ( void )

private

Definition at line 161 of file NtpWriter.cxx.

References genie::NtpMCFormat::AsString(), fNtpFormat, fOutTree, LOG, and pINFO.

Referenced by Initialize().

 {
   if(fOutTree) delete fOutTree;
 
   LOG("Ntp", pINFO) << "Creating the output GENIE/ROOT tree";
 
   ostringstream title;
   title << "GENIE MC Truth TTree"
               << ", Format: " << NtpMCFormat::AsString(fNtpFormat);
 
   fOutTree = new TTree("gtree",title.str().c_str());
   fOutTree->SetAutoSave(200000000);  // autosave when 0.2 Gbyte written
 }

void NtpWriter::CreateTreeHeader ( void )

private

Definition at line 210 of file NtpWriter.cxx.

References fNtpFormat, fNtpMCTreeHeader, genie::NtpMCTreeHeader::format, fRunNu, fRunSeed, LOG, pINFO, genie::NtpMCTreeHeader::runnu, and genie::NtpMCTreeHeader::runseed.

Referenced by Initialize().

 {
   LOG("Ntp", pINFO) << "Creating the NtpMCTreeHeader";
 
   if(fNtpMCTreeHeader) delete fNtpMCTreeHeader;
 
   fNtpMCTreeHeader = new NtpMCTreeHeader;
 
   fNtpMCTreeHeader->format  = fNtpFormat;
   fNtpMCTreeHeader->runnu   = fRunNu;
   fNtpMCTreeHeader->runseed = fRunSeed;
 
   LOG("Ntp", pINFO) << *fNtpMCTreeHeader;
 }

void NtpWriter::CustomizeFilename ( string filename )

Definition at line 128 of file NtpWriter.cxx.

References fOutFilename.

Referenced by ConvertToGHepMock(), GenerateEventsAtFixedInitState(), and RunCherryPicker().

 {
  fOutFilename = filename;
 }

void NtpWriter::CustomizeFilenamePrefix ( string prefix )

Definition at line 133 of file NtpWriter.cxx.

References SetDefaultFilename().

Referenced by main().

 {
   this->SetDefaultFilename(prefix);
 }

TTree* genie::NtpWriter::EventTree ( void )

inline

use before Initialize() only if you wish to override the default filename, or the default filename prefix

Definition at line 55 of file NtpWriter.h.

References fOutTree.

Referenced by main(), and RunCherryPicker().

void NtpWriter::Initialize ( void )

add event

Definition at line 83 of file NtpWriter.cxx.

References CreateEventBranch(), CreateTree(), CreateTreeHeader(), genie::NtpMCTreeHeader::customDirs, genie::TuneId::CustomSource(), fNtpMCTreeHeader, fOutFilename, genie::RunOpt::Instance(), genie::TuneId::IsCustom(), genie::NtpMCJobConfig::Load(), LOG, genie::TuneId::Name(), OpenFile(), pERROR, pINFO, genie::NtpMCJobEnv::TakeSnapshot(), genie::RunOpt::Tune(), genie::NtpMCTreeHeader::tune, genie::NtpMCTreeHeader::tuneDir, and genie::TuneId::TuneDirectory().

Referenced by ConvertToGHepMock(), GenerateEventsAtFixedInitState(), main(), and RunCherryPicker().

 {
   LOG("Ntp",pINFO) << "Initializing GENIE output MC tree";
 
   this->OpenFile(fOutFilename); // open ROOT file
   this->CreateTree();           // create output tree
 
   //-- create the event branch
   this->CreateEventBranch();
 
   //-- create the tree header
   this->CreateTreeHeader();
   //-- update the tune name (and associated directories) from RunOpt
   //   (keep header from RunOpt entanglement)
   string tunename("unknown");
   string tuneDir("unknown");
   string customDirs("");
   TuneId* tuneId = RunOpt::Instance()->Tune();
   if ( ! tuneId ) {
     LOG("Ntp", pERROR)
       << "No TuneId is available from RunOpt";
   } else {
     tunename = tuneId->Name();
     tuneDir  = tuneId->TuneDirectory();
     if ( tuneId->IsCustom() ) {
       tunename += "*"; // flag it as possibly modified
       customDirs = tuneId->CustomSource();
     }
   }
   fNtpMCTreeHeader->tune.SetString(tunename.c_str());
   fNtpMCTreeHeader->tuneDir.SetString(tuneDir.c_str());
   fNtpMCTreeHeader->customDirs.SetString(customDirs.c_str());
 
   //-- write the tree header
   fNtpMCTreeHeader->Write();
 
   //-- save GENIE configuration for this MC Job
   NtpMCJobConfig configuration;
   configuration.Load()->Write();
 
   //-- take a snapshot of the user's environment
   NtpMCJobEnv environment;
   environment.TakeSnapshot()->Write();
 }

void NtpWriter::OpenFile ( string filename )

private

Definition at line 149 of file NtpWriter.cxx.

References fOutFile, LOG, and pINFO.

Referenced by Initialize().

 {
   if(fOutFile) delete fOutFile;
 
   LOG("Ntp", pINFO)
       << "Opening the output ROOT file: " << filename;
 
   // use "TFile::Open()" instead of "new TFile()" so that it can handle
   // alternative URLs (e.g. xrootd, etc)
   fOutFile = TFile::Open(filename.c_str(),"RECREATE");
 }

void NtpWriter::Save ( void )

get the even tree

Definition at line 225 of file NtpWriter.cxx.

References fOutFile, LOG, pERROR, and pINFO.

Referenced by ConvertToGHepMock(), GenerateEventsAtFixedInitState(), main(), and RunCherryPicker().

 {
   LOG("Ntp", pINFO) << "Saving the output tree";
 
   if(fOutFile) {
 
     fOutFile->Write();
     fOutFile->Close();
     delete fOutFile;
     fOutFile = 0;
 
   } else {
      LOG("Ntp", pERROR) << "No open ROOT file was found";
   }
 }

void NtpWriter::SetDefaultFilename ( string filename_prefix = "gntp" )

private

Definition at line 138 of file NtpWriter.cxx.

References genie::NtpMCFormat::FilenameTag(), fNtpFormat, fOutFilename, and fRunNu.

Referenced by CustomizeFilenamePrefix(), and NtpWriter().

 {
   ostringstream fnstr;
   fnstr << filename_prefix  << "."
         << fRunNu << "."
         << NtpMCFormat::FilenameTag(fNtpFormat)
         << ".root";
 
   fOutFilename = fnstr.str();
 }