genie::QvalueShifter Class Reference

#include <QvalueShifter.h>

Inheritance diagram for genie::QvalueShifter:

Collaboration diagram for genie::QvalueShifter:

Public Member Functions
	QvalueShifter ()
	QvalueShifter (string config)
virtual	~QvalueShifter ()
virtual double	Shift (const Target &target) const
virtual double	Shift (const Interaction &interaction) const
void	Configure (const Registry &config)
void	Configure (string config)
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::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
double	fRelShiftDefault
std::map< int, double >	fRelShift

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

Definition at line 29 of file QvalueShifter.h.

Constructor & Destructor Documentation

QvalueShifter() [1/2]

QvalueShifter::QvalueShifter

(

)

Definition at line 21 of file QvalueShifter.cxx.

                             : 
  Algorithm("genie::QvalueShifter") 
{
  
}

References genie::Algorithm::Algorithm().

QvalueShifter() [2/2]

QvalueShifter::QvalueShifter

(

string

config

)

Definition at line 27 of file QvalueShifter.cxx.

                                          : 
  Algorithm("genie::QvalueShifter",config) 
{
  
}

References genie::Algorithm::Algorithm().

~QvalueShifter()

QvalueShifter::~QvalueShifter ( )

virtual

Definition at line 33 of file QvalueShifter.cxx.

{
 
}

Member Function Documentation

Configure() [1/2]

void QvalueShifter::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 38 of file QvalueShifter.cxx.

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

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

Configure() [2/2]

void QvalueShifter::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 44 of file QvalueShifter.cxx.

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

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

LoadConfig()

void QvalueShifter::LoadConfig ( void )

protected

Definition at line 76 of file QvalueShifter.cxx.

{
  bool good_config = true ;
  // Store default value
  GetParam( "QvalueShiftDefault", fRelShiftDefault ) ;
 
  // Clear map
  fRelShift.clear() ; 
 
  // Get possible entries to pdg - shift map 
  auto kpdg_list = GetConfig().FindKeys("QvalueShift@Pdg=") ;
 
  for( auto kiter = kpdg_list.begin(); kiter != kpdg_list.end(); ++kiter ) {
    const RgKey & key = *kiter ;
    vector<string> kv = genie::utils::str::Split(key,"=");
    assert(kv.size()==2);
    int pdg_target = stoi( kv[1] );
    if( ! PDGLibrary::Instance()->Find(pdg_target) ) {
      LOG("QvalueShifter", pERROR) << "The target Pdg code associated to the QvalueShift is not valid : " << pdg_target ; 
      good_config = false ; 
      continue ; 
    }
 
    if( ! pdg::IsIon(pdg_target) ) {
      LOG("QvalueShifter", pERROR) << "The target Pdg code does not correspond to a Ion : " << pdg_target ; 
      good_config = false ; 
      continue ; 
    } 
   GetParam( key, fRelShift[pdg_target] ) ;
  }
 
  if( ! good_config ) {
    LOG("QvalueShifter", pERROR) << "Configuration has failed.";
    exit(78) ;
  }
 
}

References genie::Registry::FindKeys(), fRelShift, fRelShiftDefault, genie::Algorithm::GetConfig(), genie::Algorithm::GetParam(), genie::PDGLibrary::Instance(), genie::pdg::IsIon(), LOG, pERROR, and genie::utils::str::Split().

Referenced by Configure(), and Configure().

Shift() [1/2]

double QvalueShifter::Shift ( const Interaction & interaction ) const

virtual

Definition at line 67 of file QvalueShifter.cxx.

                                                                     {
    // This function allows the flexibility to add shift as a function of 
    // the interaction type.
    // Right now, we just call the default :
    return Shift( interaction.InitState().Tgt() ) ;    
  } 

References genie::Interaction::InitState(), Shift(), and genie::InitialState::Tgt().

Shift() [2/2]

double QvalueShifter::Shift ( const Target & target ) const

virtual

Definition at line 51 of file QvalueShifter.cxx.

                                                           {
    // Get Target pdg
    int pdg_target = target.Pdg() ;
 
    const auto it = fRelShift.find(pdg_target) ;
    if ( it != fRelShift.end() ) {
      return it -> second ;
    } else {
      // return default 
      return fRelShiftDefault ;
    }
 
  } 

References fRelShift, fRelShiftDefault, and genie::Target::Pdg().

Referenced by Shift().

Member Data Documentation

fRelShift

std::map<int,double> genie::QvalueShifter::fRelShift

private

Definition at line 49 of file QvalueShifter.h.

Referenced by LoadConfig(), and Shift().

fRelShiftDefault

double genie::QvalueShifter::fRelShiftDefault

private

Definition at line 48 of file QvalueShifter.h.

Referenced by LoadConfig(), and Shift().

---

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

• QvalueShifter.h
• QvalueShifter.cxx