Module to set CFF values via automation or via configure() function. More...

Inheritance diagram for PARTONS::DVCSCFFConstant:

Public Member Functions
	DVCSCFFConstant (const std::string &className)
	Constructor. More...

virtual DVCSCFFConstant *	clone () const
	Virtual clone function to allow the factory to clone all derived members object stored in the BaseObjectRegistry. More...

virtual	~DVCSCFFConstant ()
	Default destructor. More...

virtual void	configure (const ElemUtils::Parameters &parameters)
	Provides a generic method to configure all types of modules by passing a Parameters object. More...

virtual std::complex< double >	computeCFF ()
	Method to compute some CFFs. More...

const std::map< GPDType::Type, std::complex< double > > &	getCFFs () const
	Get map containing CFFs. More...

void	setCFFs (const std::map< GPDType::Type, std::complex< double > > &cffs)
	Set map containing CFFs. More...

const std::complex< double > &	getCFF (GPDType::Type gpdType) const
	Get specific CFF. More...

void	setCFF (GPDType::Type gpdType, const std::complex< double > &cff)
	Set specific CFF. More...

Public Member Functions inherited from PARTONS::DVCSConvolCoeffFunctionModule
virtual	~DVCSConvolCoeffFunctionModule ()
	Destructor. More...

virtual std::string	toString () const
	Return a pre-formatted characters string for output visualization of class member's values. More...

virtual void	resolveObjectDependencies ()
	Because of the initialization step order of the program, objects are registered in a total random order and some objects depend on others. More...

virtual void	run ()

virtual void	prepareSubModules (const std::map< std::string, BaseObjectData > &subModulesData)
	Method used in automation to prepare all the modules used by this current module and configure them recursively. More...

virtual DVCSConvolCoeffFunctionResult	compute (const DVCSConvolCoeffFunctionKinematic &kinematic, const List< GPDType > &gpdType=List< GPDType >())
	Computes the coefficient functions at given kinematics. More...

virtual List< GPDType >	getListOfAvailableGPDTypeForComputation () const
	Must be implemented in child class. More...

PerturbativeQCDOrderType::Type	getQCDOrderType () const
	Get order of the perturbative QCD computation. More...

void	setQCDOrderType (PerturbativeQCDOrderType::Type qcdOrderType)
	Set order of the perturbative QCD computation. More...

virtual std::complex< double >	computeUnpolarized ()
	Method to compute some CFFs. More...

virtual std::complex< double >	computePolarized ()
	Method to compute some CFFs. More...

Public Member Functions inherited from PARTONS::ConvolCoeffFunctionModule< DVCSConvolCoeffFunctionKinematic, DVCSConvolCoeffFunctionResult >
virtual	~ConvolCoeffFunctionModule ()
	Destructor. More...

GPDModule *	getGPDModule () const
	Get pointer to the underlying GPD module. More...

void	setGPDModule (GPDModule *gpdModule)
	Set pointer to the underlying GPD module. More...

bool	isGPDModuleDependent () const
	True if this CCF module depends on a GPD module. More...

void	setIsGPDModuleDependent (bool isGPDModuleDependent)
	True if this CCF module depends on a GPD module. More...

Public Member Functions inherited from PARTONS::ModuleObject
	ModuleObject (const std::string &className, ChannelType::Type channelType)
	Constructor. More...

virtual	~ModuleObject ()
	Default destructor. More...

unsigned int	getReferenceModuleId () const
	Get reference module id. More...

void	setReferenceModuleId (unsigned int referenceModuleId)
	Set reference module id. More...

ChannelType::Type	getChannelType () const
	Get channel type. More...

Public Member Functions inherited from PARTONS::BaseObject
	BaseObject (const std::string &className)
	Constructor. More...

virtual	~BaseObject ()
	Default destructor. More...

void	serialize (ElemUtils::Packet &packet) const
	Used to split a complex C++ object into a concatenation of simple types. More...

void	unserialize (ElemUtils::Packet &packet)
	Used to rebuild a complex C++ object from a concatenation of simple type. More...

bool	operator< (const BaseObject &other) const
	Overload of < operator to sort BaseObject object by its indexId value. More...

const std::string &	getClassName () const

unsigned int	getObjectId () const

int	getIndexId () const

void	setIndexId (int indexId)

Public Member Functions inherited from PARTONS::MathIntegratorModule
	MathIntegratorModule ()
	Default constructor. More...

virtual	~MathIntegratorModule ()
	Default destructor. More...

Static Public Attributes
static const unsigned int	classId
	Unique ID to automatically register the class in the registry. More...

static const std::string	PARAMETER_NAME_CFF_VALUES = "cff_values"
	Key name to set several CFFs via automation. More...

static const std::string	PARAMETER_NAME_CFF_H_Re = "cff_value_H_Re"
	Key name to set real part of CFF H via automation. More...

static const std::string	PARAMETER_NAME_CFF_H_Im = "cff_value_H_Im"
	Key name to set imaginary part of CFF H via automation. More...

static const std::string	PARAMETER_NAME_CFF_E_Re = "cff_value_E_Re"
	Key name to set real part of CFF E via automation. More...

static const std::string	PARAMETER_NAME_CFF_E_Im = "cff_value_E_Im"
	Key name to set imaginary part of CFF E via automation. More...

static const std::string	PARAMETER_NAME_CFF_Ht_Re = "cff_value_Ht_Re"
	Key name to set real part of CFF Ht via automation. More...

static const std::string	PARAMETER_NAME_CFF_Ht_Im = "cff_value_Ht_Im"
	Key name to set imaginary part of CFF Ht via automation. More...

static const std::string	PARAMETER_NAME_CFF_Et_Re = "cff_value_Et_Re"
	Key name to set real part of CFF Et via automation. More...

static const std::string	PARAMETER_NAME_CFF_Et_Im = "cff_value_Et_Im"
	Key name to set imaginary part of CFF Et via automation. More...

Static Public Attributes inherited from PARTONS::DVCSConvolCoeffFunctionModule
static const std::string	DVCS_CONVOL_COEFF_FUNCTION_MODULE_CLASS_NAME
	Type of the module in XML automation. More...

Static Public Attributes inherited from PARTONS::ModuleObject
static const std::string	CLASS_NAME = "className"

Static Public Attributes inherited from PARTONS::MathIntegratorModule
static const std::string	PARAM_NAME_INTEGRATOR_TYPE
	Parameter used in configureIntegrator() or XML automation to set the type of integrator. More...

Protected Member Functions
	DVCSCFFConstant (const DVCSCFFConstant &other)
	Copy constructor. More...

virtual void	initModule ()
	Pure virtual function that provides skeleton for module initialization. More...

virtual void	isModuleWellConfigured ()
	Pure virtual function that provides skeleton to check if the module is well initialized and configured. More...

Protected Member Functions inherited from PARTONS::DVCSConvolCoeffFunctionModule
	DVCSConvolCoeffFunctionModule (const std::string &className)
	Default constructor. More...

	DVCSConvolCoeffFunctionModule (const DVCSConvolCoeffFunctionModule &other)
	Copy constructor. More...

virtual void	setKinematics (const DVCSConvolCoeffFunctionKinematic &kinematic)
	Set internal kinematics. More...

Protected Member Functions inherited from PARTONS::ConvolCoeffFunctionModule< DVCSConvolCoeffFunctionKinematic, DVCSConvolCoeffFunctionResult >
	ConvolCoeffFunctionModule (const std::string &className, ChannelType::Type channelType)
	Constructor. More...

	ConvolCoeffFunctionModule (const ConvolCoeffFunctionModule &other)
	Copy constructor. More...

void	setCurrentGPDType (GPDType::Type gpdType)
	Set current GPD type to be computed. More...

Protected Member Functions inherited from PARTONS::ModuleObject
	ModuleObject (const ModuleObject &other)

Protected Member Functions inherited from PARTONS::BaseObject
	BaseObject (const BaseObject &other)
	Copy constructor. More...

void	info (const std::string &functionName, const std::string &message) const
	Print info message into logger. More...

void	debug (const std::string &functionName, const std::string &message) const
	Print debug message into logger. More...

void	warn (const std::string &functionName, const std::string &message) const
	Print warning message into logger. More...

void	errorMissingParameter (const std::string &parameterName) const
	Use in automation process to throw exception when a parameter is missing from the XML scenario file. More...

Protected Member Functions inherited from PARTONS::MathIntegratorModule
	MathIntegratorModule (const MathIntegratorModule &other)
	Copy constructor. More...

void	setIntegrator (NumA::IntegratorType1D::Type integratorType)
	Sets a given integrator available in NumA++. More...

double	integrate (NumA::FunctionType1D *pFunction, double a, double b, std::vector< double > &parameters)
	Computes the integral of a function defined via a functor. More...

void	configureIntegrator (const ElemUtils::Parameters &parameters)
	Provides a generic method to configure all types of integration routines by passing a Parameters object. More...

NumA::Integrator1D *	getMathIntegrator ()

Private Member Functions
void	printErrorInConfigure (const std::string &key) const
	Print error in configure in case of setting CFFs via ambiguous keys. More...

void	configureValue (GPDType::Type gpdType, bool isRealPart, const ElemUtils::GenericType &value)
	Set single value in configure. More...

Private Attributes
std::map< GPDType::Type, std::complex< double > >	m_CFFs
	CFFs stored by type of GPD. More...

Additional Inherited Members
Protected Attributes inherited from PARTONS::ConvolCoeffFunctionModule< DVCSConvolCoeffFunctionKinematic, DVCSConvolCoeffFunctionResult >
double	m_xi
	Skewness. More...

double	m_t
	Mandelstam variable, momentum transfer on the hadron target (in GeV^2). More...

double	m_MuF2
	Factorization scale (in GeV^2). More...

double	m_MuR2
	Renormalization scale (in GeV^2) More...

GPDType::Type	m_currentGPDComputeType
	GPDType of the current CFF computation. More...

GPDModule *	m_pGPDModule
	Pointer to the underlying GPD module. More...

bool	m_isGPDModuleDependent
	Boolean (true if this CCF module depends on a GPD module). More...

Protected Attributes inherited from PARTONS::ModuleObject
ModuleObjectFactory *	m_pModuleObjectFactory
	Pointer tp module object factory. More...

Detailed Description

Module to set CFF values via automation or via configure() function.

Constructor & Destructor Documentation

◆ DVCSCFFConstant() [1/2]

PARTONS::DVCSCFFConstant::DVCSCFFConstant ( const std::string & className )

Constructor.

See BaseObject::BaseObject and ModuleObject::ModuleObject for more details.

Parameters

className Name of last child class.

◆ ~DVCSCFFConstant()

PARTONS::DVCSCFFConstant::~DVCSCFFConstant ( )

virtual

Default destructor.

◆ DVCSCFFConstant() [2/2]

PARTONS::DVCSCFFConstant::DVCSCFFConstant ( const DVCSCFFConstant & other )

protected

Copy constructor.

Parameters

other Object to be copied.

Member Function Documentation

◆ clone()

DVCSCFFConstant * PARTONS::DVCSCFFConstant::clone ( ) const

virtual

Virtual clone function to allow the factory to clone all derived members object stored in the BaseObjectRegistry.

Returns

Implements PARTONS::DVCSConvolCoeffFunctionModule.

◆ computeCFF()

std::complex< double > PARTONS::DVCSCFFConstant::computeCFF ( )

virtual

Method to compute some CFFs.

Can be implemented and used in child class, if needed.

Returns: Complex result.

Reimplemented from PARTONS::DVCSConvolCoeffFunctionModule.

◆ configure()

void PARTONS::DVCSCFFConstant::configure ( const ElemUtils::Parameters & parameters )

virtual

Provides a generic method to configure all types of modules by passing a Parameters object.

Parameters class represents a list of couples key/value (see Parameters class documentation for more info).

Parameters

parameters ElemUtils::Parameters object.

Reimplemented from PARTONS::DVCSConvolCoeffFunctionModule.

◆ configureValue()

void PARTONS::DVCSCFFConstant::configureValue	(	GPDType::Type	gpdType,
		bool	isRealPart,
		const ElemUtils::GenericType &	value
	)

private

Set single value in configure.

Parameters

gpdType	CFF type to be set.
isRealPart	True if real part to be set.
value	Value to be set.

◆ getCFF()

const std::complex< double > & PARTONS::DVCSCFFConstant::getCFF ( GPDType::Type gpdType ) const

Get specific CFF.

Parameters

gpdType Type of CFF to be get.

◆ getCFFs()

const std::map< GPDType::Type, std::complex< double > > & PARTONS::DVCSCFFConstant::getCFFs ( ) const

Get map containing CFFs.

◆ initModule()

void PARTONS::DVCSCFFConstant::initModule ( )

protectedvirtual

Pure virtual function that provides skeleton for module initialization.

Children must define and override it.

Reimplemented from PARTONS::DVCSConvolCoeffFunctionModule.

◆ isModuleWellConfigured()

void PARTONS::DVCSCFFConstant::isModuleWellConfigured ( )

protectedvirtual

Pure virtual function that provides skeleton to check if the module is well initialized and configured.

Children must define and override it.

Reimplemented from PARTONS::DVCSConvolCoeffFunctionModule.

◆ printErrorInConfigure()

void PARTONS::DVCSCFFConstant::printErrorInConfigure ( const std::string & key ) const

private

Print error in configure in case of setting CFFs via ambiguous keys.

Parameters

key	Name of key to help localize error.

◆ setCFF()

void PARTONS::DVCSCFFConstant::setCFF	(	GPDType::Type	gpdType,
		const std::complex< double > &	cff
	)

Set specific CFF.

Parameters

gpdType	Type of CFF to be set.
cff	CFF to be set.

◆ setCFFs()

void PARTONS::DVCSCFFConstant::setCFFs ( const std::map< GPDType::Type, std::complex< double > > & cffs )

Set map containing CFFs.

Parameters

cffs	Map to be set.

Member Data Documentation

◆ classId

const unsigned int PARTONS::DVCSCFFConstant::classId

static

Initial value:

=
        BaseObjectRegistry::getInstance()->registerBaseObject(
                new DVCSCFFConstant("DVCSCFFConstant"))

Unique ID to automatically register the class in the registry.

◆ m_CFFs

std::map<GPDType::Type, std::complex<double> > PARTONS::DVCSCFFConstant::m_CFFs

private

CFFs stored by type of GPD.

See GPDType.

◆ PARAMETER_NAME_CFF_E_Im

const std::string PARTONS::DVCSCFFConstant::PARAMETER_NAME_CFF_E_Im = "cff_value_E_Im"

static

Key name to set imaginary part of CFF E via automation.

◆ PARAMETER_NAME_CFF_E_Re

const std::string PARTONS::DVCSCFFConstant::PARAMETER_NAME_CFF_E_Re = "cff_value_E_Re"

static

Key name to set real part of CFF E via automation.

◆ PARAMETER_NAME_CFF_Et_Im

const std::string PARTONS::DVCSCFFConstant::PARAMETER_NAME_CFF_Et_Im = "cff_value_Et_Im"

static

Key name to set imaginary part of CFF Et via automation.

◆ PARAMETER_NAME_CFF_Et_Re

const std::string PARTONS::DVCSCFFConstant::PARAMETER_NAME_CFF_Et_Re = "cff_value_Et_Re"

static

Key name to set real part of CFF Et via automation.

◆ PARAMETER_NAME_CFF_H_Im

const std::string PARTONS::DVCSCFFConstant::PARAMETER_NAME_CFF_H_Im = "cff_value_H_Im"

static

Key name to set imaginary part of CFF H via automation.

◆ PARAMETER_NAME_CFF_H_Re

const std::string PARTONS::DVCSCFFConstant::PARAMETER_NAME_CFF_H_Re = "cff_value_H_Re"

static

Key name to set real part of CFF H via automation.

◆ PARAMETER_NAME_CFF_Ht_Im

const std::string PARTONS::DVCSCFFConstant::PARAMETER_NAME_CFF_Ht_Im = "cff_value_Ht_Im"

static

Key name to set imaginary part of CFF Ht via automation.

◆ PARAMETER_NAME_CFF_Ht_Re

const std::string PARTONS::DVCSCFFConstant::PARAMETER_NAME_CFF_Ht_Re = "cff_value_Ht_Re"

static

Key name to set real part of CFF Ht via automation.

◆ PARAMETER_NAME_CFF_VALUES

const std::string PARTONS::DVCSCFFConstant::PARAMETER_NAME_CFF_VALUES = "cff_values"

static

Key name to set several CFFs via automation.

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

include/partons/modules/convol_coeff_function/DVCS/DVCSCFFConstant.h
src/partons/modules/convol_coeff_function/DVCS/DVCSCFFConstant.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DVCSCFFConstant() [1/2]

◆ ~DVCSCFFConstant()

◆ DVCSCFFConstant() [2/2]

Member Function Documentation

◆ clone()

◆ computeCFF()

◆ configure()

◆ configureValue()

◆ getCFF()

◆ getCFFs()

◆ initModule()

◆ isModuleWellConfigured()

◆ printErrorInConfigure()

◆ setCFF()

◆ setCFFs()

Member Data Documentation

◆ classId

◆ m_CFFs

◆ PARAMETER_NAME_CFF_E_Im

◆ PARAMETER_NAME_CFF_E_Re

◆ PARAMETER_NAME_CFF_Et_Im

◆ PARAMETER_NAME_CFF_Et_Re

◆ PARAMETER_NAME_CFF_H_Im

◆ PARAMETER_NAME_CFF_H_Re

◆ PARAMETER_NAME_CFF_Ht_Im

◆ PARAMETER_NAME_CFF_Ht_Re

◆ PARAMETER_NAME_CFF_VALUES