Asymmetry R. More...

Inheritance diagram for PARTONS::TCSR:

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

virtual	~TCSR ()
	Destructor. More...

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

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

virtual	~TCSCrossSectionUUWeightedThetaIntegrated ()
	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...

const std::pair< double, double > &	getThetaRange () const
	Get range of theta angle used in the integration. More...

void	setThetaRange (const std::pair< double, double > &thetaRange)
	Set range of theta angle used in the integration. More...

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

virtual	~TCSCrossSectionUUWeighted ()
	Destructor. More...

Public Member Functions inherited from PARTONS::TCSObservable
virtual	~TCSObservable ()
	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 TCSObservableResult	compute (const TCSObservableKinematic &kinematic, const List< GPDType > &gpdType=List< GPDType >())
	Computes the observable at given kinematics. More...

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

TCSProcessModule *	getProcessModule () const
	Get process module. More...

void	setProcessModule (TCSProcessModule *pProcessModule)
	Set process module. More...

Public Member Functions inherited from PARTONS::Observable< TCSObservableKinematic, TCSObservableResult >
virtual	~Observable ()
	Destructor. 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 Public Attributes inherited from PARTONS::TCSCrossSectionUUWeightedThetaIntegrated
static const std::string	PARAMETER_NAME_THETA_LIMIT
	Name of parameter to set \(\theta_{\mathrm{limit}}\), which is the limit on \(\theta\) angle integration, defined as \(\|\theta - \pi/2\| < \theta_{\mathrm{limit}}\). In degrees. More...

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

Static Public Attributes inherited from PARTONS::TCSCrossSectionUUWeighted
static const unsigned int	classId
	Unique ID to automatically register the class in the registry. More...

Static Public Attributes inherited from PARTONS::TCSObservable
static const std::string	TCS_OBSERVABLE_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
	TCSR (const TCSR &other)
	Copy constructor. More...

virtual PhysicalType< double >	computeObservable (const TCSObservableKinematic &kinematic, const List< GPDType > &gpdType)
	Evaluate observable. More...

virtual double	functionToIntegrateObservablePhi1 (double x, std::vector< double > params)
	Function to be integrated (numerator). More...

virtual double	functionToIntegrateObservablePhi2 (double x, std::vector< double > params)
	Function to be integrated (denominator). More...

virtual void	initFunctorsForIntegrations ()
	Initialize functors. More...

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

virtual double	functionToIntegrateObservableTheta (double x, std::vector< double > params)
	Function to be integrated. More...

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

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

	TCSObservable (const TCSObservable &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::Observable< TCSObservableKinematic, TCSObservableResult >
	Observable (const std::string &className, ChannelType::Type channelType)
	Constructor. More...

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

std::vector< double >	serializeKinematicsAndGPDTypesIntoStdVector (const TCSObservableKinematic &kin, const List< GPDType > &list) const
	Serialize kinematics and list of GPD types to std::vector<double>. More...

void	unserializeKinematicsAndGPDTypesFromStdVector (const std::vector< double > &vec, TCSObservableKinematic &kin, List< GPDType > &list) const
	Unserialize kinematics and list of GPD types from std::vector<double>. 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 ()

Protected Attributes
NumA::FunctionType1D *	m_pFunctionToIntegrateObservablePhi1
	Functor to perform the integration (numerator). More...

NumA::FunctionType1D *	m_pFunctionToIntegrateObservablePhi2
	Functor to perform the integration (denominator). More...

Protected Attributes inherited from PARTONS::TCSCrossSectionUUWeightedThetaIntegrated
NumA::FunctionType1D *	m_pFunctionToIntegrateObservableTheta
	Functor to perform the integration. More...

std::pair< double, double >	m_thetaRange
	Range of theta angle used in the integration. More...

Protected Attributes inherited from PARTONS::TCSObservable
TCSProcessModule *	m_pProcessModule
	Pointer to the underlying process module. More...

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

Detailed Description

Asymmetry R.

Definition:

see Eq. (31) of Eur. Phys. J. C23 (2002) 675

Unit: none.

Constructor & Destructor Documentation

◆ TCSR() [1/2]

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

Constructor.

Parameters

className Name of class.

◆ ~TCSR()

PARTONS::TCSR::~TCSR ( )

virtual

Destructor.

◆ TCSR() [2/2]

PARTONS::TCSR::TCSR ( const TCSR & other )

protected

Copy constructor.

Parameters

other Object to be copied.

Member Function Documentation

◆ clone()

TCSR * PARTONS::TCSR::clone ( ) const

virtual

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

Returns

Reimplemented from PARTONS::TCSCrossSectionUUWeightedThetaIntegrated.

◆ computeObservable()

PhysicalType< double > PARTONS::TCSR::computeObservable	(	const TCSObservableKinematic &	kinematic,
		const List< GPDType > &	gpdType
	)

protectedvirtual

Evaluate observable.

To be implemented in a child class.

Reimplemented from PARTONS::TCSCrossSectionUUWeightedThetaIntegrated.

◆ functionToIntegrateObservablePhi1()

double PARTONS::TCSR::functionToIntegrateObservablePhi1	(	double	x,
		std::vector< double >	params
	)

protectedvirtual

Function to be integrated (numerator).

◆ functionToIntegrateObservablePhi2()

double PARTONS::TCSR::functionToIntegrateObservablePhi2	(	double	x,
		std::vector< double >	params
	)

protectedvirtual

Function to be integrated (denominator).

◆ initFunctorsForIntegrations()

void PARTONS::TCSR::initFunctorsForIntegrations ( )

protectedvirtual

Initialize functors.

Reimplemented from PARTONS::TCSCrossSectionUUWeightedThetaIntegrated.

Member Data Documentation

◆ classId

const unsigned int PARTONS::TCSR::classId

static

Initial value:

=

BaseObjectRegistry::getInstance()->registerBaseObject(new TCSR("TCSR"))

PARTONS::BaseObjectRegistry::registerBaseObject

unsigned int registerBaseObject(BaseObject *pBaseObject)

Store a unique instance of a module identified by a unique string character key.

Definition: BaseObjectRegistry.cpp:45

PARTONS::BaseObjectRegistry::getInstance

static BaseObjectRegistry * getInstance()

Static function to be able to retrieve a unique instance pointer of this class anywhere in the code.

Definition: BaseObjectRegistry.cpp:15

PARTONS::TCSR::TCSR

TCSR(const std::string &className)

Constructor.

Definition: TCSR.cpp:18

Unique ID to automatically register the class in the registry.

◆ m_pFunctionToIntegrateObservablePhi1

NumA::FunctionType1D* PARTONS::TCSR::m_pFunctionToIntegrateObservablePhi1

protected

Functor to perform the integration (numerator).

◆ m_pFunctionToIntegrateObservablePhi2

NumA::FunctionType1D* PARTONS::TCSR::m_pFunctionToIntegrateObservablePhi2

protected

Functor to perform the integration (denominator).

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

include/partons/modules/observable/TCS/asymmetry/TCSR.h
src/partons/modules/observable/TCS/asymmetry/TCSR.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TCSR() [1/2]

◆ ~TCSR()

◆ TCSR() [2/2]

Member Function Documentation

◆ clone()

◆ computeObservable()

◆ functionToIntegrateObservablePhi1()

◆ functionToIntegrateObservablePhi2()

◆ initFunctorsForIntegrations()

Member Data Documentation

◆ classId

◆ m_pFunctionToIntegrateObservablePhi1

◆ m_pFunctionToIntegrateObservablePhi2