PARTONS  
PARtonic Tomography Of Nucleon Software
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
PARTONS::TCSProcessModule Class Referenceabstract

Abstract class for computing the differential cross section of the photon electroproduction process (also called TCS; Deeply Virtual Compton Scattering). More...

Inheritance diagram for PARTONS::TCSProcessModule:
PARTONS::ProcessModule< TCSObservableKinematic, TCSObservableResult > PARTONS::ModuleObject PARTONS::BaseObject PARTONS::TCSProcessBDP01 PARTONS::TCSProcessBDPGW19

Public Member Functions

virtual ~TCSProcessModule ()
 Destructor. More...
 
virtual TCSProcessModuleclone () 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 TCSObservableResult compute (double beamPolarization, NumA::Vector3D targetPolarization, const TCSObservableKinematic &kinematic, const List< GPDType > &gpdType=List< GPDType >())
 
virtual List< GPDTypegetListOfAvailableGPDTypeForComputation () const
 Must be implemented in child class. More...
 
TCSObservableResult compute (double beamPolarization, NumA::Vector3D targetPolarization, const TCSObservableKinematic &kinematic, const List< GPDType > &gpdType, VCSSubProcessType::Type processType)
 Computes the differential cross-section. More...
 
virtual void resetPreviousKinematic ()
 Reset previous kinematics. More...
 
bool isPreviousCCFKinematicDifferent (const TCSConvolCoeffFunctionKinematic &kinematic) const
 Check if this kinematics is different than the previous one. More...
 
TCSScalesModulegetScaleModule () const
 Get scale module. More...
 
void setScaleModule (TCSScalesModule *pScaleModule)
 Set scale module. More...
 
TCSXiConverterModulegetXiConverterModule () const
 Get xi converter module. More...
 
void setXiConverterModule (TCSXiConverterModule *pXiConverterModule)
 Set xi converted module. More...
 
TCSConvolCoeffFunctionModulegetConvolCoeffFunctionModule () const
 Get CCF module;. More...
 
void setConvolCoeffFunctionModule (TCSConvolCoeffFunctionModule *pConvolCoeffFunctionModule)
 Set CCF module. More...
 
virtual PhysicalType< double > CrossSectionBH ()
 Bethe-Heitler differential cross section. More...
 
virtual PhysicalType< double > CrossSectionVCS ()
 Virtual Compton Scattering differential cross section. More...
 
virtual PhysicalType< double > CrossSectionInterf ()
 Interference differential cross section. More...
 
void setConvolCoeffFunction (const TCSConvolCoeffFunctionKinematic &kin, const TCSConvolCoeffFunctionResult &result)
 Set manually CFFs. More...
 
- Public Member Functions inherited from PARTONS::ProcessModule< TCSObservableKinematic, TCSObservableResult >
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 TCS_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

 TCSProcessModule (const std::string &className)
 Default constructor. More...
 
 TCSProcessModule (const TCSProcessModule &other)
 Copy constructor. More...
 
virtual void setKinematics (const TCSObservableKinematic &kinematic)
 Set internal kinematics. More...
 
virtual void setExperimentalConditions (double beamPolarization, 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 TCSObservableKinematic &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< TCSObservableKinematic, TCSObservableResult >
 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
 Mandelstam variable (square of the 4-momentum transferm in GeV2). More...
 
double m_Q2Prim
 Virtuality of the incoming photon (in GeV2). More...
 
double m_E
 Beam energy in target rest frame (in GeV). More...
 
double m_phi
 Angle between leptonic and hadronic plane (in radians, Trento convention). More...
 
double m_theta
 Angle between positively charged lepton and scattered proton in lepton CMS (in degrees). More...
 
double m_beamPolarization
 Beam polarization. More...
 
NumA::Vector3D m_targetPolarization
 Target polarization. More...
 
double m_tmin
 Minimal value of t. More...
 
double m_tmax
 Maximal value of t. More...
 
TCSScalesModulem_pScaleModule
 Pointer to the underlying scale module. More...
 
TCSXiConverterModulem_pXiConverterModule
 Pointer to the underlying xi converter module. More...
 
TCSConvolCoeffFunctionModulem_pConvolCoeffFunctionModule
 Pointer to the underlying CCF module. More...
 
TCSConvolCoeffFunctionResult m_dvcsConvolCoeffFunctionResult
 Stored Compton Form Factor result. More...
 
TCSConvolCoeffFunctionKinematic m_lastCCFKinematics
 Last Compton Form Factor kinematics. More...
 
- Protected Attributes inherited from PARTONS::ProcessModule< TCSObservableKinematic, TCSObservableResult >
bool m_isCCFModuleDependent
 Boolean (true if this Process module depends on a CCF module). More...
 
- Protected Attributes inherited from PARTONS::ModuleObject
ModuleObjectFactorym_pModuleObjectFactory
 Pointer tp module object factory. More...
 

Detailed Description

Abstract class for computing the differential cross section of the photon electroproduction process (also called TCS; Deeply Virtual Compton Scattering).

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

Constructor & Destructor Documentation

◆ ~TCSProcessModule()

PARTONS::TCSProcessModule::~TCSProcessModule ( )
virtual

Destructor.

◆ TCSProcessModule() [1/2]

PARTONS::TCSProcessModule::TCSProcessModule ( const std::string &  className)
protected

Default constructor.

◆ TCSProcessModule() [2/2]

PARTONS::TCSProcessModule::TCSProcessModule ( const TCSProcessModule other)
protected

Copy constructor.

Parameters
otherObject to be copied.

Member Function Documentation

◆ clone()

virtual TCSProcessModule* PARTONS::TCSProcessModule::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< TCSObservableKinematic, TCSObservableResult >.

Implemented in PARTONS::TCSProcessBDPGW19, and PARTONS::TCSProcessBDP01.

◆ compute() [1/2]

TCSObservableResult PARTONS::TCSProcessModule::compute ( double  beamPolarization,
NumA::Vector3D  targetPolarization,
const TCSObservableKinematic kinematic,
const List< GPDType > &  gpdType,
VCSSubProcessType::Type  processType 
)

Computes the differential cross-section.

Must be implemented in the child class.

Parameters
beamHelicityHelicity of the beam (in units of hbar/2).
beamChargeCharge of the beam (in units of positron charge).
targetPolarizationPolarization of the target. In GV conventions.
kinematicKinematics.
processTypeSubprocess type.
Returns
Result.

◆ compute() [2/2]

TCSObservableResult PARTONS::TCSProcessModule::compute ( double  beamPolarization,
NumA::Vector3D  targetPolarization,
const TCSObservableKinematic kinematic,
const List< GPDType > &  gpdType = List<GPDType>() 
)
virtual

◆ computeConvolCoeffFunction()

void PARTONS::TCSProcessModule::computeConvolCoeffFunction ( const TCSObservableKinematic kinematic,
const List< GPDType > &  gpdType = List<GPDType>() 
)
protected

Compute CCF for a given kinematics.

Parameters
kinematicKinematics to be computed.
gpdTypeList of GPD types to be computed.

◆ configure()

void PARTONS::TCSProcessModule::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
parametersElemUtils::Parameters object.

Reimplemented from PARTONS::ProcessModule< TCSObservableKinematic, TCSObservableResult >.

◆ CrossSectionBH()

PhysicalType< double > PARTONS::TCSProcessModule::CrossSectionBH ( )
virtual

Bethe-Heitler differential cross section.

Reimplemented in PARTONS::TCSProcessBDPGW19, and PARTONS::TCSProcessBDP01.

◆ CrossSectionInterf()

PhysicalType< double > PARTONS::TCSProcessModule::CrossSectionInterf ( )
virtual

Interference differential cross section.

Reimplemented in PARTONS::TCSProcessBDPGW19, and PARTONS::TCSProcessBDP01.

◆ CrossSectionVCS()

PhysicalType< double > PARTONS::TCSProcessModule::CrossSectionVCS ( )
virtual

Virtual Compton Scattering differential cross section.

Reimplemented in PARTONS::TCSProcessBDPGW19, and PARTONS::TCSProcessBDP01.

◆ getConvolCoeffFunctionModule()

TCSConvolCoeffFunctionModule * PARTONS::TCSProcessModule::getConvolCoeffFunctionModule ( ) const

Get CCF module;.

◆ getConvolCoeffFunctionValue()

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

Gives back a previously computed Compton Form Factor.

Parameters
gpdTypeCFF type (e.g. H or E).
Returns
CFF value for the given type.

◆ getListOfAvailableGPDTypeForComputation()

List< GPDType > PARTONS::TCSProcessModule::getListOfAvailableGPDTypeForComputation ( ) const
virtual

Must be implemented in child class.

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

Implements PARTONS::ProcessModule< TCSObservableKinematic, TCSObservableResult >.

◆ getScaleModule()

TCSScalesModule * PARTONS::TCSProcessModule::getScaleModule ( ) const

Get scale module.

◆ getXiConverterModule()

TCSXiConverterModule * PARTONS::TCSProcessModule::getXiConverterModule ( ) const

Get xi converter module.

◆ initModule()

void PARTONS::TCSProcessModule::initModule ( )
protectedvirtual

Pure virtual function that provides skeleton for module initialization.

Children must define and override it.

Reimplemented from PARTONS::ProcessModule< TCSObservableKinematic, TCSObservableResult >.

Reimplemented in PARTONS::TCSProcessBDP01.

◆ isModuleWellConfigured()

void PARTONS::TCSProcessModule::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< TCSObservableKinematic, TCSObservableResult >.

Reimplemented in PARTONS::TCSProcessBDPGW19, and PARTONS::TCSProcessBDP01.

◆ isPreviousCCFKinematicDifferent()

bool PARTONS::TCSProcessModule::isPreviousCCFKinematicDifferent ( const TCSConvolCoeffFunctionKinematic kinematic) const

Check if this kinematics is different than the previous one.

◆ prepareSubModules()

void PARTONS::TCSProcessModule::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
subModulesDataData used to retrieve the needed modules and their configuration.

Reimplemented from PARTONS::ProcessModule< TCSObservableKinematic, TCSObservableResult >.

◆ resetPreviousKinematic()

void PARTONS::TCSProcessModule::resetPreviousKinematic ( )
virtual

Reset previous kinematics.

◆ resolveObjectDependencies()

void PARTONS::TCSProcessModule::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< TCSObservableKinematic, TCSObservableResult >.

◆ run()

void PARTONS::TCSProcessModule::run ( )
virtual

◆ setConvolCoeffFunction()

void PARTONS::TCSProcessModule::setConvolCoeffFunction ( const TCSConvolCoeffFunctionKinematic kin,
const TCSConvolCoeffFunctionResult result 
)

Set manually CFFs.

◆ setConvolCoeffFunctionModule()

void PARTONS::TCSProcessModule::setConvolCoeffFunctionModule ( TCSConvolCoeffFunctionModule pConvolCoeffFunctionModule)

Set CCF module.

◆ setExperimentalConditions()

void PARTONS::TCSProcessModule::setExperimentalConditions ( double  beamPolarization,
NumA::Vector3D  targetPolarization 
)
protectedvirtual

◆ setKinematics()

void PARTONS::TCSProcessModule::setKinematics ( const TCSObservableKinematic kinematic)
protectedvirtual

Set internal kinematics.

Parameters
kinematicKinematics to be set

Implements PARTONS::ProcessModule< TCSObservableKinematic, TCSObservableResult >.

◆ setScaleModule()

void PARTONS::TCSProcessModule::setScaleModule ( TCSScalesModule pScaleModule)

Set scale module.

◆ setXiConverterModule()

void PARTONS::TCSProcessModule::setXiConverterModule ( TCSXiConverterModule pXiConverterModule)

Set xi converted module.

◆ toString()

std::string PARTONS::TCSProcessModule::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< TCSObservableKinematic, TCSObservableResult >.

Member Data Documentation

◆ m_beamPolarization

double PARTONS::TCSProcessModule::m_beamPolarization
protected

Beam polarization.

◆ m_dvcsConvolCoeffFunctionResult

TCSConvolCoeffFunctionResult PARTONS::TCSProcessModule::m_dvcsConvolCoeffFunctionResult
protected

Stored Compton Form Factor result.

◆ m_E

double PARTONS::TCSProcessModule::m_E
protected

Beam energy in target rest frame (in GeV).

◆ m_lastCCFKinematics

TCSConvolCoeffFunctionKinematic PARTONS::TCSProcessModule::m_lastCCFKinematics
protected

Last Compton Form Factor kinematics.

◆ m_pConvolCoeffFunctionModule

TCSConvolCoeffFunctionModule* PARTONS::TCSProcessModule::m_pConvolCoeffFunctionModule
protected

Pointer to the underlying CCF module.

◆ m_phi

double PARTONS::TCSProcessModule::m_phi
protected

Angle between leptonic and hadronic plane (in radians, Trento convention).

◆ m_pScaleModule

TCSScalesModule* PARTONS::TCSProcessModule::m_pScaleModule
protected

Pointer to the underlying scale module.

◆ m_pXiConverterModule

TCSXiConverterModule* PARTONS::TCSProcessModule::m_pXiConverterModule
protected

Pointer to the underlying xi converter module.

◆ m_Q2Prim

double PARTONS::TCSProcessModule::m_Q2Prim
protected

Virtuality of the incoming photon (in GeV2).

◆ m_t

double PARTONS::TCSProcessModule::m_t
protected

Mandelstam variable (square of the 4-momentum transferm in GeV2).

◆ m_targetPolarization

NumA::Vector3D PARTONS::TCSProcessModule::m_targetPolarization
protected

Target polarization.

◆ m_theta

double PARTONS::TCSProcessModule::m_theta
protected

Angle between positively charged lepton and scattered proton in lepton CMS (in degrees).

◆ m_tmax

double PARTONS::TCSProcessModule::m_tmax
protected

Maximal value of t.

◆ m_tmin

double PARTONS::TCSProcessModule::m_tmin
protected

Minimal value of t.

◆ TCS_PROCESS_MODULE_CLASS_NAME

const std::string PARTONS::TCSProcessModule::TCS_PROCESS_MODULE_CLASS_NAME
static
Initial value:
=
"TCSProcessModule"

Type of the module in XML automation.


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