Generates values for the kinematic variables describing HEDIS v interaction events. Is a concrete implementation of the EventRecordVisitorI interface. More...

#include <HEDISKinematicsGenerator.h>

Inheritance diagram for genie::HEDISKinematicsGenerator:

[legend]

Collaboration diagram for genie::HEDISKinematicsGenerator:

[legend]

Public Member Functions
	HEDISKinematicsGenerator ()

	HEDISKinematicsGenerator (string config)

	~HEDISKinematicsGenerator ()

double	ComputeMaxXSec (const Interaction *interaction) const

void	ProcessEventRecord (GHepRecord *event_rec) const

void	Configure (const Registry &config)

void	Configure (string config)

Public Member Functions inherited from genie::EventRecordVisitorI
virtual	~EventRecordVisitorI ()

Public Member Functions inherited from genie::Algorithm
virtual	~Algorithm ()

virtual void	FindConfig (void)

virtual const Registry &	GetConfig (void) const

Registry *	GetOwnedConfig (void)

virtual const AlgId &	Id (void) const
	Get algorithm ID. More...

virtual AlgStatus_t	GetStatus (void) const
	Get algorithm status. More...

virtual bool	AllowReconfig (void) const

virtual AlgCmp_t	Compare (const Algorithm *alg) const
	Compare with input algorithm. More...

virtual void	SetId (const AlgId &id)
	Set algorithm ID. More...

virtual void	SetId (string name, string config)

const Algorithm *	SubAlg (const RgKey &registry_key) const

void	AdoptConfig (void)

void	AdoptSubstructure (void)

virtual void	Print (ostream &stream) const
	Print algorithm info. More...

Private Member Functions
double	Scan (Interaction *interaction, Range1D_t xrange, Range1D_t Q2range, int NKnotsQ2, int NKnotsX, double ME2, double &x_scan, double &Q2_scan) const

void	LoadConfig (void)

Private Attributes
int	fWideNKnotsX

int	fWideNKnotsQ2

double	fWideRange

int	fFineNKnotsX

int	fFineNKnotsQ2

double	fFineRange

double	fSFXmin
	minimum value of x for which SF tables are computed More...

double	fSFQ2min
	minimum value of Q2 for which SF tables are computed More...

double	fSFQ2max
	maximum value of Q2 for which SF tables are computed More...

Additional Inherited Members
Static Public Member Functions inherited from genie::Algorithm
static string	BuildParamVectKey (const std::string &comm_name, unsigned int i)

static string	BuildParamVectSizeKey (const std::string &comm_name)

static string	BuildParamMatKey (const std::string &comm_name, unsigned int i, unsigned int j)

static string	BuildParamMatRowSizeKey (const std::string &comm_name)

static string	BuildParamMatColSizeKey (const std::string &comm_name)

Protected Member Functions inherited from genie::KineGeneratorWithCache
	KineGeneratorWithCache ()

	KineGeneratorWithCache (string name)

	KineGeneratorWithCache (string name, string config)

	~KineGeneratorWithCache ()

virtual double	ComputeMaxXSec (const Interaction *in, const int nkey) const

virtual double	MaxXSec (GHepRecord *evrec, const int nkey=0) const

virtual double	FindMaxXSec (const Interaction *in, const int nkey=0) const

virtual void	CacheMaxXSec (const Interaction *in, double xsec, const int nkey=0) const

virtual double	Energy (const Interaction *in) const

virtual CacheBranchFx *	AccessCacheBranch (const Interaction *in, const int nkey=0) const

virtual void	AssertXSecLimits (const Interaction *in, double xsec, double xsec_max) const

Protected Member Functions inherited from genie::EventRecordVisitorI
	EventRecordVisitorI ()

	EventRecordVisitorI (string name)

	EventRecordVisitorI (string name, string config)

Protected Member Functions inherited from genie::Algorithm
	Algorithm ()

	Algorithm (string name)

	Algorithm (string name, string config)

void	Initialize (void)

void	DeleteConfig (void)

void	DeleteSubstructure (void)

Registry *	ExtractLocalConfig (const Registry &in) const

Registry *	ExtractLowerConfig (const Registry &in, const string &alg_key) const
	Split an incoming configuration Registry into a block valid for the sub-algo identified by alg_key. More...

template<class T >
bool	GetParam (const RgKey &name, T &p, bool is_top_call=true) const

template<class T >
bool	GetParamDef (const RgKey &name, T &p, const T &def) const

template<class T >
int	GetParamVect (const std::string &comm_name, std::vector< T > &v, bool is_top_call=true) const
	Handle to load vectors of parameters. More...

int	GetParamVectKeys (const std::string &comm_name, std::vector< RgKey > &k, bool is_top_call=true) const

template<class T >
int	GetParamMat (const std::string &comm_name, TMatrixT< T > &mat, bool is_top_call=true) const
	Handle to load matrix of parameters. More...

template<class T >
int	GetParamMatSym (const std::string &comm_name, TMatrixTSym< T > &mat, bool is_top_call=true) const

int	GetParamMatKeys (const std::string &comm_name, std::vector< RgKey > &k, bool is_top_call=true) const

int	AddTopRegistry (Registry *rp, bool owns=true)
	add registry with top priority, also update ownership More...

int	AddLowRegistry (Registry *rp, bool owns=true)
	add registry with lowest priority, also update ownership More...

int	MergeTopRegistry (const Registry &r)

int	AddTopRegisties (const vector< Registry * > &rs, bool owns=false)
	Add registries with top priority, also udated Ownerships. More...

Protected Attributes inherited from genie::KineGeneratorWithCache
const XSecAlgorithmI *	fXSecModel

double	fSafetyFactor
	ComputeMaxXSec -> ComputeMaxXSec * fSafetyFactor. More...

std::vector< double >	vSafetyFactors
	MaxXSec -> MaxXSec * fSafetyFactors[nkey]. More...

int	fNumOfSafetyFactors
	Number of given safety factors. More...

std::vector< string >	vInterpolatorTypes
	Type of interpolator for each key in a branch. More...

int	fNumOfInterpolatorTypes
	Number of given interpolators types. More...

double	fMaxXSecDiffTolerance
	max{100(xsec-maxxsec)/.5(xsec+maxxsec)} if xsec>maxxsec More...

double	fEMin
	min E for which maxxsec is cached - forcing explicit calc. More...

bool	fGenerateUniformly
	uniform over allowed phase space + event weight? More...

Protected Attributes inherited from genie::Algorithm
bool	fAllowReconfig

bool	fOwnsSubstruc
	true if it owns its substructure (sub-algs,...) More...

AlgId	fID
	algorithm name and configuration set More...

vector< Registry * >	fConfVect

vector< bool >	fOwnerships
	ownership for every registry in fConfVect More...

AlgStatus_t	fStatus
	algorithm execution status More...

AlgMap *	fOwnedSubAlgMp
	local pool for owned sub-algs (taken out of the factory pool) More...

Detailed Description

Generates values for the kinematic variables describing HEDIS v interaction events. Is a concrete implementation of the EventRecordVisitorI interface.

      Max Xsec are precomputed as the total xsec and they are stored in 
      ascii files. This saves a lot of computational time.

Author: Alfonso Garcia <alfonsog nikhef.nl> NIKHEF

Created:: August 28, 2019

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

Definition at line 31 of file HEDISKinematicsGenerator.h.

Constructor & Destructor Documentation

HEDISKinematicsGenerator::HEDISKinematicsGenerator ( )

Definition at line 42 of file HEDISKinematicsGenerator.cxx.

                                                    :
 KineGeneratorWithCache("genie::HEDISKinematicsGenerator")
 {
 
 }

HEDISKinematicsGenerator::HEDISKinematicsGenerator ( string config )

Definition at line 48 of file HEDISKinematicsGenerator.cxx.

                                                                 :
 KineGeneratorWithCache("genie::HEDISKinematicsGenerator", config)
 {
 
 }

HEDISKinematicsGenerator::~HEDISKinematicsGenerator ( )

Definition at line 54 of file HEDISKinematicsGenerator.cxx.

 {
 
 }

Member Function Documentation

double HEDISKinematicsGenerator::ComputeMaxXSec ( const Interaction * interaction ) const

virtual

Implements genie::KineGeneratorWithCache.

Definition at line 219 of file HEDISKinematicsGenerator.cxx.

 {
   return 0;
 }

void HEDISKinematicsGenerator::Configure ( const Registry & config )

virtual

Configure the algorithm with an external registry The registry is merged with the top level registry if it is owned, Otherwise a copy of it is added with the highest priority

Reimplemented from genie::Algorithm.

Definition at line 224 of file HEDISKinematicsGenerator.cxx.

References genie::Algorithm::Configure(), and LoadConfig().

 {
   Algorithm::Configure(config);
   this->LoadConfig();
 }

void HEDISKinematicsGenerator::Configure ( string config )

virtual

Configure the algorithm from the AlgoConfigPool based on param_set string given in input An algorithm contains a vector of registries coming from different xml configuration files, which are loaded according a very precise prioriy This methods will load a number registries in order of priority: 1) "Tunable" parameter set from CommonParametes. This is loaded with the highest prioriry and it is designed to be used for tuning procedure Usage not expected from the user. 2) For every string defined in "CommonParame" the corresponding parameter set will be loaded from CommonParameter.xml 3) parameter set specified by the config string and defined in the xml file of the algorithm 4) if config is not "Default" also the Default parameter set from the same xml file will be loaded Effectively this avoids the repetion of a parameter when it is not changed in the requested configuration

Reimplemented from genie::Algorithm.

Definition at line 230 of file HEDISKinematicsGenerator.cxx.

References genie::Algorithm::Configure(), and LoadConfig().

 {
   Algorithm::Configure(config);
   this->LoadConfig();
 }

void HEDISKinematicsGenerator::LoadConfig ( void )

private

Definition at line 236 of file HEDISKinematicsGenerator.cxx.

References fFineNKnotsQ2, fFineNKnotsX, fFineRange, genie::KineGeneratorWithCache::fMaxXSecDiffTolerance, genie::KineGeneratorWithCache::fSafetyFactor, fSFQ2max, fSFQ2min, fSFXmin, fWideNKnotsQ2, fWideNKnotsX, fWideRange, genie::Algorithm::GetParam(), and genie::Algorithm::GetParamDef().

Referenced by Configure().

 {
 
   //-- Safety factor for the maximum differential cross section
   GetParamDef("MaxXSec-SafetyFactor", fSafetyFactor, 2. ) ;
   //-- Maximum allowed fractional cross section deviation from maxim cross
   //   section used in rejection method
   GetParamDef("MaxXSec-DiffTolerance", fMaxXSecDiffTolerance, 999999. ) ;
   assert(fMaxXSecDiffTolerance>=0);
 
   GetParamDef("ScanWide-NKnotsX",   fWideNKnotsX,   10 ) ;
   GetParamDef("ScanWide-NKnotsQ2", fWideNKnotsQ2,   10 ) ;
   GetParamDef("ScanWide-Range",       fWideRange,  1.1 ) ;
   GetParamDef("ScanFine-NKnotsX",   fFineNKnotsX,   10 ) ;
   GetParamDef("ScanFine-NKnotsQ2", fFineNKnotsQ2,   10 ) ;
   GetParamDef("ScanFine-Range",       fFineRange,  10. ) ;
 
   // Limits from the SF tables that are useful to reduce computation 
   // time of the max cross section
   GetParam("XGrid-Min",  fSFXmin ) ;
   GetParam("Q2Grid-Min", fSFQ2min ) ;
   GetParam("Q2Grid-Max", fSFQ2max ) ;
 
 }

void HEDISKinematicsGenerator::ProcessEventRecord ( GHepRecord * event_rec ) const

virtual

Implements genie::EventRecordVisitorI.

Definition at line 59 of file HEDISKinematicsGenerator.cxx.

References genie::KineGeneratorWithCache::AssertXSecLimits(), genie::Kinematics::ClearRunningValues(), genie::EventGeneratorI::CrossSectionAlg(), genie::GHepRecord::EventFlags(), fFineNKnotsQ2, fFineNKnotsX, fFineRange, genie::KineGeneratorWithCache::fSafetyFactor, fSFQ2max, fSFQ2min, fSFXmin, fWideNKnotsQ2, fWideNKnotsX, fWideRange, genie::KineGeneratorWithCache::fXSecModel, gQ2, genie::Target::HitNucP4(), genie::Interaction::InitState(), genie::RunningThreadInfo::Instance(), genie::RandomGen::Instance(), genie::Interaction::KinePtr(), genie::kISkipKinematicChk, genie::kISkipProcessChk, genie::kKineGenErr, genie::kPSlog10xlog10Q2fE, genie::kPSxQ2fE, genie::kRfLab, genie::controls::kRjMaxIterations, LOG, genie::Range1D_t::max, genie::Range1D_t::min, pDEBUG, genie::Interaction::PhaseSpace(), pNOTICE, genie::InitialState::ProbeE(), pWARN, genie::KPhaseSpace::Q2Lim(), genie::RandomGen::RndKine(), genie::RunningThreadInfo::RunningThread(), Scan(), genie::GHepRecord::SetDiffXSec(), genie::Kinematics::SetQ2(), genie::exceptions::EVGThreadException::SetReason(), genie::Kinematics::SetW(), genie::Kinematics::Setx(), genie::Kinematics::Sety(), genie::GHepRecord::Summary(), genie::exceptions::EVGThreadException::SwitchOnFastForward(), genie::InitialState::Tgt(), genie::utils::kinematics::UpdateWYFromXQ2(), genie::Kinematics::W(), genie::KPhaseSpace::XLim(), genie::XSecAlgorithmI::XSec(), and genie::Kinematics::y().

 {
 
   //-- Get the random number generators
   RandomGen * rnd = RandomGen::Instance();
 
   //-- Access cross section algorithm for running thread
   RunningThreadInfo * rtinfo = RunningThreadInfo::Instance();
   const EventGeneratorI * evg = rtinfo->RunningThread();
   fXSecModel = evg->CrossSectionAlg();
 
   //-- Get the interaction 
   Interaction * interaction = evrec->Summary();
   interaction->SetBit(kISkipProcessChk);
 
   //-- Get neutrino energy and hit 'nucleon mass' 
   const InitialState & init_state = interaction->InitState();
   double Ev  = init_state.ProbeE(kRfLab);
   double M   = init_state.Tgt().HitNucP4().M(); // can be off m-shell
 
   //-- Get the physical W range 
   const KPhaseSpace & kps = interaction->PhaseSpace();
   Range1D_t xl = kps.XLim();
   Range1D_t Q2l = kps.Q2Lim();
 
   //-- x and y lower limit restrict by limits in SF tables
   Q2l.min = TMath::Max(Q2l.min,fSFQ2min);
   Q2l.max = TMath::Min(Q2l.max,fSFQ2max);
   xl.min  = TMath::Max(TMath::Max(xl.min,Q2l.min/2./M/Ev),fSFXmin);
 
   LOG("HEDISKinematics", pNOTICE) << "x: [" << xl.min << ", " << xl.max << "]"; 
   LOG("HEDISKinematics", pNOTICE) << "log10Q2: [" << Q2l.min << ", " << Q2l.max << "]"; 
 
   //-- For the subsequent kinematic selection with the rejection method:
   
   //Scan through a wide region to find the maximum
   Range1D_t xrange_wide(xl.min*fWideRange,xl.max/fWideRange); 
   Range1D_t Q2range_wide(Q2l.min*fWideRange,Q2l.max/fWideRange); 
   double x_wide    = 0.;
   double Q2_wide   = 0.;
   double xsec_wide = this->Scan(interaction,xrange_wide,Q2range_wide,fWideNKnotsX,fWideNKnotsQ2,2*M*Ev,x_wide,Q2_wide);
 
   //Scan through a fine region to find the maximum
   Range1D_t xrange_fine(TMath::Max(x_wide/fFineRange,xrange_wide.min),TMath::Min(x_wide*fFineRange,xrange_wide.max)); 
   Range1D_t Q2range_fine(TMath::Max(Q2_wide/fFineRange,Q2range_wide.min),TMath::Min(Q2_wide*fFineRange,Q2range_wide.max)); 
   double x_fine    = 0.;
   double Q2_fine   = 0.;
   double xsec_fine = this->Scan(interaction,xrange_fine,Q2range_fine,fFineNKnotsX,fFineNKnotsQ2,2*M*Ev,x_fine,Q2_fine);
 
   //Apply safety factor
   double xsec_max = fSafetyFactor * TMath::Max(xsec_wide,xsec_fine);
 
   //-- Try to select a valid (x,y) pair using the rejection method
   double log10xmin  = TMath::Log10(xl.min);  
   double log10xmax  = TMath::Log10(xl.max); 
   double log10Q2min = TMath::Log10(Q2l.min);  
   double log10Q2max = TMath::Log10(Q2l.max); 
 
   double dlog10x = log10xmax - log10xmin; 
   double dlog10Q2 = log10Q2max - log10Q2min; 
   
   double gx=-1, gQ2=-1, xsec=-1;
 
   unsigned int iter = 0;
   bool accept = false;
   while(1) {
      iter++;
      if(iter > kRjMaxIterations) {
        LOG("HEDISKinematics", pWARN)
          << " Couldn't select kinematics after " << iter << " iterations";
        evrec->EventFlags()->SetBitNumber(kKineGenErr, true);
        genie::exceptions::EVGThreadException exception;
        exception.SetReason("Couldn't select kinematics");
        exception.SwitchOnFastForward();
        throw exception;
      }
     
      gx = TMath::Power( 10., log10xmin + dlog10x * rnd->RndKine().Rndm() ); 
      gQ2 = TMath::Power( 10., log10Q2min + dlog10Q2 * rnd->RndKine().Rndm() ); 
 
      interaction->KinePtr()->Setx(gx);
      interaction->KinePtr()->SetQ2(gQ2);
      kinematics::UpdateWYFromXQ2(interaction);
 
      LOG("HEDISKinematics", pDEBUG) 
         << "Trying: x = " << gx << ", Q2 = " << gQ2 
         << " (W  = " << interaction->KinePtr()->W()  << ","
         << "  y = " << interaction->KinePtr()->y() << ")";
 
      //-- compute the cross section for current kinematics
      xsec = fXSecModel->XSec(interaction, kPSlog10xlog10Q2fE);
 
      //-- decide whether to accept the current kinematics
      this->AssertXSecLimits(interaction, xsec, xsec_max);
 
      double t = xsec_max * rnd->RndKine().Rndm();
 
      LOG("HEDISKinematics", pDEBUG) << "xsec= " << xsec << ", Rnd= " << t;
 
      accept = (t < xsec);
 
      //-- If the generated kinematics are accepted, finish-up module's job
      if(accept) {
          LOG("HEDISKinematics", pNOTICE) 
             << "Selected:  x = " << gx << ", Q2 = " << gQ2
             << " (W  = " << interaction->KinePtr()->W()  << ","
             << " (Y = " << interaction->KinePtr()->y() << ")";
 
          // reset trust bits
          interaction->ResetBit(kISkipProcessChk);
          interaction->ResetBit(kISkipKinematicChk);
 
          // set the cross section for the selected kinematics
          evrec->SetDiffXSec(xsec,kPSxQ2fE);
 
          // lock selected kinematics & clear running values
          interaction->KinePtr()->SetW (interaction->KinePtr()->W(),  true);
          interaction->KinePtr()->Sety (interaction->KinePtr()->y(),  true);
          interaction->KinePtr()->SetQ2(gQ2, true);
          interaction->KinePtr()->Setx (gx,  true);
          interaction->KinePtr()->ClearRunningValues();
          return;
      }
   } // iterations
 }

double HEDISKinematicsGenerator::Scan	(	Interaction *	interaction,
		Range1D_t	xrange,
		Range1D_t	Q2range,
		int	NKnotsQ2,
		int	NKnotsX,
		double	ME2,
		double &	x_scan,
		double &	Q2_scan
	)		const

private

Definition at line 185 of file HEDISKinematicsGenerator.cxx.

References genie::KineGeneratorWithCache::fXSecModel, genie::Interaction::KinePtr(), genie::kPSlog10xlog10Q2fE, LOG, genie::Range1D_t::max, genie::Range1D_t::min, pDEBUG, pNOTICE, genie::Kinematics::SetQ2(), genie::Kinematics::Setx(), genie::utils::kinematics::UpdateWYFromXQ2(), and genie::XSecAlgorithmI::XSec().

Referenced by ProcessEventRecord().

 {
 
   double xsec_scan = 0.;
   Q2_scan   = 0.;
   x_scan    = 0.;
 
   double stepQ2 = TMath::Power(Q2range.max/Q2range.min,1./(NKnotsQ2-1));
 
   for ( int iq=0; iq<NKnotsQ2; iq++) {
     double Q2_aux = Q2range.min*TMath::Power(stepQ2,iq);
     xrange.min = TMath::Max(xrange.min,Q2_aux/ME2);
     double stepx = TMath::Power(xrange.max/xrange.min,1./(NKnotsX-1));
     for ( int ix=0; ix<NKnotsX; ix++) {
       double x_aux = xrange.min*TMath::Power(stepx,ix);
       interaction->KinePtr()->Setx(x_aux);
       interaction->KinePtr()->SetQ2(Q2_aux);
       kinematics::UpdateWYFromXQ2(interaction);      
       double xsec_aux = fXSecModel->XSec(interaction, kPSlog10xlog10Q2fE);
       LOG("HEDISKinematics", pDEBUG) << "x = " << x_aux << " , Q2 = " << Q2_aux << ", xsec = " << xsec_aux; 
       if (xsec_aux>xsec_scan) {
         xsec_scan = xsec_aux;
         Q2_scan   = Q2_aux;
         x_scan    = x_aux;
       }
     }
   }
 
   LOG("HEDISKinematics", pNOTICE) << "scan -> x = " << x_scan << " , Q2 = " << Q2_scan << ", xsec = " << xsec_scan; 
 
   return xsec_scan;
 
 }