A GENIE flux driver using a simple ntuple format. More...

#include <GSimpleNtpFlux.h>

Inheritance diagram for genie::flux::GSimpleNtpFlux:

Collaboration diagram for genie::flux::GSimpleNtpFlux:

Public Member Functions
	GSimpleNtpFlux ()
	~GSimpleNtpFlux ()
const PDGCodeList &	FluxParticles (void)
	declare list of flux neutrinos that can be generated (for init. purposes)
double	MaxEnergy (void)
	declare the max flux neutrino energy that can be generated (for init. purposes)
bool	GenerateNext (void)
	generate the next flux neutrino (return false in err)
int	PdgCode (void)
	returns the flux neutrino pdg code
double	Weight (void)
	returns the flux neutrino weight (if any)
const TLorentzVector &	Momentum (void)
	returns the flux neutrino 4-momentum
const TLorentzVector &	Position (void)
	returns the flux neutrino 4-position (note: expect SI rather than physical units)
bool	End (void)
	true if no more flux nu's can be thrown (eg reaching end of beam sim ntuples)
long int	Index (void)
	returns corresponding index for current flux neutrino (e.g. for a flux ntuple returns the current entry number)
void	Clear (Option_t *opt)
	reset state variables based on opt
void	GenerateWeighted (bool gen_weighted)
	set whether to generate weighted or unweighted neutrinos
const genie::flux::GSimpleNtpEntry *	GetCurrentEntry (void)
	GSimpleNtpEntry.
const genie::flux::GSimpleNtpNuMI *	GetCurrentNuMI (void)
	GSimpleNtpNuMI.
const genie::flux::GSimpleNtpAux *	GetCurrentAux (void)
	GSimpleNtpAux.
const genie::flux::GSimpleNtpMeta *	GetCurrentMeta (void)
	GSimpleNtpMeta.
TChain *	GetFluxTChain (void)
double	GetDecayDist () const
	dist (user units) from dk to current pos
void	MoveToZ0 (double z0)
	move ray origin to user coord Z0
void	SetIncludeVtxt (bool it=true)
bool	GetIncludeVtxt ()
	should X4 include CurEntry.vtxt
virtual double	GetTotalExposure () const
	GFluxExposureI interface.
virtual long int	NFluxNeutrinos () const
double	UsedPOTs (void) const
long int	NEntriesUsed (void) const
	number of entries read from files
double	SumWeight (void) const
	integrated weight for flux neutrinos looped so far
void	PrintCurrent (void)
	print current entry from leaves
void	PrintConfig ()
	print the current configuration
std::vector< std::string >	GetFileList ()
	list of files currently part of chain
virtual void	LoadBeamSimData (const std::vector< string > &filenames, const std::string &det_loc)
virtual void	GetBranchInfo (std::vector< std::string > &branchNames, std::vector< std::string > &branchClassNames, std::vector< void ** > &branchObjPointers)
virtual TTree *	GetMetaDataTree ()
void	SetRequestedBranchList (string blist="entry,numi,aux")
void	SetMaxEnergy (double Ev)
	specify maximum flx neutrino energy
void	SetGenWeighted (bool genwgt=false)
	toggle whether GenerateNext() returns weight=1 flux (initial default false)
void	SetEntryReuse (long int nuse=1)
void	ProcessMeta (void)
	scan for max flux energy, weight
void	GetFluxWindow (TVector3 &p1, TVector3 &p2, TVector3 &p3) const
	3 points define a plane in beam coordinate
virtual void	LoadBeamSimData (const std::vector< std::string > &filenames, const std::string &det_loc)=0
virtual void	LoadBeamSimData (const std::set< std::string > &filenames, const std::string &det_loc)
virtual void	LoadBeamSimData (const std::string &filename, const std::string &det_loc)
Public Member Functions inherited from genie::GFluxI
virtual	~GFluxI ()
Public Member Functions inherited from genie::flux::GFluxExposureI
	GFluxExposureI (genie::flux::Exposure_t etype)
virtual	~GFluxExposureI ()
const char *	GetExposureUnits () const
	what units are returned by GetTotalExposure?
genie::flux::Exposure_t	GetExposureType () const
Public Member Functions inherited from genie::flux::GFluxFileConfigI
	GFluxFileConfigI ()
virtual	~GFluxFileConfigI ()
virtual void	SetXMLFileBase (std::string xmlbasename="")
virtual std::string	GetXMLFileBase () const
virtual void	SetFluxParticles (const PDGCodeList &particles)
	specify list of flux neutrino species
virtual void	SetUpstreamZ (double z0)
virtual void	SetNumOfCycles (long int ncycle)
	limit cycling through input files

Private Member Functions
bool	GenerateNext_weighted (void)
void	Initialize (void)
void	SetDefaults (void)
void	CleanUp (void)
void	ResetCurrent (void)
void	AddFile (TTree fluxtree, TTree metatree, string fname)
bool	OptionalAttachBranch (std::string bname)
void	CalcEffPOTsPerNu (void)
void	ScanMeta (void)

Private Attributes
double	fMaxEv
	maximum energy
bool	fEnd
	end condition reached
std::vector< string >	fNuFluxFilePatterns
	(potentially wildcarded) path(s)
string	fNuFluxBranchRequest
	list of requested branches "entry,numi,au"
TChain *	fNuFluxTree
	TTree // REF ONLY.
TChain *	fNuMetaTree
	TTree // REF ONLY.
int	fNFiles
	number of files in chain
Long64_t	fNEntries
	number of flux ntuple entries
Long64_t	fIEntry
	current flux ntuple entry
Int_t	fIFileNumber
	which file for the current entry
Double_t	fFilePOTs
double	fWeight
	current neutrino weight
double	fMaxWeight
	max flux neutrino weight in input file
long int	fNUse
	how often to use same entry in a row
long int	fIUse
	current # of times an entry has been used
double	fSumWeight
	sum of weights for nus thrown so far
long int	fNNeutrinos
	number of flux neutrinos thrown so far
long int	fNEntriesUsed
	number of entries read from files
double	fEffPOTsPerNu
	what a entry is worth ...
double	fAccumPOTs
	POTs used so far.
bool	fGenWeighted
	does GenerateNext() give weights?
bool	fAlreadyUnwgt
	are input files already unweighted
bool	fAllFilesMeta
	do all files in chain have meta data
GSimpleNtpEntry *	fCurEntry
	current entry
GSimpleNtpNuMI *	fCurNuMI
	current "numi" branch extra info
GSimpleNtpAux *	fCurAux
	current "aux" branch extra info
TLorentzVector	fP4
	reconstituted p4 vector
TLorentzVector	fX4
	reconstituted position vector
GSimpleNtpMeta *	fCurMeta
	current meta data
GSimpleNtpEntry *	fCurEntryCopy
	current entry
GSimpleNtpNuMI *	fCurNuMICopy
	current "numi" branch extra info
GSimpleNtpAux *	fCurAuxCopy
	current "aux" branch extra info
bool	fIncludeVtxt
	does fX4 include CurEntry.vtxt or 0

Additional Inherited Members
Static Public Member Functions inherited from genie::flux::GFluxExposureI
static const char *	AsString (genie::flux::Exposure_t etype)
static genie::flux::Exposure_t	StringToEnum (const char *chars, int maxChar=0)
Protected Member Functions inherited from genie::GFluxI
	GFluxI ()
Protected Attributes inherited from genie::flux::GFluxFileConfigI
PDGCodeList *	fPdgCList
	list of neutrino pdg-codes to generate
PDGCodeList *	fPdgCListRej
	list of nu pdg-codes seen but rejected
std::string	fXMLbasename
	XML file that might hold config param_sets.
long int	fNCycles
long int	fICycle
double	fZ0

Detailed Description

A GENIE flux driver using a simple ntuple format.

GSimpleNtpFlux:

An implementation of the GFluxI interface that provides NuMI flux

Author: Robert Hatcher <rhatcher \at fnal.gov> Fermi National Accelerator Laboratory

Created:\n Jan 25, 2010

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 199 of file GSimpleNtpFlux.h.

Constructor & Destructor Documentation

◆ GSimpleNtpFlux()

genie::flux::GSimpleNtpFlux::GSimpleNtpFlux ( )

◆ ~GSimpleNtpFlux()

GSimpleNtpFlux::~GSimpleNtpFlux ( )

Definition at line 73 of file GSimpleNtpFlux.cxx.

{
  this->CleanUp();
}

References CleanUp().

Member Function Documentation

◆ AddFile()

void GSimpleNtpFlux::AddFile	(	TTree *	fluxtree,
		TTree *	metatree,
		string	fname )

private

Definition at line 802 of file GSimpleNtpFlux.cxx.

{
  // Add a file to the chain
  if ( ! fluxtree ) return;
 
  ULong64_t nentries = fluxtree->GetEntries();
 
  int stat = fNuFluxTree->AddFile(fname.c_str());
  if ( metatree ) fNuMetaTree->AddFile(fname.c_str());
  else            fAllFilesMeta = false;
 
  LOG("Flux",pINFO)
    << "flux->AddFile() of " << nentries
    << " " << ((metatree)?"[+meta]":"[no-meta]")
    << " [status=" << stat << "]"
    << " entries in file: " << fname;
 
  if ( stat != 1 ) return;
 
  fNFiles++;
 
}

References fAllFilesMeta, fNFiles, fNuFluxTree, fNuMetaTree, LOG, and pINFO.

Referenced by LoadBeamSimData().

◆ CalcEffPOTsPerNu()

void GSimpleNtpFlux::CalcEffPOTsPerNu ( void )

private

Definition at line 362 of file GSimpleNtpFlux.cxx.

{
  // do this if flux window changes or # of files changes
 
  if (!fNuFluxTree) return;  // not yet fully configured
 
  fEffPOTsPerNu = ( (double)fFilePOTs / (double)fNEntries ) / fMaxWeight ;
}

References fEffPOTsPerNu, fFilePOTs, fMaxWeight, fNEntries, and fNuFluxTree.

Referenced by LoadBeamSimData().

◆ CleanUp()

void GSimpleNtpFlux::CleanUp ( void )

private

Definition at line 782 of file GSimpleNtpFlux.cxx.

{
  LOG("Flux", pINFO) << "Cleaning up...";
 
  if (fPdgCList)    delete fPdgCList;
  if (fPdgCListRej) delete fPdgCListRej;
  if (fCurEntry)    delete fCurEntry;
  if (fCurNuMI)     delete fCurNuMI;
  if (fCurAux)      delete fCurAux;
  if (fCurMeta)     delete fCurMeta;
 
  if (fNuFluxTree)  delete fNuFluxTree;
  if (fNuMetaTree)  delete fNuMetaTree;
 
  LOG("Flux", pNOTICE)
    << " flux file cycles: " << fICycle << " of " << fNCycles
    << ", entry " << fIEntry << " use: " << fIUse << " of " << fNUse;
}

References fCurAux, fCurEntry, fCurMeta, fCurNuMI, genie::flux::GFluxFileConfigI::fICycle, fIEntry, fIUse, genie::flux::GFluxFileConfigI::fNCycles, fNuFluxTree, fNuMetaTree, fNUse, genie::flux::GFluxFileConfigI::fPdgCList, genie::flux::GFluxFileConfigI::fPdgCListRej, LOG, pINFO, and pNOTICE.

Referenced by ~GSimpleNtpFlux().

◆ Clear()

void GSimpleNtpFlux::Clear ( Option_t * opt )

virtual

reset state variables based on opt

Implements genie::GFluxI.

Definition at line 685 of file GSimpleNtpFlux.cxx.

{
// Clear the driver state
//
  LOG("Flux", pWARN) << "GSimpleNtpFlux::Clear(" << opt << ") called";
  // do it in all cases, but EVGDriver/GMCJDriver will pass "CycleHistory"
 
  fICycle     = 0;
 
  fSumWeight  = 0;
  fNNeutrinos = 0;
  fAccumPOTs  = 0;
 
}

References fAccumPOTs, genie::flux::GFluxFileConfigI::fICycle, fNNeutrinos, fSumWeight, LOG, and pWARN.

◆ End()

bool genie::flux::GSimpleNtpFlux::End ( void )

inlinevirtual

true if no more flux nu's can be thrown (eg reaching end of beam sim ntuples)

Implements genie::GFluxI.

Definition at line 219 of file GSimpleNtpFlux.h.

219{ return fEnd; }

genie::flux::GSimpleNtpFlux::fEnd

bool fEnd

end condition reached

Definition GSimpleNtpFlux.h:312

References fEnd.

Referenced by GenerateNext().

◆ FluxParticles()

const PDGCodeList & genie::flux::GSimpleNtpFlux::FluxParticles ( void )

inlinevirtual

declare list of flux neutrinos that can be generated (for init. purposes)

Implements genie::GFluxI.

Definition at line 212 of file GSimpleNtpFlux.h.

212{ return *fPdgCList; }

References genie::flux::GFluxFileConfigI::fPdgCList.

◆ GenerateNext()

bool GSimpleNtpFlux::GenerateNext ( void )

virtual

generate the next flux neutrino (return false in err)

Implements genie::GFluxI.

Definition at line 90 of file GSimpleNtpFlux.cxx.

{
// Get next (unweighted) flux ntuple entry on the specified detector location
//
  RandomGen* rnd = RandomGen::Instance();
  while ( true ) {
     // Check for end of flux ntuple
     bool end = this->End();
     if ( end ) {
       LOG("Flux", pNOTICE) << "GenerateNext signaled End() ";
       return false;
     }
 
     // Get next weighted flux ntuple entry
     bool nextok = this->GenerateNext_weighted();
     if ( fGenWeighted ) return nextok;
     if ( ! nextok ) continue;
     if ( fAlreadyUnwgt ) return true;
 
     /* RWH - debug purposes
     if ( fNCycles == 0 ) {
       LOG("Flux", pNOTICE)
          << "Got flux entry: " << fIEntry
          << " - Cycle: "<< fICycle << "/ infinite";
     } else {
       LOG("Flux", pNOTICE)
          << "Got flux entry: "<< fIEntry
          << " - Cycle: "<< fICycle << "/"<< fNCycles;
     }
     */
 
     // Get fractional weight & decide whether to accept curr flux neutrino
     double f = this->Weight() / fMaxWeight;
     //LOG("Flux", pNOTICE)
     //   << "Curr flux neutrino fractional weight = " << f;
     if (f > 1.) {
       fMaxWeight = this->Weight() * 1.01; // bump the weight
       LOG("Flux", pERROR)
         << "** Fractional weight = " << f
         << " > 1 !! Bump fMaxWeight estimate to " << fMaxWeight
         << GetCurrentEntry();
       std::cout << std::flush;
     }
     double r = (f < 1.) ? rnd->RndFlux().Rndm() : 0;
     bool accept = ( r < f );
     if ( accept ) {
 
#ifdef __GENIE_LOW_LEVEL_MESG_ENABLED__
       LOG("Flux", pNOTICE)
         << "Generated beam neutrino: "
         << "\n pdg-code: " << fCurEntry->pdg
         << "\n p4: " << utils::print::P4AsShortString(&(fP4))
         << "\n x4: " << utils::print::X4AsString(&(fX4));
#endif
 
       fWeight = 1.;
       return true;
     }
 
     //LOG("Flux", pNOTICE)
     //  << "** Rejecting current flux neutrino based on the flux weight only";
  }
  return false;
}

References End(), fAlreadyUnwgt, fCurEntry, fGenWeighted, fMaxWeight, fP4, fWeight, fX4, GenerateNext_weighted(), GetCurrentEntry(), genie::RandomGen::Instance(), LOG, genie::utils::print::P4AsShortString(), pERROR, pNOTICE, genie::RandomGen::RndFlux(), Weight(), and genie::utils::print::X4AsString().

◆ GenerateNext_weighted()

bool GSimpleNtpFlux::GenerateNext_weighted ( void )

private

user might modify list via SetFluxParticles() in order to reject certain flavors, even if they're found in the file. So don't make a big fuss. Spit out a single message and then stop reporting that flavor as problematic.

Definition at line 155 of file GSimpleNtpFlux.cxx.

{
// Get next (weighted) flux ntuple entry
//
 
  // Check whether a flux ntuple has been loaded
  if ( ! fNuFluxTree ) {
     LOG("Flux", pFATAL)
          << "The flux driver has not been properly configured";
     // return false; // don't do this - creates an infinite loop!
     exit(1);
  }
 
  // Reuse an entry?
  //std::cout << " ***** iuse " << fIUse << " nuse " << fNUse
  //          << " ientry " << fIEntry << " nentry " << fNEntries
  //          << " icycle " << fICycle << " ncycle " << fNCycles << std::endl;
  if ( fIUse < fNUse && fIEntry >= 0 ) {
    // Reuse this entry
    fIUse++;
  } else {
    // Reset previously generated neutrino code / 4-p / 4-x
    this->ResetCurrent();
    // Move on, read next flux ntuple entry
    ++fIEntry;
    ++fNEntriesUsed;  // count total # used
    if ( fIEntry >= fNEntries ) {
      // Ran out of entries @ the current cycle of this flux file
      // Check whether more (or infinite) number of cycles is requested
      if (fICycle < fNCycles || fNCycles == 0 ) {
        fICycle++;
        fIEntry=0;
      } else {
        LOG("Flux", pWARN)
          << "No more entries in input flux neutrino ntuple, cycle "
          << fICycle << " of " << fNCycles;
        fEnd = true;
        //assert(0);
        return false;
      }
    }
 
    int nbytes = fNuFluxTree->GetEntry(fIEntry);
    UInt_t metakey = fCurEntry->metakey;
    if ( fAllFilesMeta && ( fCurMeta->metakey != metakey ) ) {
      UInt_t oldkey = fCurMeta->metakey;
#ifdef USE_INDEX_FOR_META
      int nbmeta = fNuMetaTree->GetEntryWithIndex(metakey);
#else
      // unordered indices makes ROOT call Error() which might,
      // if not DefaultErrorHandler, be fatal.
      // so find the right one by a simple linear search.
      // not a large burden since it only happens infrequently and
      // the list is normally quite short.
      int nmeta = fNuMetaTree->GetEntries();
      int nbmeta = 0;
      for (int imeta = 0; imeta < nmeta; ++imeta ) {
        nbmeta = fNuMetaTree->GetEntry(imeta);
        if ( fCurMeta->metakey == metakey ) break;
      }
      // next condition should never happen
      if ( fCurMeta->metakey != metakey ) {
        fCurMeta = 0; // didn't find it!?
        LOG("Flux",pERROR) << "Failed to find right metakey=" << metakey
                           << " (was " << oldkey << ") out of " << nmeta
                           << " entries";
      }
#endif
      LOG("Flux",pDEBUG) << "Get meta " << metakey
                         << " (was " << oldkey << ") "
                         << fCurMeta->metakey
                         << " nb " << nbytes << " " << nbmeta;
#ifdef __GENIE_LOW_LEVEL_MESG_ENABLED__
      LOG("Flux",pDEBUG) << "Get meta " << *fCurMeta;
#endif
    }
#ifdef __GENIE_LOW_LEVEL_MESG_ENABLED__
    Int_t ifile = fNuFluxTree->GetFileNumber();
    LOG("Flux",pDEBUG)
      << "got " << fNNeutrinos << " nu, using fIEntry " << fIEntry
      << " ifile " << ifile << " nbytes " << nbytes
      << *fCurEntry << *fCurMeta;
#endif
 
    fIUse = 1;
 
    // here we might want to do flavor oscillations or simple mappings
    //RWH modify:  fPdgC = fCurEntry->pdg;
 
    // Check neutrino pdg against declared list of neutrino species declared
    // by the current instance of the NuMI neutrino flux driver.
    // No undeclared neutrino species will be accepted at this point as GENIE
    // has already been configured to handle the specified list.
    // Make sure that the appropriate list of flux neutrino species was set at
    // initialization via GSimpleNtpFlux::SetFluxParticles(const PDGCodeList &)
 
    // update the # POTs, sum of weights & number of neutrinos
    // do this HERE (before rejecting flavors that users might be weeding out)
    // in order to keep the POT accounting correct.  This allows one to get
    // the right normalization for generating only events from the intrinsic
    // nu_e entries.
    fAccumPOTs += fEffPOTsPerNu;
    fSumWeight += this->Weight();
    fNNeutrinos++;
 
    if ( ! fPdgCList->ExistsInPDGCodeList(fCurEntry->pdg) ) {
      /// user might modify list via SetFluxParticles() in order to reject certain
      /// flavors, even if they're found in the file.  So don't make a big fuss.
      /// Spit out a single message and then stop reporting that flavor as problematic.
      int badpdg = fCurEntry->pdg;
      if ( ! fPdgCListRej->ExistsInPDGCodeList(badpdg) ) {
        fPdgCListRej->push_back(badpdg);
        LOG("Flux", pWARN)
          << "Encountered neutrino specie (" << badpdg
          << ") that wasn't in SetFluxParticles() list, "
          << "\nDeclared list of neutrino species: " << *fPdgCList;
      }
      return false;
    }
 
  }
 
  // Update the curr neutrino p4/x4 lorentz vector
  double Ev =  fCurEntry->E;
  fP4.SetPxPyPzE(fCurEntry->px,fCurEntry->py,fCurEntry->pz,Ev);
  double t0 = ((fIncludeVtxt) ? fCurEntry->vtxt : 0 );
  fX4.SetXYZT(fCurEntry->vtxx,fCurEntry->vtxy,fCurEntry->vtxz,t0);
 
  fWeight = fCurEntry->wgt;
 
  if (Ev > fMaxEv) {
     LOG("Flux", pWARN)
          << "Flux neutrino energy exceeds declared maximum neutrino energy"
          << "\nEv = " << Ev << "(> Ev{max} = " << fMaxEv << ")";
  }
 
  // if desired, move to user specified user coord z
  if ( TMath::Abs(fZ0) < 1.0e30 ) this->MoveToZ0(fZ0);
 
#ifdef __GENIE_LOW_LEVEL_MESG_ENABLED__
  LOG("Flux", pINFO)
    << "Generated neutrino: " << fIEntry
#ifdef NOT_YET
    << " run " << fCurNuMI->evtno
    << " evtno " << fCurNuMI->evtno
    << " entryno " << fCurNuMI->entryno
#endif
    << "\n pdg-code: " << fCurEntry->pdg << " wgt " << fCurEntry->wgt
    << "\n p4: " << utils::print::P4AsShortString(&fP4)
    << "\n x4: " << utils::print::X4AsString(&fX4);
#endif
  if ( Ev > fMaxEv ) {
    LOG("Flux", pFATAL)
      << "Generated neutrino had E_nu = " << Ev << " > " << fMaxEv
      << " maximum ";
    assert(0);
  }
 
  return true;
}

References fAccumPOTs, fAllFilesMeta, fCurEntry, fCurMeta, fCurNuMI, fEffPOTsPerNu, fEnd, genie::flux::GFluxFileConfigI::fICycle, fIEntry, fIncludeVtxt, fIUse, fMaxEv, genie::flux::GFluxFileConfigI::fNCycles, fNEntries, fNEntriesUsed, fNNeutrinos, fNuFluxTree, fNuMetaTree, fP4, genie::flux::GFluxFileConfigI::fPdgCList, genie::flux::GFluxFileConfigI::fPdgCListRej, fSumWeight, fWeight, fX4, genie::flux::GFluxFileConfigI::fZ0, LOG, MoveToZ0(), genie::utils::print::P4AsShortString(), pDEBUG, pERROR, pFATAL, pINFO, pWARN, ResetCurrent(), Weight(), and genie::utils::print::X4AsString().

Referenced by GenerateNext().

◆ GenerateWeighted()

void GSimpleNtpFlux::GenerateWeighted ( bool gen_weighted )

virtual

set whether to generate weighted or unweighted neutrinos

Implements genie::GFluxI.

Definition at line 700 of file GSimpleNtpFlux.cxx.

{
// Set whether to generate weighted rays
//
  fGenWeighted = gen_weighted;
}

References fGenWeighted.

◆ GetBranchInfo()

void GSimpleNtpFlux::GetBranchInfo	(	std::vector< std::string > &	branchNames,
		std::vector< std::string > &	branchClassNames,
		std::vector< void ** > &	branchObjPointers )

virtual

allow caller to copy current status / ntuple entry info in the output file by providing copies of internal info

Assumes that branch object pointers will not change which may require either a copy be made or, if using the class directly for reading the branch, one must force ROOT to not autodelete: myns::MyClassType* fCurrMyClass = new myns::MyClassType; myTree->SetBranchAddress("bname",&fCurMyClass); //? TBranch* b = myTree->GetBranch("bname"); //? b->SetAutoDelete(false);

ensure vectors are sized sufficiently (or use .push_back()) branchNames[i] = "bname" branchClassNames[i] = "myns::MyClassType" branchObjPointers[i] = (void**)&fCurMyClass;

Reimplemented from genie::flux::GFluxFileConfigI.

Definition at line 564 of file GSimpleNtpFlux.cxx.

{
  // allow flux driver to report back current status and/or ntuple entry
  // info for possible recording in the output file by supplying
  // the class name, and a pointer to the object that will be filled
  // as well as a suggested name for the branch.
 
  if ( fCurEntry ) {
    branchNames.push_back("simple");
    branchClassNames.push_back("genie::flux::GSimpleNtpEntry");
    branchObjPointers.push_back((void**)&fCurEntry);
  }
 
  if ( fCurNuMI ) {
    branchNames.push_back("numi");
    branchClassNames.push_back("genie::flux::GSimpleNtpNuMI");
    branchObjPointers.push_back((void**)&fCurNuMI);
  }
 
  if ( fCurAux ) {
    branchNames.push_back("aux");
    branchClassNames.push_back("genie::flux::GSimpleNtpAux");
    branchObjPointers.push_back((void**)&fCurAux);
  }
}

References fCurAux, fCurEntry, and fCurNuMI.

◆ GetCurrentAux()

const genie::flux::GSimpleNtpAux * genie::flux::GSimpleNtpFlux::GetCurrentAux ( void )

inline

GSimpleNtpAux.

Definition at line 238 of file GSimpleNtpFlux.h.

References fCurAux.

◆ GetCurrentEntry()

const genie::flux::GSimpleNtpEntry * genie::flux::GSimpleNtpFlux::GetCurrentEntry ( void )

inline

GSimpleNtpEntry.

Definition at line 234 of file GSimpleNtpFlux.h.

References fCurEntry.

Referenced by GenerateNext().

◆ GetCurrentMeta()

const genie::flux::GSimpleNtpMeta * genie::flux::GSimpleNtpFlux::GetCurrentMeta ( void )

inline

GSimpleNtpMeta.

Definition at line 240 of file GSimpleNtpFlux.h.

References fCurMeta.

◆ GetCurrentNuMI()

const genie::flux::GSimpleNtpNuMI * genie::flux::GSimpleNtpFlux::GetCurrentNuMI ( void )

inline

GSimpleNtpNuMI.

Definition at line 236 of file GSimpleNtpFlux.h.

References fCurNuMI.

◆ GetDecayDist()

double GSimpleNtpFlux::GetDecayDist ( ) const

dist (user units) from dk to current pos

Definition at line 316 of file GSimpleNtpFlux.cxx.

{
  // return distance (user units) between dk point and start position
  // these are in beam units
  return fCurEntry->dist;
}

References fCurEntry.

◆ GetFileList()

std::vector< std::string > GSimpleNtpFlux::GetFileList ( )

list of files currently part of chain

Definition at line 1120 of file GSimpleNtpFlux.cxx.

{
  std::vector<std::string> flist;
  TObjArray *fileElements=fNuFluxTree->GetListOfFiles();
  TIter next(fileElements);
  TChainElement *chEl=0;
  while (( chEl=(TChainElement*)next() )) {
    flist.push_back(chEl->GetTitle());
  }
  return flist;
}

References fNuFluxTree.

Referenced by PrintConfig().

◆ GetFluxTChain()

TChain * genie::flux::GSimpleNtpFlux::GetFluxTChain ( void )

inline

Definition at line 244 of file GSimpleNtpFlux.h.

References fNuFluxTree.

◆ GetFluxWindow()

void GSimpleNtpFlux::GetFluxWindow	(	TVector3 &	p1,
		TVector3 &	p2,
		TVector3 &	p3 ) const

3 points define a plane in beam coordinate

Definition at line 663 of file GSimpleNtpFlux.cxx.

{
  // return flux window points
 
  p0 = TVector3(fCurMeta->windowBase[0],
                fCurMeta->windowBase[1],
                fCurMeta->windowBase[2]);
  p1 = p0 + TVector3(fCurMeta->windowDir1[0],
                     fCurMeta->windowDir1[1],
                     fCurMeta->windowDir1[2]);
  p2 = p0 + TVector3(fCurMeta->windowDir2[0],
                     fCurMeta->windowDir2[1],
                     fCurMeta->windowDir2[2]);
 
}

References fCurMeta.

◆ GetIncludeVtxt()

bool genie::flux::GSimpleNtpFlux::GetIncludeVtxt ( )

inline

should X4 include CurEntry.vtxt

Definition at line 250 of file GSimpleNtpFlux.h.

250{ return fIncludeVtxt; }

References fIncludeVtxt.

◆ GetMetaDataTree()

TTree * GSimpleNtpFlux::GetMetaDataTree ( )

virtual

Reimplemented from genie::flux::GFluxFileConfigI.

Definition at line 591 of file GSimpleNtpFlux.cxx.

591{ return fNuMetaTree; }

References fNuMetaTree.

◆ GetTotalExposure()

double GSimpleNtpFlux::GetTotalExposure ( ) const

virtual

GFluxExposureI interface.

Implements genie::flux::GFluxExposureI.

Definition at line 78 of file GSimpleNtpFlux.cxx.

{
  // complete the GFluxExposureI interface
  return UsedPOTs();
}

References UsedPOTs().

◆ Index()

long int genie::flux::GSimpleNtpFlux::Index ( void )

inlinevirtual

returns corresponding index for current flux neutrino (e.g. for a flux ntuple returns the current entry number)

Implements genie::GFluxI.

Definition at line 220 of file GSimpleNtpFlux.h.

220{ return fIEntry; }

References fIEntry.

◆ Initialize()

void GSimpleNtpFlux::Initialize ( void )

private

Definition at line 707 of file GSimpleNtpFlux.cxx.

{
  LOG("Flux", pINFO) << "Initializing GSimpleNtpFlux driver";
 
  fMaxEv           =  0;
  fEnd             =  false;
 
  fCurEntry        = new GSimpleNtpEntry;
  fCurNuMI         = new GSimpleNtpNuMI;
  fCurAux          = new GSimpleNtpAux;
  fCurMeta         = new GSimpleNtpMeta;
 
  fCurEntryCopy    = 0;
  fCurNuMICopy     = 0;
  fCurAuxCopy      = 0;
 
  fNuFluxTree      = new TChain("flux");
  fNuMetaTree      = new TChain("meta");
 
  //fNuFluxFilePatterns = "";
  fNuFluxBranchRequest = "entry,numi,aux";  // all branches
 
  fNFiles          =  0;
 
  fNEntries        =  0;
  fIEntry          = -1;
  fIFileNumber     =  0;
  fICycle          =  0;
  fNUse            =  1;
  fIUse            =  999999;
 
  fFilePOTs        = 0;
 
  fMaxWeight       = -1;
 
  fSumWeight       =  0;
  fNNeutrinos      =  0;
  fNEntriesUsed    =  0;
  fEffPOTsPerNu    =  0;
  fAccumPOTs       =  0;
 
  fGenWeighted     = false;
  fAllFilesMeta    = true;
  fAlreadyUnwgt    = false;
 
  fIncludeVtxt     = true;
 
  this->SetDefaults();
  this->ResetCurrent();
}

References fAccumPOTs, fAllFilesMeta, fAlreadyUnwgt, fCurAux, fCurAuxCopy, fCurEntry, fCurEntryCopy, fCurMeta, fCurNuMI, fCurNuMICopy, fEffPOTsPerNu, fEnd, fFilePOTs, fGenWeighted, genie::flux::GFluxFileConfigI::fICycle, fIEntry, fIFileNumber, fIncludeVtxt, fIUse, fMaxEv, fMaxWeight, fNEntries, fNEntriesUsed, fNFiles, fNNeutrinos, fNuFluxBranchRequest, fNuFluxTree, fNuMetaTree, fNUse, fSumWeight, LOG, pINFO, ResetCurrent(), and SetDefaults().

◆ LoadBeamSimData() [1/4]

void genie::flux::GFluxFileConfigI::LoadBeamSimData	(	const std::set< std::string > &	filenames,
		const std::string &	det_loc )

virtual

Reimplemented from genie::flux::GFluxFileConfigI.

Definition at line 49 of file GFluxFileConfigI.cxx.

  {
    // Loads a beam simulation root file into the GFluxFileConfig driver.
    // have a set<> want a vector<>
    std::vector<std::string> filevec;
    std::copy(fileset.begin(),fileset.end(),std::back_inserter(filevec));
    LoadBeamSimData(filevec,config); // call the one that takes a vector
  }

◆ LoadBeamSimData() [2/4]

void genie::flux::GFluxFileConfigI::LoadBeamSimData	(	const std::string &	filename,
		const std::string &	det_loc )

virtual

Reimplemented from genie::flux::GFluxFileConfigI.

Definition at line 52 of file GFluxFileConfigI.cxx.

  {
    // Loads a beam simulation root file into the GFluxFileConfig driver.
    std::vector<std::string> filevec;
    filevec.push_back(filename);
    LoadBeamSimData(filevec,config); // call the one that takes a vector
  }

◆ LoadBeamSimData() [3/4]

virtual void genie::flux::GFluxFileConfigI::LoadBeamSimData	(	const std::vector< std::string > &	filenames,
		const std::string &	det_loc )

virtual

first is primary method for loading root flux ntuple files and config others are alternatives that can be overloaded but have sensible defaults to fall back to calling the vector version

Implements genie::flux::GFluxFileConfigI.

◆ LoadBeamSimData() [4/4]

void GSimpleNtpFlux::LoadBeamSimData	(	const std::vector< string > &	filenames,
		const std::string &	det_loc )

virtual

Definition at line 385 of file GSimpleNtpFlux.cxx.

{
// Loads a beam simulation root file into the GSimpleNtpFlux driver.
 
  fNuFluxFilePatterns = patterns;
  std::vector<int> nfiles_from_pattern;
 
  // create a (sorted) set of file names
  // this also helps ensure that the same file isn't listed multiple times
  std::set<std::string> fnames;
 
  LOG("Flux", pINFO) << "LoadBeamSimData was passed " << patterns.size()
                       << " patterns";
 
  for (size_t ipatt = 0; ipatt < patterns.size(); ++ipatt ) {
    string pattern = patterns[ipatt];
    nfiles_from_pattern.push_back(0);
    LOG("Flux", pINFO)
        << "Loading flux tree from ROOT file pattern ["
        << std::setw(3) << ipatt << "] \"" << pattern << "\"";
 
    // !WILDCARD only works for file name ... NOT directory
    string dirname = gSystem->UnixPathName(gSystem->WorkingDirectory());
    size_t slashpos = pattern.find_last_of("/");
    size_t fbegin;
    if ( slashpos != std::string::npos ) {
      dirname = pattern.substr(0,slashpos);
      LOG("Flux", pDEBUG) << "Look for flux using directory " << dirname;
      fbegin = slashpos + 1;
    } else { fbegin = 0; }
 
    void* dirp = gSystem->OpenDirectory(gSystem->ExpandPathName(dirname.c_str()));
    if ( dirp ) {
      std::string basename =
        pattern.substr(fbegin,pattern.size()-fbegin);
      TRegexp re(basename.c_str(),kTRUE);
      const char* onefile;
      while ( ( onefile = gSystem->GetDirEntry(dirp) ) ) {
        TString afile = onefile;
        if ( afile=="." || afile==".." ) continue;
        if ( basename!=afile && afile.Index(re) == kNPOS ) continue;
        std::string fullname = dirname + "/" + afile.Data();
        fnames.insert(fullname);
        nfiles_from_pattern[ipatt]++;
      }
      gSystem->FreeDirectory(dirp);
    } // legal directory
  } // loop over patterns
 
  size_t indx = 0;
  std::set<string>::const_iterator sitr = fnames.begin();
  for ( ; sitr != fnames.end(); ++sitr, ++indx) {
    string filename = *sitr;
    //std::cout << "  [" << std::setw(3) << indx << "]  \""
    //          << filename << "\"" << std::endl;
    bool isok = true;
    // this next test only works for local files, so we can't do that
    // if we want to stream via xrootd
    // ! (gSystem->AccessPathName(filename.c_str()));
    if ( ! isok ) continue;
    // open the file to see what it contains
    LOG("Flux", pINFO) << "Load file " <<  filename;
 
    TFile* tf = TFile::Open(filename.c_str(),"READ");
    TTree* etree = (TTree*)tf->Get("flux");
    if ( etree ) {
      TTree* mtree = (TTree*)tf->Get("meta");
      // add the file to the chain
      LOG("Flux", pDEBUG) << "AddFile " << filename
                          << " etree " << etree << " meta " << mtree;
      this->AddFile(etree,mtree,filename);
 
    } // found a GSimpleNtpEntry "flux" tree
    tf->Close();
    delete tf;
  } // loop over sorted file names
 
  // this will open all files and read headers!!
  fNEntries = fNuFluxTree->GetEntries();
 
  if ( fNEntries == 0 ) {
    LOG("Flux", pERROR)
      << "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!";
    LOG("Flux", pERROR)
      << "Loaded flux tree contains " <<  fNEntries << " entries";
    LOG("Flux", pERROR)
      << "Was passed the file patterns: ";
    for (size_t ipatt = 0; ipatt < patterns.size(); ++ipatt ) {
      string pattern = patterns[ipatt];
      LOG("Flux", pERROR)
        << "  [" << std::setw(3) << ipatt <<"] " << pattern;
    }
    LOG("Flux", pERROR)
      << "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!";
  } else {
    LOG("Flux", pNOTICE)
      << "Loaded flux tree contains " <<  fNEntries << " entries"
      << " from " << fnames.size() << " unique files";
    for (size_t ipatt = 0; ipatt < patterns.size(); ++ipatt ) {
      string pattern = patterns[ipatt];
      LOG("Flux", pINFO)
        << " pattern: " << pattern << " yielded "
        << nfiles_from_pattern[ipatt] << " files";
    }
  }
 
  int sba_status[3] = { -999, -999, -999 };
  // "entry" branch isn't optional ... contains the neutrino info
#if ROOT_VERSION_CODE >= ROOT_VERSION(5,26,0)
  sba_status[0] =
#endif
    fNuFluxTree->SetBranchAddress("entry",&fCurEntry);
#if ROOT_VERSION_CODE >= ROOT_VERSION(5,26,0)
  if ( sba_status[0] < 0 ) {
    LOG("Flux", pFATAL)
      << "flux chain has no \"entry\" branch " << sba_status[0];
    assert(0);
  }
#endif
  //TBranch* bentry = fNuFluxTree->GetBranch("entry");
  //bentry->SetAutoDelete(false);
 
  if ( OptionalAttachBranch("numi") ) {
#if ROOT_VERSION_CODE >= ROOT_VERSION(5,26,0)
    sba_status[1] =
#endif
      fNuFluxTree->SetBranchAddress("numi",&fCurNuMI);
    //TBranch* bnumi = fNuFluxTree->GetBranch("numi");
    //bnumi->SetAutoDelete(false);
  } else { delete fCurNuMI; fCurNuMI = 0; }
 
  if ( OptionalAttachBranch("aux") ) {
#if ROOT_VERSION_CODE >= ROOT_VERSION(5,26,0)
    sba_status[2] =
#endif
      fNuFluxTree->SetBranchAddress("aux",&fCurAux);
    //TBranch* baux = fNuFluxTree->GetBranch("aux");
    //baux->SetAutoDelete(false);
  } else { delete fCurAux; fCurAux = 0; }
 
  LOG("Flux", pDEBUG)
    << " SetBranchAddress status: "
    << " \"entry\"=" << sba_status[0]
    << " \"numi\"=" << sba_status[1]
    << " \"aux\"=" << sba_status[2];
 
  // attach requested branches
 
  if (fMaxWeight<=0) {
     LOG("Flux", pDEBUG)
       << "Run ProcessMeta() as part of LoadBeamSimData";
     this->ProcessMeta();
  }
 
  // current ntuple cycle # (flux ntuples may be recycled)
  fICycle =  0;
  // pick a starting entry index [0:fNEntries-1]
  // pretend we just used up the the previous one
  RandomGen* rnd = RandomGen::Instance();
  fIUse   =  9999999;
  fIEntry = rnd->RndFlux().Integer(fNEntries) - 1;
  if ( config.find("no-offset-index") != string::npos ) {
    LOG("Flux",pINFO) << "Config saw \"no-offset-index\"";
    fIEntry = -1;
  }
  LOG("Flux",pINFO) << "Start with entry fIEntry=" << fIEntry;
 
  // don't count things we used to estimate max weight
  fNEntriesUsed = 0;
  fSumWeight  = 0;
  fNNeutrinos = 0;
  fAccumPOTs  = 0;
 
  LOG("Flux",pDEBUG) << "about to CalcEffPOTsPerNu";
  this->CalcEffPOTsPerNu();
 
}

References AddFile(), CalcEffPOTsPerNu(), fAccumPOTs, fCurAux, fCurEntry, fCurNuMI, genie::flux::GFluxFileConfigI::fICycle, fIEntry, fIUse, fMaxWeight, fNEntries, fNEntriesUsed, fNNeutrinos, fNuFluxFilePatterns, fNuFluxTree, fSumWeight, genie::RandomGen::Instance(), LOG, OptionalAttachBranch(), pDEBUG, pERROR, pFATAL, pINFO, pNOTICE, ProcessMeta(), and genie::RandomGen::RndFlux().

◆ MaxEnergy()

double genie::flux::GSimpleNtpFlux::MaxEnergy ( void )

inlinevirtual

declare the max flux neutrino energy that can be generated (for init. purposes)

Implements genie::GFluxI.

Definition at line 213 of file GSimpleNtpFlux.h.

213{ return fMaxEv; }

References fMaxEv.

◆ Momentum()

const TLorentzVector & genie::flux::GSimpleNtpFlux::Momentum ( void )

inlinevirtual

returns the flux neutrino 4-momentum

Implements genie::GFluxI.

Definition at line 217 of file GSimpleNtpFlux.h.

217{ return fP4; }

References fP4.

◆ MoveToZ0()

void GSimpleNtpFlux::MoveToZ0 ( double z0 )

move ray origin to user coord Z0

Definition at line 323 of file GSimpleNtpFlux.cxx.

{
  // move ray origin to specified user z0
  // move beam coord entry correspondingly
 
  double pzusr    = fP4.Pz();
  if ( TMath::Abs(pzusr) < 1.0e-30 ) {
    // neutrino is moving almost entirely in x-y plane
    LOG("Flux", pWARN)
      << "MoveToZ0(" << z0usr << ") not possible due to pz_usr (" << pzusr << ")";
    return;
  }
 
  // Find the 3-position shift needed to move to the requested z coordinate
  double dz = z0usr - fX4.Z();
  double scale = dz / pzusr;
 
  // LOG("Flux",pDEBUG)
  //  << "MoveToZ0: before x4=(" << fX4.X() << "," << fX4.Y() << "," << fX4.Z()
  //  << "," << fX4.T() << ") z0=" << z0usr << " pzusr=" << pzusr
  //  << " p4=(" << fP4.Px() << "," << fP4.Py() << "," << fP4.Pz() << "," << fP4.E() << ")";
 
  TVector3 dx3( scale*fP4.Vect() );
 
  // Find the corresponding time shift
  double v = fP4.Beta() * constants::kLightSpeed
    / ( units::meter / units::second );
  double dt = fP4.P() * dz / ( pzusr * v );
 
  // Apply these shifts to update the neutrino 4-position
  TLorentzVector dx4( dx3, dt );
  fX4 += dx4;
 
  // LOG("Flux",pDEBUG)
  //  << "MoveToZ0: after x4=(" << fX4.X() << "," << fX4.Y() << "," << fX4.Z()
  //  << "," << fX4.T() << ")"
}

References fP4, fX4, genie::constants::kLightSpeed, LOG, genie::units::meter, pWARN, and genie::units::second.

Referenced by GenerateNext_weighted().

◆ NEntriesUsed()

long int genie::flux::GSimpleNtpFlux::NEntriesUsed ( void ) const

inline

number of entries read from files

Definition at line 260 of file GSimpleNtpFlux.h.

References fNEntriesUsed.

◆ NFluxNeutrinos()

long int GSimpleNtpFlux::NFluxNeutrinos ( void ) const

virtual

of rays generated

< number of flux neutrinos looped so far

Implements genie::flux::GFluxExposureI.

Definition at line 84 of file GSimpleNtpFlux.cxx.

{
  ///< number of flux neutrinos looped so far
  return fNNeutrinos;
}

References fNNeutrinos.

◆ OptionalAttachBranch()

bool GSimpleNtpFlux::OptionalAttachBranch ( std::string bname )

private

Definition at line 827 of file GSimpleNtpFlux.cxx.

{
 
  if ( fNuFluxBranchRequest.find(name) == string::npos ) {
    LOG("Flux", pINFO)
      << "no request for \"" << name <<"\" branch ";
    return false;
  }
 
  if ( ( fNuFluxTree->GetBranch(name.c_str()) ) ) return true;
 
  LOG("Flux", pINFO)
    << "no \"" << name << "\" branch in the \"flux\" tree";
  return false;
}

References fNuFluxBranchRequest, fNuFluxTree, LOG, and pINFO.

Referenced by LoadBeamSimData().

◆ PdgCode()

int genie::flux::GSimpleNtpFlux::PdgCode ( void )

inlinevirtual

returns the flux neutrino pdg code

Implements genie::GFluxI.

Definition at line 215 of file GSimpleNtpFlux.h.

215{ return fCurEntry->pdg; }

References fCurEntry.

◆ Position()

const TLorentzVector & genie::flux::GSimpleNtpFlux::Position ( void )

inlinevirtual

returns the flux neutrino 4-position (note: expect SI rather than physical units)

Implements genie::GFluxI.

Definition at line 218 of file GSimpleNtpFlux.h.

218{ return fX4; }

References fX4.

◆ PrintConfig()

void GSimpleNtpFlux::PrintConfig ( )

virtual

print the current configuration

Implements genie::flux::GFluxFileConfigI.

Definition at line 1076 of file GSimpleNtpFlux.cxx.

{
 
  std::ostringstream s;
  PDGCodeList::const_iterator itr = fPdgCList->begin();
  for ( ; itr != fPdgCList->end(); ++itr) s << (*itr) << " ";
  s << "[rejected: ";
  itr = fPdgCListRej->begin();
  for ( ; itr != fPdgCListRej->end(); ++itr) s << (*itr) << " ";
  s << " ] ";
 
  std::ostringstream fpattout;
  for (size_t i = 0; i < fNuFluxFilePatterns.size(); ++i)
    fpattout << "\n [" << std::setw(3) << i << "] " << fNuFluxFilePatterns[i];
 
  std::ostringstream flistout;
  std::vector<std::string> flist = GetFileList();
  for (size_t i = 0; i < flist.size(); ++i)
    flistout << "\n [" << std::setw(3) << i << "] " << flist[i];
 
  LOG("Flux", pNOTICE)
    << "GSimpleNtpFlux Config:"
    << "\n Enu_max " << fMaxEv
    << "\n pdg-codes: " << s.str() << "\n "
    << "\"flux\" " << fNEntries << " entries, "
    << "\"meta\" " << fNFiles << " entries"
    << " (FilePOTs " << fFilePOTs << ") in files:"
    << flistout.str()
    <<  "\n from file patterns: "
    << fpattout.str()
    << "\n wgt max=" << fMaxWeight
    << "\n Z0 pushback " << fZ0
    << "\n used entry " << fIEntry << " " << fIUse << "/" << fNUse
    << " times, in " << fICycle << "/" << fNCycles << " cycles"
    << "\n SumWeight " << fSumWeight << " for " << fNNeutrinos << " neutrinos"
    << " with " << fNEntriesUsed << " entries read"
    << "\n EffPOTsPerNu " << fEffPOTsPerNu << " AccumPOTs " << fAccumPOTs
    << "\n GenWeighted \"" << (fGenWeighted?"true":"false") << "\""
    << " AlreadyUnwgt \"" << (fAlreadyUnwgt?"true":"false") << "\""
    << " AllFilesMeta \"" << (fAllFilesMeta?"true":"false") << "\"";
 
}

References fAccumPOTs, fAllFilesMeta, fAlreadyUnwgt, fEffPOTsPerNu, fFilePOTs, fGenWeighted, genie::flux::GFluxFileConfigI::fICycle, fIEntry, fIUse, fMaxEv, fMaxWeight, genie::flux::GFluxFileConfigI::fNCycles, fNEntries, fNEntriesUsed, fNFiles, fNNeutrinos, fNuFluxFilePatterns, fNUse, genie::flux::GFluxFileConfigI::fPdgCList, genie::flux::GFluxFileConfigI::fPdgCListRej, fSumWeight, genie::flux::GFluxFileConfigI::fZ0, GetFileList(), LOG, and pNOTICE.

◆ PrintCurrent()

void GSimpleNtpFlux::PrintCurrent ( void )

print current entry from leaves

Definition at line 680 of file GSimpleNtpFlux.cxx.

{
  LOG("Flux", pNOTICE) << "CurrentEntry:" << *fCurEntry;
}

References fCurEntry, LOG, and pNOTICE.

◆ ProcessMeta()

void GSimpleNtpFlux::ProcessMeta ( void )

scan for max flux energy, weight

Definition at line 594 of file GSimpleNtpFlux.cxx.

{
 
  fAlreadyUnwgt = false;
  fFilePOTs     = 0;
  double minwgt = +1.0e10;
  double maxwgt = -1.0e10;
  double maxenu = 0.0;
 
  // PDGLibrary* pdglib = PDGLibrary::Instance(); // get initialized now
 
  if ( fAllFilesMeta ) {
    fNuMetaTree->SetBranchAddress("meta",&fCurMeta);
#ifdef USE_INDEX_FOR_META
    int nindices = fNuMetaTree->BuildIndex("metakey"); // key used to tie entries to meta data
    LOG("Flux", pDEBUG) << "ProcessMeta() BuildIndex nindices " << nindices;
#endif
    int nmeta = fNuMetaTree->GetEntries();
    for (int imeta = 0; imeta < nmeta; ++imeta ) {
      fNuMetaTree->GetEntry(imeta);
#ifdef __GENIE_LOW_LEVEL_MESG_ENABLED__
      LOG("Flux", pNOTICE) << "ProcessMeta() ifile " << imeta
                           << " (of " << fNFiles
                           << ") " << *fCurMeta;
#endif
      minwgt = TMath::Min(minwgt,fCurMeta->minWgt);
      maxwgt = TMath::Max(maxwgt,fCurMeta->maxWgt);
      maxenu = TMath::Max(maxenu,fCurMeta->maxEnergy);
      fFilePOTs += fCurMeta->protons;
      for (size_t i = 0; i < fCurMeta->pdglist.size(); ++i)
        fPdgCList->push_back(fCurMeta->pdglist[i]);
    }
    if ( minwgt == 1.0 && maxwgt == 1.0 ) fAlreadyUnwgt = true;
    fMaxWeight = maxwgt;
    this->SetMaxEnergy(maxenu);
 
  } else {
    //
    LOG("Flux", pFATAL) << "ProcessMeta() not all files have metadata";
    // for now PUNT ... eventually could scan all the entries
  }
 
#ifdef __GENIE_LOW_LEVEL_MESG_ENABLED__
  LOG("Flux", pNOTICE) << "ProcessMeta() Maximum flux weight = " << fMaxWeight
                       << ", energy = " << fMaxEv
                       << ", AlreadyUnwgt=" << (fAlreadyUnwgt?"true":"false");
#endif
 
  fCurMeta->Reset();
  fIFileNumber = -999;
 
}

References fAllFilesMeta, fAlreadyUnwgt, fCurMeta, fFilePOTs, fIFileNumber, fMaxEv, fMaxWeight, fNFiles, fNuMetaTree, genie::flux::GFluxFileConfigI::fPdgCList, LOG, pDEBUG, pFATAL, pNOTICE, and SetMaxEnergy().

Referenced by LoadBeamSimData().

◆ ResetCurrent()

void GSimpleNtpFlux::ResetCurrent ( void )

private

Definition at line 771 of file GSimpleNtpFlux.cxx.

{
// reset running values of neutrino pdg-code, 4-position & 4-momentum
// and the input ntuple leaves
 
  if (fCurEntry) fCurEntry->Reset();
  if (fCurNuMI)  fCurNuMI->Reset();
  if (fCurAux)   fCurAux->Reset();
  //allow caching//if (fCurMeta)  fCurMeta->Reset();
}

References fCurAux, fCurEntry, and fCurNuMI.

Referenced by GenerateNext_weighted(), and Initialize().

◆ ScanMeta()

void genie::flux::GSimpleNtpFlux::ScanMeta ( void )

private

◆ SetDefaults()

void GSimpleNtpFlux::SetDefaults ( void )

private

Definition at line 758 of file GSimpleNtpFlux.cxx.

{
 
// - Set the default flux neutrino start z position at use flux window
// - Set number of cycles to 1
 
  LOG("Flux", pINFO) << "Setting default GSimpleNtpFlux driver options";
 
  this->SetUpstreamZ     (-3.4e38); // way upstream ==> use flux window
  this->SetNumOfCycles   (0);
  this->SetEntryReuse    (1);
}

References LOG, pINFO, SetEntryReuse(), genie::flux::GFluxFileConfigI::SetNumOfCycles(), and genie::flux::GFluxFileConfigI::SetUpstreamZ().

Referenced by Initialize().

◆ SetEntryReuse()

void GSimpleNtpFlux::SetEntryReuse ( long int nuse = 1 )

of times to use entry before moving to next

Definition at line 655 of file GSimpleNtpFlux.cxx.

{
// With nuse > 1 then the same entry in the file is used "nuse" times
// before moving on to the next entry in the ntuple
 
  fNUse    = TMath::Max(1L, nuse);
}

References fNUse.

Referenced by SetDefaults().

◆ SetGenWeighted()

void genie::flux::GSimpleNtpFlux::SetGenWeighted ( bool genwgt = false )

inline

toggle whether GenerateNext() returns weight=1 flux (initial default false)

Definition at line 287 of file GSimpleNtpFlux.h.

References fGenWeighted.

◆ SetIncludeVtxt()

void genie::flux::GSimpleNtpFlux::SetIncludeVtxt ( bool it = true )

inline

Definition at line 249 of file GSimpleNtpFlux.h.

249{ fIncludeVtxt=it; }; ///< should X4 include CurEntry.vtxt

References fIncludeVtxt.

◆ SetMaxEnergy()

void GSimpleNtpFlux::SetMaxEnergy ( double Ev )

specify maximum flx neutrino energy

Definition at line 647 of file GSimpleNtpFlux.cxx.

{
  fMaxEv = TMath::Max(0.,Ev);
 
  LOG("Flux", pINFO)
    << "Declared maximum flux neutrino energy: " << fMaxEv;
}

References fMaxEv, LOG, and pINFO.

Referenced by ProcessMeta().

◆ SetRequestedBranchList()

void genie::flux::GSimpleNtpFlux::SetRequestedBranchList ( string blist = "entry,numi,aux" )

inline

Definition at line 283 of file GSimpleNtpFlux.h.

283{ fNuFluxBranchRequest = blist; }

References fNuFluxBranchRequest.

◆ SumWeight()

double genie::flux::GSimpleNtpFlux::SumWeight ( void ) const

inline

integrated weight for flux neutrinos looped so far

Definition at line 261 of file GSimpleNtpFlux.h.

References fSumWeight.

◆ UsedPOTs()

double GSimpleNtpFlux::UsedPOTs ( void ) const

of protons-on-target used

Definition at line 372 of file GSimpleNtpFlux.cxx.

{
// Compute current number of flux POTs
 
  if (!fNuFluxTree) {
     LOG("Flux", pWARN)
          << "The flux driver has not been properly configured";
     return 0;
  }
  return fAccumPOTs;
}

References fAccumPOTs, fNuFluxTree, LOG, and pWARN.

Referenced by GetTotalExposure().

◆ Weight()

double genie::flux::GSimpleNtpFlux::Weight ( void )

inlinevirtual

returns the flux neutrino weight (if any)

Implements genie::GFluxI.

Definition at line 216 of file GSimpleNtpFlux.h.

216{ return fWeight; }

References fWeight.

Referenced by GenerateNext(), and GenerateNext_weighted().

Member Data Documentation

◆ fAccumPOTs

double genie::flux::GSimpleNtpFlux::fAccumPOTs

private

POTs used so far.

Definition at line 335 of file GSimpleNtpFlux.h.

Referenced by Clear(), GenerateNext_weighted(), Initialize(), LoadBeamSimData(), PrintConfig(), and UsedPOTs().

◆ fAllFilesMeta

bool genie::flux::GSimpleNtpFlux::fAllFilesMeta

private

do all files in chain have meta data

Definition at line 340 of file GSimpleNtpFlux.h.

Referenced by AddFile(), GenerateNext_weighted(), Initialize(), PrintConfig(), and ProcessMeta().

◆ fAlreadyUnwgt

bool genie::flux::GSimpleNtpFlux::fAlreadyUnwgt

private

are input files already unweighted

Definition at line 338 of file GSimpleNtpFlux.h.

Referenced by GenerateNext(), Initialize(), PrintConfig(), and ProcessMeta().

◆ fCurAux

GSimpleNtpAux* genie::flux::GSimpleNtpFlux::fCurAux

private

current "aux" branch extra info

Definition at line 344 of file GSimpleNtpFlux.h.

Referenced by CleanUp(), GetBranchInfo(), GetCurrentAux(), Initialize(), LoadBeamSimData(), and ResetCurrent().

◆ fCurAuxCopy

GSimpleNtpAux* genie::flux::GSimpleNtpFlux::fCurAuxCopy

private

current "aux" branch extra info

Definition at line 351 of file GSimpleNtpFlux.h.

Referenced by Initialize().

◆ fCurEntry

GSimpleNtpEntry* genie::flux::GSimpleNtpFlux::fCurEntry

private

current entry

Definition at line 342 of file GSimpleNtpFlux.h.

Referenced by CleanUp(), GenerateNext(), GenerateNext_weighted(), GetBranchInfo(), GetCurrentEntry(), GetDecayDist(), Initialize(), LoadBeamSimData(), PdgCode(), PrintCurrent(), and ResetCurrent().

◆ fCurEntryCopy

GSimpleNtpEntry* genie::flux::GSimpleNtpFlux::fCurEntryCopy

private

current entry

Definition at line 349 of file GSimpleNtpFlux.h.

Referenced by Initialize().

◆ fCurMeta

GSimpleNtpMeta* genie::flux::GSimpleNtpFlux::fCurMeta

private

current meta data

Definition at line 347 of file GSimpleNtpFlux.h.

Referenced by CleanUp(), GenerateNext_weighted(), GetCurrentMeta(), GetFluxWindow(), Initialize(), and ProcessMeta().

◆ fCurNuMI

GSimpleNtpNuMI* genie::flux::GSimpleNtpFlux::fCurNuMI

private

current "numi" branch extra info

Definition at line 343 of file GSimpleNtpFlux.h.

Referenced by CleanUp(), GenerateNext_weighted(), GetBranchInfo(), GetCurrentNuMI(), Initialize(), LoadBeamSimData(), and ResetCurrent().

◆ fCurNuMICopy

GSimpleNtpNuMI* genie::flux::GSimpleNtpFlux::fCurNuMICopy

private

current "numi" branch extra info

Definition at line 350 of file GSimpleNtpFlux.h.

Referenced by Initialize().

◆ fEffPOTsPerNu

double genie::flux::GSimpleNtpFlux::fEffPOTsPerNu

private

what a entry is worth ...

Definition at line 334 of file GSimpleNtpFlux.h.

Referenced by CalcEffPOTsPerNu(), GenerateNext_weighted(), Initialize(), and PrintConfig().

◆ fEnd

bool genie::flux::GSimpleNtpFlux::fEnd

private

end condition reached

Definition at line 312 of file GSimpleNtpFlux.h.

Referenced by End(), GenerateNext_weighted(), and Initialize().

◆ fFilePOTs

Double_t genie::flux::GSimpleNtpFlux::fFilePOTs

private

of protons-on-target represented by all files

Definition at line 324 of file GSimpleNtpFlux.h.

Referenced by CalcEffPOTsPerNu(), Initialize(), PrintConfig(), and ProcessMeta().

◆ fGenWeighted

bool genie::flux::GSimpleNtpFlux::fGenWeighted

private

does GenerateNext() give weights?

Definition at line 337 of file GSimpleNtpFlux.h.

Referenced by GenerateNext(), GenerateWeighted(), Initialize(), PrintConfig(), and SetGenWeighted().

◆ fIEntry

Long64_t genie::flux::GSimpleNtpFlux::fIEntry

private

current flux ntuple entry

Definition at line 321 of file GSimpleNtpFlux.h.

Referenced by CleanUp(), GenerateNext_weighted(), Index(), Initialize(), LoadBeamSimData(), and PrintConfig().

◆ fIFileNumber

Int_t genie::flux::GSimpleNtpFlux::fIFileNumber

private

which file for the current entry

Definition at line 322 of file GSimpleNtpFlux.h.

Referenced by Initialize(), and ProcessMeta().

◆ fIncludeVtxt

bool genie::flux::GSimpleNtpFlux::fIncludeVtxt

private

does fX4 include CurEntry.vtxt or 0

Definition at line 353 of file GSimpleNtpFlux.h.

Referenced by GenerateNext_weighted(), GetIncludeVtxt(), Initialize(), and SetIncludeVtxt().

◆ fIUse

long int genie::flux::GSimpleNtpFlux::fIUse

private

current # of times an entry has been used

Definition at line 330 of file GSimpleNtpFlux.h.

Referenced by CleanUp(), GenerateNext_weighted(), Initialize(), LoadBeamSimData(), and PrintConfig().

◆ fMaxEv

double genie::flux::GSimpleNtpFlux::fMaxEv

private

maximum energy

Definition at line 311 of file GSimpleNtpFlux.h.

Referenced by GenerateNext_weighted(), Initialize(), MaxEnergy(), PrintConfig(), ProcessMeta(), and SetMaxEnergy().

◆ fMaxWeight

double genie::flux::GSimpleNtpFlux::fMaxWeight

private

max flux neutrino weight in input file

Definition at line 327 of file GSimpleNtpFlux.h.

Referenced by CalcEffPOTsPerNu(), GenerateNext(), Initialize(), LoadBeamSimData(), PrintConfig(), and ProcessMeta().

◆ fNEntries

Long64_t genie::flux::GSimpleNtpFlux::fNEntries

private

number of flux ntuple entries

Definition at line 320 of file GSimpleNtpFlux.h.

Referenced by CalcEffPOTsPerNu(), GenerateNext_weighted(), Initialize(), LoadBeamSimData(), and PrintConfig().

◆ fNEntriesUsed

long int genie::flux::GSimpleNtpFlux::fNEntriesUsed

private

number of entries read from files

Definition at line 333 of file GSimpleNtpFlux.h.

Referenced by GenerateNext_weighted(), Initialize(), LoadBeamSimData(), NEntriesUsed(), and PrintConfig().

◆ fNFiles

int genie::flux::GSimpleNtpFlux::fNFiles

private

number of files in chain

Definition at line 319 of file GSimpleNtpFlux.h.

Referenced by AddFile(), Initialize(), PrintConfig(), and ProcessMeta().

◆ fNNeutrinos

long int genie::flux::GSimpleNtpFlux::fNNeutrinos

private

number of flux neutrinos thrown so far

Definition at line 332 of file GSimpleNtpFlux.h.

Referenced by Clear(), GenerateNext_weighted(), Initialize(), LoadBeamSimData(), NFluxNeutrinos(), and PrintConfig().

◆ fNuFluxBranchRequest

string genie::flux::GSimpleNtpFlux::fNuFluxBranchRequest

private

list of requested branches "entry,numi,au"

Definition at line 315 of file GSimpleNtpFlux.h.

Referenced by Initialize(), OptionalAttachBranch(), and SetRequestedBranchList().

◆ fNuFluxFilePatterns

std::vector<string> genie::flux::GSimpleNtpFlux::fNuFluxFilePatterns

private

(potentially wildcarded) path(s)

Definition at line 314 of file GSimpleNtpFlux.h.

Referenced by LoadBeamSimData(), and PrintConfig().

◆ fNuFluxTree

TChain* genie::flux::GSimpleNtpFlux::fNuFluxTree

private

TTree // REF ONLY.

Definition at line 316 of file GSimpleNtpFlux.h.

Referenced by AddFile(), CalcEffPOTsPerNu(), CleanUp(), GenerateNext_weighted(), GetFileList(), GetFluxTChain(), Initialize(), LoadBeamSimData(), OptionalAttachBranch(), and UsedPOTs().

◆ fNuMetaTree

TChain* genie::flux::GSimpleNtpFlux::fNuMetaTree

private

TTree // REF ONLY.

Definition at line 317 of file GSimpleNtpFlux.h.

Referenced by AddFile(), CleanUp(), GenerateNext_weighted(), GetMetaDataTree(), Initialize(), and ProcessMeta().

◆ fNUse

long int genie::flux::GSimpleNtpFlux::fNUse

private

how often to use same entry in a row

Definition at line 329 of file GSimpleNtpFlux.h.

Referenced by CleanUp(), Initialize(), PrintConfig(), and SetEntryReuse().

◆ fP4

TLorentzVector genie::flux::GSimpleNtpFlux::fP4

private

reconstituted p4 vector

Definition at line 345 of file GSimpleNtpFlux.h.

Referenced by GenerateNext(), GenerateNext_weighted(), Momentum(), and MoveToZ0().

◆ fSumWeight

double genie::flux::GSimpleNtpFlux::fSumWeight

private

sum of weights for nus thrown so far

Definition at line 331 of file GSimpleNtpFlux.h.

Referenced by Clear(), GenerateNext_weighted(), Initialize(), LoadBeamSimData(), PrintConfig(), and SumWeight().

◆ fWeight

double genie::flux::GSimpleNtpFlux::fWeight

private

current neutrino weight

Definition at line 326 of file GSimpleNtpFlux.h.

Referenced by GenerateNext(), GenerateNext_weighted(), and Weight().

◆ fX4

TLorentzVector genie::flux::GSimpleNtpFlux::fX4

private

reconstituted position vector

Definition at line 346 of file GSimpleNtpFlux.h.

Referenced by GenerateNext(), GenerateNext_weighted(), MoveToZ0(), and Position().

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

GSimpleNtpFlux:

Constructor & Destructor Documentation

◆ GSimpleNtpFlux()

◆ ~GSimpleNtpFlux()

Member Function Documentation

◆ AddFile()

◆ CalcEffPOTsPerNu()

◆ CleanUp()

◆ Clear()

◆ End()

◆ FluxParticles()

◆ GenerateNext()

◆ GenerateNext_weighted()

◆ GenerateWeighted()

◆ GetBranchInfo()

◆ GetCurrentAux()

◆ GetCurrentEntry()

◆ GetCurrentMeta()

◆ GetCurrentNuMI()

◆ GetDecayDist()

◆ GetFileList()

◆ GetFluxTChain()

◆ GetFluxWindow()

◆ GetIncludeVtxt()

◆ GetMetaDataTree()

◆ GetTotalExposure()

◆ Index()

◆ Initialize()

◆ LoadBeamSimData() [1/4]

◆ LoadBeamSimData() [2/4]

◆ LoadBeamSimData() [3/4]

◆ LoadBeamSimData() [4/4]

◆ MaxEnergy()

◆ Momentum()

◆ MoveToZ0()

◆ NEntriesUsed()

◆ NFluxNeutrinos()

of rays generated

◆ OptionalAttachBranch()

◆ PdgCode()

◆ Position()

◆ PrintConfig()

◆ PrintCurrent()

◆ ProcessMeta()

◆ ResetCurrent()

◆ ScanMeta()

◆ SetDefaults()

◆ SetEntryReuse()

of times to use entry before moving to next

◆ SetGenWeighted()

◆ SetIncludeVtxt()

◆ SetMaxEnergy()

◆ SetRequestedBranchList()

◆ SumWeight()

◆ UsedPOTs()

of protons-on-target used

◆ Weight()

Member Data Documentation

◆ fAccumPOTs

◆ fAllFilesMeta

◆ fAlreadyUnwgt

◆ fCurAux

◆ fCurAuxCopy

◆ fCurEntry

◆ fCurEntryCopy

◆ fCurMeta

◆ fCurNuMI

◆ fCurNuMICopy

◆ fEffPOTsPerNu

◆ fEnd

◆ fFilePOTs

of protons-on-target represented by all files

◆ fGenWeighted

◆ fIEntry

◆ fIFileNumber