genie::flux::GFluxFileConfigI Class Reference

#include <GFluxFileConfigI.h>

Inheritance diagram for genie::flux::GFluxFileConfigI:

Collaboration diagram for genie::flux::GFluxFileConfigI:

Public Member Functions
	GFluxFileConfigI ()
virtual	~GFluxFileConfigI ()
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)
virtual void	SetXMLFileBase (std::string xmlbasename="")
virtual std::string	GetXMLFileBase () const
virtual void	GetBranchInfo (std::vector< std::string > &branchNames, std::vector< std::string > &branchClassNames, std::vector< void ** > &branchObjPointers)
virtual TTree *	GetMetaDataTree ()
virtual void	PrintConfig ()=0
	print the current configuration
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

Protected Attributes
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

Author

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

Created:\n 2015-03-17

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 31 of file GFluxFileConfigI.h.

Constructor & Destructor Documentation

GFluxFileConfigI()

genie::flux::GFluxFileConfigI::GFluxFileConfigI

(

)

Definition at line 18 of file GFluxFileConfigI.cxx.

    : fPdgCList(new PDGCodeList)
    , fPdgCListRej(new PDGCodeList)
    , fXMLbasename("")
    , fNCycles(0)
    , fICycle(0)
    , fZ0(-3.4e38)
  { ; }

References fICycle, fNCycles, fPdgCList, fPdgCListRej, fXMLbasename, and fZ0.

~GFluxFileConfigI()

genie::flux::GFluxFileConfigI::~GFluxFileConfigI ( )

virtual

Definition at line 27 of file GFluxFileConfigI.cxx.

{ ; }

Member Function Documentation

GetBranchInfo()

void genie::flux::GFluxFileConfigI::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 in genie::flux::GNuMIFlux, and genie::flux::GSimpleNtpFlux.

Definition at line 54 of file GFluxFileConfigI.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.
 
    // default is not to supply anything
  }

Referenced by main().

GetMetaDataTree()

TTree * genie::flux::GFluxFileConfigI::GetMetaDataTree ( )

virtual

Reimplemented in genie::flux::GNuMIFlux, and genie::flux::GSimpleNtpFlux.

Definition at line 67 of file GFluxFileConfigI.cxx.

  {
    return 0;
  }

Referenced by main().

GetXMLFileBase()

virtual std::string genie::flux::GFluxFileConfigI::GetXMLFileBase ( ) const

inlinevirtual

Definition at line 56 of file GFluxFileConfigI.h.

{ return fXMLbasename; }

References fXMLbasename.

LoadBeamSimData() [1/3]

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

virtual

Reimplemented in genie::flux::GNuMIFlux, and genie::flux::GSimpleNtpFlux.

Definition at line 33 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
  }

References LoadBeamSimData().

LoadBeamSimData() [2/3]

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

virtual

Reimplemented in genie::flux::GNuMIFlux, and genie::flux::GSimpleNtpFlux.

Definition at line 44 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/3]

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

pure 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

Implemented in genie::flux::GNuMIFlux, and genie::flux::GSimpleNtpFlux.

Referenced by LoadBeamSimData(), LoadDetectorPosition(), and main().

PrintConfig()

virtual void genie::flux::GFluxFileConfigI::PrintConfig ( )

pure virtual

print the current configuration

Implemented in genie::flux::GNuMIFlux, and genie::flux::GSimpleNtpFlux.

Referenced by main().

SetFluxParticles()

void genie::flux::GFluxFileConfigI::SetFluxParticles ( const PDGCodeList & particles )

virtual

specify list of flux neutrino species

Definition at line 99 of file GFluxFileConfigI.cxx.

  {
    fPdgCList->Copy(particles);
 
    LOG("Flux", pINFO)
      << "Declared list of neutrino species: " << *fPdgCList;
  }

References fPdgCList, LOG, and pINFO.

Referenced by main(), and genie::flux::GNuMIFlux::SetDefaults().

SetNumOfCycles()

void genie::flux::GFluxFileConfigI::SetNumOfCycles ( long int ncycle )

virtual

limit cycling through input files

Definition at line 85 of file GFluxFileConfigI.cxx.

  {
    // The flux ntuples can be recycled for a number of times to boost
    // generated event statistics without requiring enormous beam simulation
    // statistics.
    // That option determines how many times the driver is going to cycle
    // through the input flux ntuple.
    // With ncycle=0 the flux ntuple will be recycled an infinite amount of
    // times so that the event generation loop can exit only on a POT or
    // event num check.
 
    fNCycles = TMath::Max(0L, ncycle);
  }

References fNCycles.

Referenced by main(), genie::flux::GNuMIFlux::SetDefaults(), and genie::flux::GSimpleNtpFlux::SetDefaults().

SetUpstreamZ()

void genie::flux::GFluxFileConfigI::SetUpstreamZ ( double z0 )

virtual

set flux neutrino initial z position (upstream of the detector) pushed back from the normal flux window

Definition at line 73 of file GFluxFileConfigI.cxx.

  {
    // The flux neutrino position (x,y) is given on the user specified
    // flux window.  This method sets the preferred user coord starting z
    // position upstream of detector face. Each flux neutrino will be
    // backtracked from the initial flux window to the input z0.
    // If the value is unreasonable (> 10^30) then the ray is left on
    // the flux window.
 
    fZ0 = z0;
  }

References fZ0.

Referenced by main(), genie::flux::GNuMIFlux::SetDefaults(), and genie::flux::GSimpleNtpFlux::SetDefaults().

SetXMLFileBase()

void genie::flux::GFluxFileConfigI::SetXMLFileBase ( std::string xmlbasename = "" )

virtual

Definition at line 29 of file GFluxFileConfigI.cxx.

  { fXMLbasename = xmlbasename; }

References fXMLbasename.

Referenced by genie::flux::GNuMIFlux::LoadConfig(), and genie::flux::GNuMIFlux::SetDefaults().

Member Data Documentation

fICycle

long int genie::flux::GFluxFileConfigI::fICycle

protected

current file cycle default 0 = infinitely

Definition at line 100 of file GFluxFileConfigI.h.

Referenced by genie::flux::GNuMIFlux::CleanUp(), genie::flux::GSimpleNtpFlux::CleanUp(), genie::flux::GNuMIFlux::Clear(), genie::flux::GSimpleNtpFlux::Clear(), genie::flux::GNuMIFlux::GenerateNext_weighted(), genie::flux::GSimpleNtpFlux::GenerateNext_weighted(), GFluxFileConfigI(), genie::flux::GNuMIFlux::Initialize(), genie::flux::GSimpleNtpFlux::Initialize(), genie::flux::GNuMIFlux::LoadBeamSimData(), genie::flux::GSimpleNtpFlux::LoadBeamSimData(), genie::flux::GNuMIFlux::PrintConfig(), and genie::flux::GSimpleNtpFlux::PrintConfig().

fNCycles

long int genie::flux::GFluxFileConfigI::fNCycles

protected

times to cycle through the ntuple(s)

Definition at line 99 of file GFluxFileConfigI.h.

Referenced by genie::flux::GNuMIFlux::CleanUp(), genie::flux::GSimpleNtpFlux::CleanUp(), genie::flux::GNuMIFlux::GenerateNext_weighted(), genie::flux::GSimpleNtpFlux::GenerateNext_weighted(), GFluxFileConfigI(), genie::flux::GNuMIFlux::PrintConfig(), genie::flux::GSimpleNtpFlux::PrintConfig(), and SetNumOfCycles().

fPdgCList

PDGCodeList* genie::flux::GFluxFileConfigI::fPdgCList

protected

list of neutrino pdg-codes to generate

Definition at line 96 of file GFluxFileConfigI.h.

Referenced by genie::flux::GNuMIFlux::CleanUp(), genie::flux::GSimpleNtpFlux::CleanUp(), genie::flux::GNuMIFlux::FluxParticles(), genie::flux::GSimpleNtpFlux::FluxParticles(), genie::flux::GNuMIFlux::GenerateNext_weighted(), genie::flux::GSimpleNtpFlux::GenerateNext_weighted(), GFluxFileConfigI(), genie::flux::GNuMIFlux::PrintConfig(), genie::flux::GSimpleNtpFlux::PrintConfig(), genie::flux::GSimpleNtpFlux::ProcessMeta(), and SetFluxParticles().

fPdgCListRej

PDGCodeList* genie::flux::GFluxFileConfigI::fPdgCListRej

protected

list of nu pdg-codes seen but rejected

Definition at line 97 of file GFluxFileConfigI.h.

Referenced by genie::flux::GNuMIFlux::CleanUp(), genie::flux::GSimpleNtpFlux::CleanUp(), genie::flux::GNuMIFlux::GenerateNext_weighted(), genie::flux::GSimpleNtpFlux::GenerateNext_weighted(), GFluxFileConfigI(), genie::flux::GNuMIFlux::PrintConfig(), and genie::flux::GSimpleNtpFlux::PrintConfig().

fXMLbasename

std::string genie::flux::GFluxFileConfigI::fXMLbasename

protected

XML file that might hold config param_sets.

Definition at line 98 of file GFluxFileConfigI.h.

Referenced by GetXMLFileBase(), GFluxFileConfigI(), and SetXMLFileBase().

fZ0

double genie::flux::GFluxFileConfigI::fZ0

protected

configurable starting z position for each flux neutrino (in detector coord system)

Definition at line 102 of file GFluxFileConfigI.h.

Referenced by genie::flux::GNuMIFlux::GenerateNext_weighted(), genie::flux::GSimpleNtpFlux::GenerateNext_weighted(), GFluxFileConfigI(), genie::flux::GNuMIFlux::PrintConfig(), genie::flux::GSimpleNtpFlux::PrintConfig(), and SetUpstreamZ().

---

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

• GFluxFileConfigI.h
• GFluxFileConfigI.cxx