PARTONS::TCSObservableKinematic Class Reference

Class representing single observable kinematics for TCS process. More...

Inheritance diagram for PARTONS::TCSObservableKinematic:

Public Member Functions
	TCSObservableKinematic ()
	Default constructor. More...
	TCSObservableKinematic (double t, double Q2Prim, double E, double phi, double theta)
	Assignment constructor. More...
	TCSObservableKinematic (const PhysicalType< double > &t, const PhysicalType< double > &Q2Prim, const PhysicalType< double > &E, const PhysicalType< double > &phi, const PhysicalType< double > &theta)
	Assignment constructor. More...
	TCSObservableKinematic (const ElemUtils::GenericType &t, const ElemUtils::GenericType &Q2Prim, const ElemUtils::GenericType &E, const ElemUtils::GenericType &phi, const ElemUtils::GenericType &theta)
	Assignment constructor. More...
	TCSObservableKinematic (const TCSObservableKinematic &other)
	Copy constructor. More...
virtual	~TCSObservableKinematic ()
	Destructor. More...
virtual void	configure (const ElemUtils::Parameters &parameters)
	Configure via parameters. More...
virtual std::string	toString () const
	Return a pre-formatted characters string for output visualization of class member's values. More...
void	serialize (ElemUtils::Packet &packet) const
	Serialize into given Packet. More...
void	unserialize (ElemUtils::Packet &packet)
	Retrieve data from given Packet. More...
void	serializeIntoStdVector (std::vector< double > &vec) const
	Serialize to std::vector<double>. More...
void	unserializeFromStdVector (std::vector< double >::const_iterator &it, const std::vector< double >::const_iterator &end)
	Unserialize from std::vector<double>. More...
bool	operator== (const TCSObservableKinematic &other) const
	Is equal operator. More...
bool	operator!= (const TCSObservableKinematic &other) const
	Is different operator. More...
const PhysicalType< double > &	getT () const
	Get four-momentum transfer squared of hadron target. More...
void	setT (const PhysicalType< double > &t)
	Set four-momentum transfer squared of hadron target. More...
void	setT (double t, PhysicalUnit::Type unit=PhysicalUnit::GEV2)
	Set four-momentum transfer squared of hadron target. More...
const PhysicalType< double > &	getQ2Prim () const
	Get outgoing virtual-photon virtuality. More...
void	setQ2Prim (const PhysicalType< double > &Q2Prim)
	Set outgoing virtual-photon virtuality. More...
void	setQ2Prim (double Q2Prim, PhysicalUnit::Type unit=PhysicalUnit::GEV2)
	Set outgoing virtual-photon virtuality. More...
const PhysicalType< double > &	getE () const
	Get beam energy. More...
void	setE (const PhysicalType< double > &E)
	Set beam energy. More...
void	setE (double E, PhysicalUnit::Type unit=PhysicalUnit::GEV)
	Set beam energy. More...
const PhysicalType< double > &	getPhi () const
	Get angle between leptonic and hadronic planes (in radians). More...
void	setPhi (const PhysicalType< double > &phi)
	Set angle between leptonic and hadronic planes (in radians). More...
void	setPhi (double phi, PhysicalUnit::Type unit=PhysicalUnit::RAD)
	Set angle between leptonic and hadronic planes (in radians). More...
const PhysicalType< double > &	getTheta () const
	Get angle between positively charged lepton and scattered proton in lepton CMS (in radians). More...
void	setTheta (const PhysicalType< double > &theta)
	Set angle between positively charged lepton and scattered proton in lepton CMS (in radians). More...
void	setTheta (double theta, PhysicalUnit::Type unit=PhysicalUnit::RAD)
	Set angle between positively charged lepton and scattered proton in lepton CMS (in radians). More...
Public Member Functions inherited from PARTONS::ObservableKinematic
virtual	~ObservableKinematic ()
	Destructor. More...
void	serialize (ElemUtils::Packet &packet) const
	Serialize into given Packet. More...
void	unserialize (ElemUtils::Packet &packet)
	Retrieve data from given Packet. More...
void	serializeIntoStdVector (std::vector< double > &vec) const
	Serialize to std::vector<double>. More...
void	unserializeFromStdVector (std::vector< double >::const_iterator &it, const std::vector< double >::const_iterator &end)
	Unserialize from std::vector<double>. More...
Public Member Functions inherited from PARTONS::Kinematic
virtual	~Kinematic ()
	Destructor. More...
void	serialize (ElemUtils::Packet &packet) const
	Serialize into given Packet. More...
void	unserialize (ElemUtils::Packet &packet)
	Retrieve data from given Packet. More...
void	serializeIntoStdVector (std::vector< double > &vec) const
	Serialize to std::vector<double>. More...
void	unserializeFromStdVector (std::vector< double >::const_iterator &it, const std::vector< double >::const_iterator &end)
	Unserialize from std::vector<double>. More...
ChannelType::Type	getChannelType () const
	Get channel type. More...
const std::string &	getHashSum () const
	Get hash sum of class content. More...
void	setHashSum (const std::string &hashSum) const
	Set hash sum of class content. More...
Public Member Functions inherited from PARTONS::BaseObject
	BaseObject (const std::string &className)
	Constructor. More...
virtual	~BaseObject ()
	Default destructor. More...
virtual BaseObject *	clone () const
	Virtual clone function to allow the factory to clone all derived members object stored in the BaseObjectRegistry. 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...
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_OBSERVABLE_KINEMATIC_CLASS_NAME
	Type of the kinematic in XML automation. More...
static const std::string	KINEMATIC_PARAMETER_NAME_Q2PRIM
	Parameter name to set variable \(Q^{2}'\) via configuration methods. More...
static const std::string	KINEMATIC_PARAMETER_NAME_BEAM_ENERGY
	Parameter name to set variable \(E_{b}\) via configuration methods. More...
static const std::string	KINEMATIC_PARAMETER_NAME_PHI = "phi"
	Parameter name to set variable \(\phi\) via configuration methods. More...
static const std::string	KINEMATIC_PARAMETER_NAME_THETA
	Parameter name to set variable \(\theta\) via configuration methods. More...
static const std::string	KINEMATIC_PARAMETER_NAME_Q2PRIM_UNIT
	Parameter name to set unit of variable \(Q^{2}'\) via configuration methods. More...
static const std::string	KINEMATIC_PARAMETER_NAME_BEAM_ENERGY_UNIT
	Parameter name to set unit of variable \(E_{b}\) via configuration methods. More...
static const std::string	KINEMATIC_PARAMETER_NAME_PHI_UNIT
	Parameter name to set unit of variable \(\phi\) via configuration methods. More...
static const std::string	KINEMATIC_PARAMETER_NAME_THETA_UNIT
	Parameter name to set unit of variable \(\theta\) via configuration methods. More...

Protected Member Functions
virtual void	updateHashSum () const
	Update hash sum (see Kinematic::m_hashSum variable). More...
Protected Member Functions inherited from PARTONS::ObservableKinematic
	ObservableKinematic (const std::string &className, ChannelType::Type channelType)
	Default constructor. More...
	ObservableKinematic (const ObservableKinematic &other)
	Copy constructor. More...
Protected Member Functions inherited from PARTONS::Kinematic
	Kinematic (const std::string &className, ChannelType::Type channelType)
	Default constructor. More...
	Kinematic (const Kinematic &other)
	Copy constructor. More...
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...

Private Attributes
PhysicalType< double >	m_t
	Four-momentum transfer squared of hadron target (in \(GeV^{2}\)). More...
PhysicalType< double >	m_Q2Prim
	Virtual-photon virtuality (in \(GeV^{2}\)). More...
PhysicalType< double >	m_E
	Beam energy (in GeV). More...
PhysicalType< double >	m_phi
	Angle between leptonic and hadronic planes (in radians, Trento convention). More...
PhysicalType< double >	m_theta
	Angle between positively charged lepton and scattered proton in lepton CMS (in radians). More...

Detailed Description

Class representing single observable kinematics for TCS process.

This class represents a single observable kinematics for TCS process (t, \(Q^{2}\), E_{b}, \(\phi\), \(\theta\)).

Constructor & Destructor Documentation

TCSObservableKinematic() [1/5]

PARTONS::TCSObservableKinematic::TCSObservableKinematic

(

)

Default constructor.

TCSObservableKinematic() [2/5]

PARTONS::TCSObservableKinematic::TCSObservableKinematic	(	double	t,
		double	Q2Prim,
		double	E,
		double	phi,
		double	theta
	)

Assignment constructor.

Parameters

t	Four-momentum transfer squared of hadron target (in \(GeV^{2}\)).
Q2Prim	Outgoing virtual-photon virtuality (in \(GeV^{2}\)).
E	Beam energy (in GeV).
phi	Angle between leptonic and hadronic planes (in radians, Trento convention).
theta	Angle between positively charged lepton and scattered proton in lepton CMS (in radians).

TCSObservableKinematic() [3/5]

PARTONS::TCSObservableKinematic::TCSObservableKinematic	(	const PhysicalType< double > &	t,
		const PhysicalType< double > &	Q2Prim,
		const PhysicalType< double > &	E,
		const PhysicalType< double > &	phi,
		const PhysicalType< double > &	theta
	)

Assignment constructor.

Parameters

t	Four-momentum transfer squared of hadron target (in \(GeV^{2}\)).
Q2Prim	Outgoing virtual-photon virtuality (in \(GeV^{2}\)).
E	Beam energy (in GeV).
phi	Angle between leptonic and hadronic planes (in radians, Trento convention).
theta	Angle between positively charged lepton and scattered proton in lepton CMS (in radians).

TCSObservableKinematic() [4/5]

PARTONS::TCSObservableKinematic::TCSObservableKinematic	(	const ElemUtils::GenericType &	t,
		const ElemUtils::GenericType &	Q2Prim,
		const ElemUtils::GenericType &	E,
		const ElemUtils::GenericType &	phi,
		const ElemUtils::GenericType &	theta
	)

Assignment constructor.

Parameters

t	Four-momentum transfer squared of hadron target (in \(GeV^{2}\)).
Q2Prim	Outgoing virtual-photon virtuality (in \(GeV^{2}\)).
E	Beam energy (in GeV).
phi	Angle between leptonic and hadronic planes (in radians, Trento convention).
theta	Angle between positively charged lepton and scattered proton in lepton CMS (in radians).

TCSObservableKinematic() [5/5]

PARTONS::TCSObservableKinematic::TCSObservableKinematic

(

const TCSObservableKinematic &

other

)

Copy constructor.

Parameters

other

Object to be copied.

~TCSObservableKinematic()

PARTONS::TCSObservableKinematic::~TCSObservableKinematic ( )

virtual

Destructor.

Member Function Documentation

configure()

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

virtual

Configure via parameters.

Parameters

parameters

Set of parameters to be set.

Reimplemented from PARTONS::ObservableKinematic.

getE()

const PhysicalType< double > & PARTONS::TCSObservableKinematic::getE

(

)

const

Get beam energy.

getPhi()

const PhysicalType< double > & PARTONS::TCSObservableKinematic::getPhi

(

)

const

Get angle between leptonic and hadronic planes (in radians).

getQ2Prim()

const PhysicalType< double > & PARTONS::TCSObservableKinematic::getQ2Prim

(

)

const

Get outgoing virtual-photon virtuality.

getT()

const PhysicalType< double > & PARTONS::TCSObservableKinematic::getT

(

)

const

Get four-momentum transfer squared of hadron target.

getTheta()

const PhysicalType< double > & PARTONS::TCSObservableKinematic::getTheta

(

)

const

Get angle between positively charged lepton and scattered proton in lepton CMS (in radians).

operator!=()

bool PARTONS::TCSObservableKinematic::operator!=

(

const TCSObservableKinematic &

other

)

const

Is different operator.

Checks of values of kinematic variables are different.

operator==()

bool PARTONS::TCSObservableKinematic::operator==

(

const TCSObservableKinematic &

other

)

const

Is equal operator.

Checks if values of kinematic variables are the same.

serialize()

void PARTONS::TCSObservableKinematic::serialize

(

ElemUtils::Packet &

packet

)

const

Serialize into given Packet.

Parameters

packet

Target Packet.

serializeIntoStdVector()

void PARTONS::TCSObservableKinematic::serializeIntoStdVector

(

std::vector< double > &

vec

)

const

Serialize to std::vector<double>.

setE() [1/2]

void PARTONS::TCSObservableKinematic::setE

(

const PhysicalType< double > &

E

)

Set beam energy.

setE() [2/2]

void PARTONS::TCSObservableKinematic::setE	(	double	E,
		PhysicalUnit::Type	unit = PhysicalUnit::GEV
	)

Set beam energy.

setPhi() [1/2]

void PARTONS::TCSObservableKinematic::setPhi

(

const PhysicalType< double > &

phi

)

Set angle between leptonic and hadronic planes (in radians).

setPhi() [2/2]

void PARTONS::TCSObservableKinematic::setPhi	(	double	phi,
		PhysicalUnit::Type	unit = PhysicalUnit::RAD
	)

Set angle between leptonic and hadronic planes (in radians).

setQ2Prim() [1/2]

void PARTONS::TCSObservableKinematic::setQ2Prim

(

const PhysicalType< double > &

Q2Prim

)

Set outgoing virtual-photon virtuality.

setQ2Prim() [2/2]

void PARTONS::TCSObservableKinematic::setQ2Prim	(	double	Q2Prim,
		PhysicalUnit::Type	unit = PhysicalUnit::GEV2
	)

Set outgoing virtual-photon virtuality.

setT() [1/2]

void PARTONS::TCSObservableKinematic::setT

(

const PhysicalType< double > &

t

)

Set four-momentum transfer squared of hadron target.

setT() [2/2]

void PARTONS::TCSObservableKinematic::setT	(	double	t,
		PhysicalUnit::Type	unit = PhysicalUnit::GEV2
	)

Set four-momentum transfer squared of hadron target.

setTheta() [1/2]

void PARTONS::TCSObservableKinematic::setTheta

(

const PhysicalType< double > &

theta

)

Set angle between positively charged lepton and scattered proton in lepton CMS (in radians).

setTheta() [2/2]

void PARTONS::TCSObservableKinematic::setTheta	(	double	theta,
		PhysicalUnit::Type	unit = PhysicalUnit::RAD
	)

Set angle between positively charged lepton and scattered proton in lepton CMS (in radians).

toString()

std::string PARTONS::TCSObservableKinematic::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::ObservableKinematic.

unserialize()

void PARTONS::TCSObservableKinematic::unserialize

(

ElemUtils::Packet &

packet

)

Retrieve data from given Packet.

Parameters

packet

Input Packet.

unserializeFromStdVector()

void PARTONS::TCSObservableKinematic::unserializeFromStdVector	(	std::vector< double >::const_iterator &	it,
		const std::vector< double >::const_iterator &	end
	)

Unserialize from std::vector<double>.

updateHashSum()

void PARTONS::TCSObservableKinematic::updateHashSum ( ) const

protectedvirtual

Update hash sum (see Kinematic::m_hashSum variable).

Implements PARTONS::ObservableKinematic.

Member Data Documentation

KINEMATIC_PARAMETER_NAME_BEAM_ENERGY

const std::string PARTONS::TCSObservableKinematic::KINEMATIC_PARAMETER_NAME_BEAM_ENERGY

static

Initial value:

=
        "E"

Parameter name to set variable \(E_{b}\) via configuration methods.

KINEMATIC_PARAMETER_NAME_BEAM_ENERGY_UNIT

const std::string PARTONS::TCSObservableKinematic::KINEMATIC_PARAMETER_NAME_BEAM_ENERGY_UNIT

static

Initial value:

=
        "E_unit"

Parameter name to set unit of variable \(E_{b}\) via configuration methods.

KINEMATIC_PARAMETER_NAME_PHI

const std::string PARTONS::TCSObservableKinematic::KINEMATIC_PARAMETER_NAME_PHI = "phi"

static

Parameter name to set variable \(\phi\) via configuration methods.

KINEMATIC_PARAMETER_NAME_PHI_UNIT

const std::string PARTONS::TCSObservableKinematic::KINEMATIC_PARAMETER_NAME_PHI_UNIT

static

Initial value:

=
        "phi_unit"

Parameter name to set unit of variable \(\phi\) via configuration methods.

KINEMATIC_PARAMETER_NAME_Q2PRIM

const std::string PARTONS::TCSObservableKinematic::KINEMATIC_PARAMETER_NAME_Q2PRIM

static

Initial value:

=
        "Q2Prim"

Parameter name to set variable \(Q^{2}'\) via configuration methods.

KINEMATIC_PARAMETER_NAME_Q2PRIM_UNIT

const std::string PARTONS::TCSObservableKinematic::KINEMATIC_PARAMETER_NAME_Q2PRIM_UNIT

static

Initial value:

=
        "Q2Prim_unit"

Parameter name to set unit of variable \(Q^{2}'\) via configuration methods.

KINEMATIC_PARAMETER_NAME_THETA

const std::string PARTONS::TCSObservableKinematic::KINEMATIC_PARAMETER_NAME_THETA

static

Initial value:

=
        "theta"

Parameter name to set variable \(\theta\) via configuration methods.

KINEMATIC_PARAMETER_NAME_THETA_UNIT

const std::string PARTONS::TCSObservableKinematic::KINEMATIC_PARAMETER_NAME_THETA_UNIT

static

Initial value:

=
        "theta_unit"

Parameter name to set unit of variable \(\theta\) via configuration methods.

m_E

PhysicalType<double> PARTONS::TCSObservableKinematic::m_E

private

Beam energy (in GeV).

m_phi

PhysicalType<double> PARTONS::TCSObservableKinematic::m_phi

private

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

m_Q2Prim

PhysicalType<double> PARTONS::TCSObservableKinematic::m_Q2Prim

private

Virtual-photon virtuality (in \(GeV^{2}\)).

m_t

PhysicalType<double> PARTONS::TCSObservableKinematic::m_t

private

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

m_theta

PhysicalType<double> PARTONS::TCSObservableKinematic::m_theta

private

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

TCS_OBSERVABLE_KINEMATIC_CLASS_NAME

const std::string PARTONS::TCSObservableKinematic::TCS_OBSERVABLE_KINEMATIC_CLASS_NAME

static

Initial value:

=
        "TCSObservableKinematic"

Type of the kinematic in XML automation.

---

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

• include/partons/beans/observable/TCS/TCSObservableKinematic.h
• src/partons/beans/observable/TCS/TCSObservableKinematic.cpp