genie::XSecLinearCombinations Class Reference

Computes the xsec as a linear combination of different XSecSlgorithmI See GENIE docdb 252. More...

#include <XSecLinearCombinations.h>

Inheritance diagram for genie::XSecLinearCombinations:

Collaboration diagram for genie::XSecLinearCombinations:

Public Member Functions
	XSecLinearCombinations ()
	XSecLinearCombinations (string config)
virtual	~XSecLinearCombinations ()
double	XSec (const Interaction *i, KinePhaseSpace_t k) const
	Compute the cross section for the input interaction.
double	Integral (const Interaction *i) const
bool	ValidProcess (const Interaction *i) const
	Can this cross section algorithm handle the input process?
void	Configure (const Registry &config)
void	Configure (string config)
Public Member Functions inherited from genie::XSecAlgorithmI
virtual	~XSecAlgorithmI ()
virtual bool	ValidKinematics (const Interaction *i) const
	Is the input kinematical point a physically allowed one?
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.
virtual AlgStatus_t	GetStatus (void) const
	Get algorithm status.
virtual bool	AllowReconfig (void) const
virtual AlgCmp_t	Compare (const Algorithm *alg) const
	Compare with input algorithm.
virtual void	SetId (const AlgId &id)
	Set algorithm ID.
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.

Protected Member Functions
void	LoadConfig (void)
Protected Member Functions inherited from genie::XSecAlgorithmI
	XSecAlgorithmI ()
	XSecAlgorithmI (string name)
	XSecAlgorithmI (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.
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.
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.
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
int	AddLowRegistry (Registry *rp, bool owns=true)
	add registry with lowest priority, also update ownership
int	MergeTopRegistry (const Registry &r)
int	AddTopRegisties (const vector< Registry * > &rs, bool owns=false)
	Add registries with top priority, also udated Ownerships.

Private Attributes
std::vector< const XSecAlgorithmI * >	fXSections
std::vector< double >	fLinearCoefficients

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 Attributes inherited from genie::Algorithm
bool	fAllowReconfig
bool	fOwnsSubstruc
	true if it owns its substructure (sub-algs,...)
AlgId	fID
	algorithm name and configuration set
vector< Registry * >	fConfVect
vector< bool >	fOwnerships
	ownership for every registry in fConfVect
AlgStatus_t	fStatus
	algorithm execution status
AlgMap *	fOwnedSubAlgMp
	local pool for owned sub-algs (taken out of the factory pool)

Detailed Description

Computes the xsec as a linear combination of different XSecSlgorithmI See GENIE docdb 252.

Author

Code contributed by J.Tena Vidal and M.Roda

Created:\n Mar 12, 2020

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 27 of file XSecLinearCombinations.h.

Constructor & Destructor Documentation

XSecLinearCombinations() [1/2]

XSecLinearCombinations::XSecLinearCombinations

(

)

Definition at line 18 of file XSecLinearCombinations.cxx.

                                               :
  XSecAlgorithmI("genie::XSecLinearCombinations")
{
 
}

References genie::XSecAlgorithmI::XSecAlgorithmI().

XSecLinearCombinations() [2/2]

XSecLinearCombinations::XSecLinearCombinations

(

string

config

)

Definition at line 24 of file XSecLinearCombinations.cxx.

                                                            :
  XSecAlgorithmI("genie::XSecLinearCombinations", config)
{
 
}

References genie::XSecAlgorithmI::XSecAlgorithmI().

~XSecLinearCombinations()

XSecLinearCombinations::~XSecLinearCombinations ( )

virtual

Definition at line 30 of file XSecLinearCombinations.cxx.

{
 
}

Member Function Documentation

Configure() [1/2]

void XSecLinearCombinations::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 84 of file XSecLinearCombinations.cxx.

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

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

Configure() [2/2]

void XSecLinearCombinations::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 92 of file XSecLinearCombinations.cxx.

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

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

Integral()

double XSecLinearCombinations::Integral ( const Interaction * i ) const

virtual

Integrate the model over the kinematic phase space available to the input interaction (kinematical cuts can be included)

Implements genie::XSecAlgorithmI.

Definition at line 53 of file XSecLinearCombinations.cxx.

{
 
  double xsec = 0 ; 
  // Store xsec prediction for each entry :
  for( unsigned int i = 0 ; i < fXSections.size() ; ++ i ) {
    xsec += ( fXSections[i] -> Integral( interaction ) ) * fLinearCoefficients[i] ; 
  }
 
  return xsec;
}

References fLinearCoefficients, fXSections, and Integral().

Referenced by Integral().

LoadConfig()

void XSecLinearCombinations::LoadConfig ( void )

protected

Definition at line 100 of file XSecLinearCombinations.cxx.

{
  bool good_config = true ;
  GetParamVect( "LinearCoefficients", fLinearCoefficients ) ; 
 
  bool Normalise = false ;
  GetParam( "Normalise", Normalise ) ;
 
  if( Normalise ) {
    double sum = 0 ; 
    for( unsigned int i = 0 ; i < fLinearCoefficients.size() ; ++i ) {
      sum += fLinearCoefficients[i] ;
    }
 
    if( sum == 0 ) {
      good_config = false ;
      LOG("XSecLinearCombinations", pERROR) << "Sum of linear coefficients is zero. Cannot normalize " ;
    }
 
    for( unsigned int j = 0 ; j < fLinearCoefficients.size() ; ++j ) {
      fLinearCoefficients[j] /= sum ;
    }
  }
 
  std::vector<RgKey> XSectionsKeys ;
  GetParamVectKeys( "CrossSection", XSectionsKeys ) ;
 
  if( XSectionsKeys.size() != fLinearCoefficients.size() ) {
    good_config = false ; 
    LOG("XSecLinearCombinations", pERROR) << "Entries don't match" ;
    LOG("XSecLinearCombinations", pERROR) << "Cross Sections size: " << XSectionsKeys.size() ;
    LOG("XSecLinearCombinations", pERROR) << "Linear Coefficients size: " << fLinearCoefficients.size() ;
  }
 
  for( unsigned int i = 0 ; i < XSectionsKeys.size() ; ++i ) {
    fXSections.push_back( dynamic_cast<const XSecAlgorithmI *> ( this->SubAlg( XSectionsKeys[i] ) ) );
    if ( ! fXSections[i] ) {
      good_config = false ;
      LOG("XSecLinearCombinations", pERROR) << "The SubAlg is not a XSecAlgorithmI";
    }
  }
 
  if( ! good_config ) {
    LOG("XSecLinearCombinations", pERROR) << "XSecLinearCombilation Configuration has failed.";
    exit(78) ;
  }
 
}

References fLinearCoefficients, fXSections, genie::Algorithm::GetParam(), genie::Algorithm::GetParamVect(), genie::Algorithm::GetParamVectKeys(), LOG, pERROR, genie::Algorithm::SubAlg(), and genie::XSecAlgorithmI::XSecAlgorithmI().

Referenced by Configure(), and Configure().

ValidProcess()

bool XSecLinearCombinations::ValidProcess ( const Interaction * i ) const

virtual

Can this cross section algorithm handle the input process?

Implements genie::XSecAlgorithmI.

Definition at line 67 of file XSecLinearCombinations.cxx.

{
  bool is_valid = true ;
 
  // CHECK THAT THE XSEC USED CONSIDER A VALID PROCESS
  for( unsigned int i = 0 ; i < fXSections.size() ; ++ i ) {
    if( ! fXSections[i] -> ValidProcess( interaction ) ) {
      is_valid = false ;
      break ; 
    }
  }
  
  return is_valid ;
}

References fXSections, and ValidProcess().

Referenced by ValidProcess().

XSec()

double XSecLinearCombinations::XSec ( const Interaction * i, KinePhaseSpace_t k ) const

virtual

Compute the cross section for the input interaction.

Implements genie::XSecAlgorithmI.

Definition at line 37 of file XSecLinearCombinations.cxx.

{
  double xsec = 0 ; 
  // Store xsec prediction for each entry :
  for( unsigned int i = 0 ; i < fXSections.size() ; ++ i ) {
    if( fXSections[i] -> ValidKinematics( interaction ) ) { 
      xsec += ( fXSections[i] -> XSec( interaction, kps ) ) * fLinearCoefficients[i] ;
    }
  }
 
  return xsec;
}

References fLinearCoefficients, fXSections, genie::XSecAlgorithmI::ValidKinematics(), and XSec().

Referenced by XSec().

Member Data Documentation

fLinearCoefficients

std::vector<double> genie::XSecLinearCombinations::fLinearCoefficients

private

Definition at line 52 of file XSecLinearCombinations.h.

Referenced by Integral(), LoadConfig(), and XSec().

fXSections

std::vector<const XSecAlgorithmI*> genie::XSecLinearCombinations::fXSections

private

Definition at line 51 of file XSecLinearCombinations.h.

Referenced by Integral(), LoadConfig(), ValidProcess(), and XSec().

---

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

• XSecLinearCombinations.h
• XSecLinearCombinations.cxx