Abstract class for computing the differential cross section of the XXX. More...

Inheritance diagram for PARTONS::GAM2ProcessModule:

Public Member Functions
virtual	~GAM2ProcessModule ()
	Destructor. More...

virtual GAM2ProcessModule *	clone () const =0
	Virtual clone function to allow the factory to clone all derived members object stored in the BaseObjectRegistry. 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	configure (const ElemUtils::Parameters &parameters)
	Provides a generic method to configure all types of modules by passing a Parameters object. More...

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 List< GPDType >	getListOfAvailableGPDTypeForComputation () const
	Must be implemented in child class. More...

virtual GAM2ObservableResult	compute (PolarizationType::Type polG0, PolarizationType::Type polG1, PolarizationType::Type polG2, NumA::Vector3D targetPolarization, const GAM2ObservableKinematic &kinematic, const List< GPDType > &gpdType=List< GPDType >())
	Computes the differential cross-section. More...

virtual void	resetPreviousKinematic ()
	Reset previous kinematics. More...

bool	isPreviousCCFKinematicDifferent (const GAM2ConvolCoeffFunctionKinematic &kinematic) const
	Check if this kinematics is different than the previous one. More...

GAM2ScalesModule *	getScaleModule () const
	Get scale module. More...

void	setScaleModule (GAM2ScalesModule *pScaleModule)
	Set scale module. More...

GAM2XiConverterModule *	getXiConverterModule () const
	Get xi converter module. More...

void	setXiConverterModule (GAM2XiConverterModule *pXiConverterModule)
	Set xi converted module. More...

GAM2ConvolCoeffFunctionModule *	getConvolCoeffFunctionModule () const
	Get CCF module;. More...

void	setConvolCoeffFunctionModule (GAM2ConvolCoeffFunctionModule *pConvolCoeffFunctionModule)
	Set CCF module. More...

virtual PhysicalType< double >	CrossSection ()
	Differential cross section. More...

void	setConvolCoeffFunction (const GAM2ConvolCoeffFunctionKinematic &kin, const GAM2ConvolCoeffFunctionResult &result)
	Set manually CFFs. More...

Public Member Functions inherited from PARTONS::ProcessModule< GAM2ObservableKinematic, GAM2ObservableResult >
virtual	~ProcessModule ()
	Destructor. More...

bool	isCCFModuleDependent () const
	Check if this process module depends on a CCF module. More...

void	setIsCCFModuleDependent (bool isCCFModuleDependent)
	Set if this process module depends on a CCF 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)

Static Public Attributes
static const std::string	GAM2_PROCESS_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"

Protected Member Functions
	GAM2ProcessModule (const std::string &className)
	Default constructor. More...

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

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

virtual void	setExperimentalConditions (PolarizationType::Type polG0, PolarizationType::Type polG1, PolarizationType::Type polG2, NumA::Vector3D targetPolarization)

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...

void	computeConvolCoeffFunction (const GAM2ObservableKinematic &kinematic, const List< GPDType > &gpdType=List< GPDType >())
	Compute CCF for a given kinematics. More...

std::complex< double >	getConvolCoeffFunctionValue (GPDType::Type gpdType)
	Gives back a previously computed Compton Form Factor. More...

Protected Member Functions inherited from PARTONS::ProcessModule< GAM2ObservableKinematic, GAM2ObservableResult >
	ProcessModule (const std::string &className, ChannelType::Type channelType)
	Constructor. More...

	ProcessModule (const ProcessModule &other)
	Copy constructor. 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 Attributes
double	m_t
	Four-momentum transfer squared of hadron target (in \(GeV^{2}\)). More...

double	m_uPrim
	F our-momentum transfer squared to photon (in \(GeV^{2}\)). More...

double	m_Mgg2
	Invariant mass of two photons (in \(GeV^{2}\)). More...

double	m_E
	Beam energy (in GeV). More...

double	m_phi
	Linear polarization angle. More...

double	m_tmin
	t min; More...

double	m_xi
	xi; More...

PolarizationType::Type	m_polG0
	Polarization of incoming photon. More...

PolarizationType::Type	m_polG1
	Polarization of first outgoing photon. More...

PolarizationType::Type	m_polG2
	Polarization of second outgoing photon. More...

NumA::Vector3D	m_targetPolarization
	Target polarization. More...

GAM2ScalesModule *	m_pScaleModule
	Pointer to the underlying scale module. More...

GAM2XiConverterModule *	m_pXiConverterModule
	Pointer to the underlying xi converter module. More...

GAM2ConvolCoeffFunctionModule *	m_pConvolCoeffFunctionModule
	Pointer to the underlying CCF module. More...

GAM2ConvolCoeffFunctionResult	m_dvcsConvolCoeffFunctionResult
	Stored Compton Form Factor result. More...

GAM2ConvolCoeffFunctionKinematic	m_lastCCFKinematics
	Last Compton Form Factor kinematics. More...

Protected Attributes inherited from PARTONS::ProcessModule< GAM2ObservableKinematic, GAM2ObservableResult >
bool	m_isCCFModuleDependent
	Boolean (true if this Process module depends on a CCF module). More...

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

Detailed Description

Abstract class for computing the differential cross section of the XXX.

The cross-section is five-fold differential with respect to the variables: \( x_B \), \( Q^2 \), \( t \) and the two angles. XXX

Constructor & Destructor Documentation

◆ ~GAM2ProcessModule()

PARTONS::GAM2ProcessModule::~GAM2ProcessModule ( )

virtual

Destructor.

◆ GAM2ProcessModule() [1/2]

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

protected

Default constructor.

◆ GAM2ProcessModule() [2/2]

PARTONS::GAM2ProcessModule::GAM2ProcessModule ( const GAM2ProcessModule & other )

protected

Copy constructor.

Parameters

other Object to be copied.

Member Function Documentation

◆ clone()

virtual GAM2ProcessModule* PARTONS::GAM2ProcessModule::clone ( ) const

pure virtual

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

Returns

Implements PARTONS::ProcessModule< GAM2ObservableKinematic, GAM2ObservableResult >.

Implemented in PARTONS::GAM2ProcessGPSSW21.

◆ compute()

GAM2ObservableResult PARTONS::GAM2ProcessModule::compute	(	PolarizationType::Type	polG0,
		PolarizationType::Type	polG1,
		PolarizationType::Type	polG2,
		NumA::Vector3D	targetPolarization,
		const GAM2ObservableKinematic &	kinematic,
		const List< GPDType > &	gpdType = `List<GPDType>()`
	)

virtual

Computes the differential cross-section.

Must be implemented in the child class.

◆ computeConvolCoeffFunction()

void PARTONS::GAM2ProcessModule::computeConvolCoeffFunction	(	const GAM2ObservableKinematic &	kinematic,
		const List< GPDType > &	gpdType = `List<GPDType>()`
	)

protected

Compute CCF for a given kinematics.

Parameters

kinematic	Kinematics to be computed.
gpdType	List of GPD types to be computed.

◆ configure()

void PARTONS::GAM2ProcessModule::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::ProcessModule< GAM2ObservableKinematic, GAM2ObservableResult >.

◆ CrossSection()

PhysicalType< double > PARTONS::GAM2ProcessModule::CrossSection ( )

virtual

Differential cross section.

Reimplemented in PARTONS::GAM2ProcessGPSSW21.

◆ getConvolCoeffFunctionModule()

GAM2ConvolCoeffFunctionModule * PARTONS::GAM2ProcessModule::getConvolCoeffFunctionModule ( ) const

Get CCF module;.

◆ getConvolCoeffFunctionValue()

std::complex< double > PARTONS::GAM2ProcessModule::getConvolCoeffFunctionValue ( GPDType::Type gpdType )

protected

Gives back a previously computed Compton Form Factor.

Parameters

gpdType CFF type (e.g. H or E).

Returns: CFF value for the given type.

◆ getListOfAvailableGPDTypeForComputation()

List< GPDType > PARTONS::GAM2ProcessModule::getListOfAvailableGPDTypeForComputation ( ) const

virtual

Must be implemented in child class.

Returns: List of GPD/CCF types the child class can compute.

Implements PARTONS::ProcessModule< GAM2ObservableKinematic, GAM2ObservableResult >.

◆ getScaleModule()

GAM2ScalesModule * PARTONS::GAM2ProcessModule::getScaleModule ( ) const

Get scale module.

◆ getXiConverterModule()

GAM2XiConverterModule * PARTONS::GAM2ProcessModule::getXiConverterModule ( ) const

Get xi converter module.

◆ initModule()

void PARTONS::GAM2ProcessModule::initModule ( )

protectedvirtual

Pure virtual function that provides skeleton for module initialization.

Children must define and override it.

Reimplemented from PARTONS::ProcessModule< GAM2ObservableKinematic, GAM2ObservableResult >.

Reimplemented in PARTONS::GAM2ProcessGPSSW21.

◆ isModuleWellConfigured()

void PARTONS::GAM2ProcessModule::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::ProcessModule< GAM2ObservableKinematic, GAM2ObservableResult >.

Reimplemented in PARTONS::GAM2ProcessGPSSW21.

◆ isPreviousCCFKinematicDifferent()

bool PARTONS::GAM2ProcessModule::isPreviousCCFKinematicDifferent ( const GAM2ConvolCoeffFunctionKinematic & kinematic ) const

Check if this kinematics is different than the previous one.

◆ prepareSubModules()

void PARTONS::GAM2ProcessModule::prepareSubModules ( const std::map< std::string, BaseObjectData > & subModulesData )

virtual

Method used in automation to prepare all the modules used by this current module and configure them recursively.

The recursion is linked to the imbrication in XML files.
Can be implemented in the child class if it needs modules not needed by the parent class. But there must be first a call to the parent method.

Parameters

subModulesData Data used to retrieve the needed modules and their configuration.

Reimplemented from PARTONS::ProcessModule< GAM2ObservableKinematic, GAM2ObservableResult >.

◆ resetPreviousKinematic()

void PARTONS::GAM2ProcessModule::resetPreviousKinematic ( )

virtual

Reset previous kinematics.

◆ resolveObjectDependencies()

void PARTONS::GAM2ProcessModule::resolveObjectDependencies ( )

virtual

Because of the initialization step order of the program, objects are registered in a total random order and some objects depend on others.

To avoid the problem of pointer resolution order, this method is called by the BaseObjectRegistery after all objects are well registered in it. See BaseObjectRegistry class documentation for more details.

Reimplemented from PARTONS::ProcessModule< GAM2ObservableKinematic, GAM2ObservableResult >.

◆ run()

void PARTONS::GAM2ProcessModule::run ( )

virtual

Reimplemented from PARTONS::ProcessModule< GAM2ObservableKinematic, GAM2ObservableResult >.

◆ setConvolCoeffFunction()

void PARTONS::GAM2ProcessModule::setConvolCoeffFunction	(	const GAM2ConvolCoeffFunctionKinematic &	kin,
		const GAM2ConvolCoeffFunctionResult &	result
	)

Set manually CFFs.

◆ setConvolCoeffFunctionModule()

void PARTONS::GAM2ProcessModule::setConvolCoeffFunctionModule ( GAM2ConvolCoeffFunctionModule * pConvolCoeffFunctionModule )

Set CCF module.

◆ setExperimentalConditions()

void PARTONS::GAM2ProcessModule::setExperimentalConditions	(	PolarizationType::Type	polG0,
		PolarizationType::Type	polG1,
		PolarizationType::Type	polG2,
		NumA::Vector3D	targetPolarization
	)

protectedvirtual

◆ setKinematics()

void PARTONS::GAM2ProcessModule::setKinematics ( const GAM2ObservableKinematic & kinematic )

protectedvirtual

Set internal kinematics.

Parameters

kinematic Kinematics to be set

Implements PARTONS::ProcessModule< GAM2ObservableKinematic, GAM2ObservableResult >.

◆ setScaleModule()

void PARTONS::GAM2ProcessModule::setScaleModule ( GAM2ScalesModule * pScaleModule )

Set scale module.

◆ setXiConverterModule()

void PARTONS::GAM2ProcessModule::setXiConverterModule ( GAM2XiConverterModule * pXiConverterModule )

Set xi converted module.

◆ toString()

std::string PARTONS::GAM2ProcessModule::toString ( ) const

virtual

Return a pre-formatted characters string for output visualization of class member's values.

Returns: a pre-formatted characters string.

Reimplemented from PARTONS::ProcessModule< GAM2ObservableKinematic, GAM2ObservableResult >.

Member Data Documentation

◆ GAM2_PROCESS_MODULE_CLASS_NAME

const std::string PARTONS::GAM2ProcessModule::GAM2_PROCESS_MODULE_CLASS_NAME

static

Initial value:

=

"GAM2ProcessModule"

Type of the module in XML automation.

◆ m_dvcsConvolCoeffFunctionResult

GAM2ConvolCoeffFunctionResult PARTONS::GAM2ProcessModule::m_dvcsConvolCoeffFunctionResult

protected

Stored Compton Form Factor result.

◆ m_E

double PARTONS::GAM2ProcessModule::m_E

protected

Beam energy (in GeV).

◆ m_lastCCFKinematics

GAM2ConvolCoeffFunctionKinematic PARTONS::GAM2ProcessModule::m_lastCCFKinematics

protected

Last Compton Form Factor kinematics.

◆ m_Mgg2

double PARTONS::GAM2ProcessModule::m_Mgg2

protected

Invariant mass of two photons (in \(GeV^{2}\)).

◆ m_pConvolCoeffFunctionModule

GAM2ConvolCoeffFunctionModule* PARTONS::GAM2ProcessModule::m_pConvolCoeffFunctionModule

protected

Pointer to the underlying CCF module.

◆ m_phi

double PARTONS::GAM2ProcessModule::m_phi

protected

Linear polarization angle.

◆ m_polG0

PolarizationType::Type PARTONS::GAM2ProcessModule::m_polG0

protected

Polarization of incoming photon.

◆ m_polG1

PolarizationType::Type PARTONS::GAM2ProcessModule::m_polG1

protected

Polarization of first outgoing photon.

◆ m_polG2

PolarizationType::Type PARTONS::GAM2ProcessModule::m_polG2

protected

Polarization of second outgoing photon.

◆ m_pScaleModule

GAM2ScalesModule* PARTONS::GAM2ProcessModule::m_pScaleModule

protected

Pointer to the underlying scale module.

◆ m_pXiConverterModule

GAM2XiConverterModule* PARTONS::GAM2ProcessModule::m_pXiConverterModule

protected

Pointer to the underlying xi converter module.

◆ m_t

double PARTONS::GAM2ProcessModule::m_t

protected

Four-momentum transfer squared of hadron target (in \(GeV^{2}\)).

◆ m_targetPolarization

NumA::Vector3D PARTONS::GAM2ProcessModule::m_targetPolarization

protected

Target polarization.

◆ m_tmin

double PARTONS::GAM2ProcessModule::m_tmin

protected

t min;

◆ m_uPrim

double PARTONS::GAM2ProcessModule::m_uPrim

protected

F our-momentum transfer squared to photon (in \(GeV^{2}\)).

◆ m_xi

double PARTONS::GAM2ProcessModule::m_xi

protected

xi;

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

include/partons/modules/process/GAM2/GAM2ProcessModule.h
src/partons/modules/process/GAM2/GAM2ProcessModule.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~GAM2ProcessModule()

◆ GAM2ProcessModule() [1/2]

◆ GAM2ProcessModule() [2/2]

Member Function Documentation

◆ clone()

◆ compute()

◆ computeConvolCoeffFunction()

◆ configure()

◆ CrossSection()

◆ getConvolCoeffFunctionModule()

◆ getConvolCoeffFunctionValue()

◆ getListOfAvailableGPDTypeForComputation()

◆ getScaleModule()

◆ getXiConverterModule()

◆ initModule()

◆ isModuleWellConfigured()

◆ isPreviousCCFKinematicDifferent()

◆ prepareSubModules()

◆ resetPreviousKinematic()

◆ resolveObjectDependencies()

◆ run()

◆ setConvolCoeffFunction()

◆ setConvolCoeffFunctionModule()

◆ setExperimentalConditions()

◆ setKinematics()

◆ setScaleModule()

◆ setXiConverterModule()

◆ toString()

Member Data Documentation

◆ GAM2_PROCESS_MODULE_CLASS_NAME

◆ m_dvcsConvolCoeffFunctionResult

◆ m_E

◆ m_lastCCFKinematics

◆ m_Mgg2

◆ m_pConvolCoeffFunctionModule

◆ m_phi

◆ m_polG0

◆ m_polG1

◆ m_polG2

◆ m_pScaleModule

◆ m_pXiConverterModule

◆ m_t

◆ m_targetPolarization

◆ m_tmin

◆ m_uPrim

◆ m_xi