genie::NtpWriter Class Reference

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
void	Initialize (void)
	add event
void	AddEventRecord (int ievent, const EventRecord *ev_rec)
	save the event tree
void	Save (void)
	get the even tree
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
Long_t	fRunNu
	run nu
Long_t	fRunSeed
	run seed
string	fOutFilename
	output filename
TFile *	fOutFile
	output file
TTree *	fOutTree
	output tree
TBranch *	fEventBranch
	the generated event branch
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 \at cern.ch> University of Liverpool

Created:\n October 1, 2004

License:\n Copyright (c) 2003-2025, 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::NtpWriter	(	NtpMCFormat_t	fmt = kNFGHEP,
		Long_t	runnu = 0,
		Long_t	runseed = -1 )

Definition at line 35 of file NtpWriter.cxx.

                                                                 :
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();
}

References genie::NtpMCFormat::AsString(), fEventBranch, fNtpFormat, fNtpMCEventRecord, fNtpMCTreeHeader, fOutFile, fOutTree, fRunNu, fRunSeed, LOG, pNOTICE, and SetDefaultFilename().

~NtpWriter()

NtpWriter::~NtpWriter

(

)

initialize the ntuple writer

Definition at line 52 of file NtpWriter.cxx.

{
  delete fNtpMCTreeHeader;
}

References fNtpMCTreeHeader.

Member Function Documentation

AddEventRecord()

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

save the event tree

Definition at line 57 of file NtpWriter.cxx.

{
  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;
  }
}

References fNtpFormat, fNtpMCEventRecord, fOutTree, genie::kNFGHEP, LOG, pERROR, and pINFO.

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

CreateEventBranch()

void NtpWriter::CreateEventBranch ( void )

private

Definition at line 175 of file NtpWriter.cxx.

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

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

Referenced by Initialize().

CreateGHEPEventBranch()

void NtpWriter::CreateGHEPEventBranch ( void )

private

Definition at line 190 of file NtpWriter.cxx.

{
  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
}

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

Referenced by CreateEventBranch().

CreateTree()

void NtpWriter::CreateTree ( void )

private

Definition at line 161 of file NtpWriter.cxx.

{
  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
}

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

Referenced by Initialize().

CreateTreeHeader()

void NtpWriter::CreateTreeHeader ( void )

private

Definition at line 210 of file NtpWriter.cxx.

{
  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;
}

References fNtpFormat, fNtpMCTreeHeader, fRunNu, fRunSeed, LOG, and pINFO.

Referenced by Initialize().

CustomizeFilename()

void NtpWriter::CustomizeFilename

(

string

filename

)

Definition at line 128 of file NtpWriter.cxx.

{
 fOutFilename = filename;
}

References fOutFilename.

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

CustomizeFilenamePrefix()

void NtpWriter::CustomizeFilenamePrefix

(

string

prefix

)

Definition at line 133 of file NtpWriter.cxx.

{
  this->SetDefaultFilename(prefix);
}

References SetDefaultFilename().

Referenced by main().

EventTree()

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().

Initialize()

void NtpWriter::Initialize

(

void

)

add event

Definition at line 83 of file NtpWriter.cxx.

{
  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();
}

References CreateEventBranch(), CreateTree(), CreateTreeHeader(), 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(), and genie::TuneId::TuneDirectory().

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

OpenFile()

void NtpWriter::OpenFile ( string filename )

private

Definition at line 149 of file NtpWriter.cxx.

{
  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");
}

References fOutFile, LOG, and pINFO.

Referenced by Initialize().

Save()

void NtpWriter::Save

(

void

)

get the even tree

Definition at line 225 of file NtpWriter.cxx.

{
  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";
  }
}

References fOutFile, LOG, pERROR, and pINFO.

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

SetDefaultFilename()

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

private

Definition at line 138 of file NtpWriter.cxx.

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

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

Referenced by CustomizeFilenamePrefix(), and NtpWriter().

Member Data Documentation

fEventBranch

TBranch* genie::NtpWriter::fEventBranch

private

the generated event branch

Definition at line 77 of file NtpWriter.h.

Referenced by CreateEventBranch(), CreateGHEPEventBranch(), and NtpWriter().

fNtpFormat

NtpMCFormat_t genie::NtpWriter::fNtpFormat

private

enumeration of event formats

Definition at line 71 of file NtpWriter.h.

Referenced by AddEventRecord(), CreateEventBranch(), CreateTree(), CreateTreeHeader(), NtpWriter(), and SetDefaultFilename().

fNtpMCEventRecord

NtpMCEventRecord* genie::NtpWriter::fNtpMCEventRecord

private

Definition at line 78 of file NtpWriter.h.

Referenced by AddEventRecord(), CreateGHEPEventBranch(), and NtpWriter().

fNtpMCTreeHeader

NtpMCTreeHeader* genie::NtpWriter::fNtpMCTreeHeader

private

Definition at line 79 of file NtpWriter.h.

Referenced by CreateTreeHeader(), Initialize(), NtpWriter(), and ~NtpWriter().

fOutFile

TFile* genie::NtpWriter::fOutFile

private

output file

Definition at line 75 of file NtpWriter.h.

Referenced by NtpWriter(), OpenFile(), and Save().

fOutFilename

string genie::NtpWriter::fOutFilename

private

output filename

Definition at line 74 of file NtpWriter.h.

Referenced by CustomizeFilename(), Initialize(), and SetDefaultFilename().

fOutTree

TTree* genie::NtpWriter::fOutTree

private

output tree

Definition at line 76 of file NtpWriter.h.

Referenced by AddEventRecord(), CreateGHEPEventBranch(), CreateTree(), EventTree(), and NtpWriter().

fRunNu

Long_t genie::NtpWriter::fRunNu

private

run nu

Definition at line 72 of file NtpWriter.h.

Referenced by CreateTreeHeader(), NtpWriter(), and SetDefaultFilename().

fRunSeed

Long_t genie::NtpWriter::fRunSeed

private

run seed

Definition at line 73 of file NtpWriter.h.

Referenced by CreateTreeHeader(), and NtpWriter().

---

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

• NtpWriter.h
• NtpWriter.cxx