calibration class for the track topology correction of the dE/dx using multvariate polynomials More...

#include <CalibdEdxTrackTopologyPol.h>

Public Member Functions
	CalibdEdxTrackTopologyPol (std::string_view fileName, std::string_view name="CalibdEdxTrackTopologyPol")

	CalibdEdxTrackTopologyPol ()=default
	Default constructor: creates an empty uninitialized object.

	~CalibdEdxTrackTopologyPol ()=default
	destructor

	GPUd () float getCorrection(const int32_t region

	GPUd () float getCorrection(const int32_t region

	GPUd () float getCorrectionqTot(const int32_t region

	GPUd () float getCorrectionqMax(const int32_t region

	GPUd () float getMinThreshold(const int32_t region=0) const

	GPUd () float getMaxThreshold(const int32_t region=0) const

	GPUd () float getScalingFactorqTot(const int32_t region) const

	GPUd () float getScalingFactorqMax(const int32_t region) const

const auto &	getPolyqTot (const int32_t region) const

const auto &	getPolyqMax (const int32_t region) const

void	setScalingFactorqTot (const float factor, const int32_t region)

void	setScalingFactorqMax (const float factor, const int32_t region)

void	writeToFile (TFile &outf, const char *name="CalibdEdxTrackTopologyPol") const

void	setFromContainer (const CalibdEdxTrackTopologyPolContainer &container)

void	loadFromFile (const char fileName, const char name)

void	dumpToTree (const uint32_t nSamplingPoints[], const char *outName="track_topology_corr_debug.root") const

void	setPolynomialsFromFile (TFile &inpf)

void	setDefaultPolynomials ()
	setting a default topology correction which just returns 1

void	cloneFromObject (const CalibdEdxTrackTopologyPol &obj, char *newFlatBufferPtr)
	========== FlatObject functionality, see FlatObject class for description =================

void	moveBufferTo (char *newBufferPtr)

void	destroy ()
	destroy the object (release internal flat buffer)

void	setActualBufferAddress (char *actualFlatBufferPtr)
	set location of external flat buffer

void	setFutureBufferAddress (char *futureFlatBufferPtr)
	set future location of the flat buffer

Public Member Functions inherited from o2::gpu::FlatObject
	FlatObject ()=default
	_____________ Constructors / destructors __________________________

	~FlatObject ()

	FlatObject (const FlatObject &)=delete

FlatObject &	operator= (const FlatObject &)=delete

void	destroy ()
	_______________ Utilities _______________________________________________

size_t	getFlatBufferSize () const
	Gives size of the flat buffer.

const char *	getFlatBufferPtr () const
	Gives pointer to the flat buffer.

bool	isConstructed () const
	Tells if the object is constructed.

bool	isBufferInternal () const
	Tells if the buffer is internal.

void	adoptInternalBuffer (char *buf)

void	clearInternalBufferPtr ()

void	printC () const
	Print the content of the flat buffer.

Static Public Member Functions
static std::string	getPolyName (const int32_t region, const ChargeType charge)

Static Public Member Functions inherited from o2::gpu::FlatObject
static size_t	alignSize (size_t sizeBytes, size_t alignmentBytes)
	_______________ Generic utilities _______________________________________________

template<class T >
static T *	relocatePointer (const char oldBase, char newBase, const T *ptr)
	Relocates a pointer inside a buffer to the new buffer address.

template<class T , class TFile >
static int32_t	writeToFile (T &obj, TFile &outf, const char *name)
	write a child class object to the file

template<class T , class TFile >
static T *	readFromFile (TFile &inpf, const char *name)
	read a child class object from the file

template<class T >
static std::string	stressTest (T &obj)
	Test the flat object functionality for a child class T.

Public Attributes
const ChargeType	charge

const ChargeType float x[]	const

const ChargeType	chargeT

const ChargeType const float	tanTheta

const ChargeType const float const float	sinPhi

const ChargeType const float const float const float	z

const ChargeType const float const float const float const float	relPad

const ChargeType const float const float const float const float const float	relTime

const ChargeType const float const float const float const float const float const float	threshold

const ChargeType const float const float const float const float const float const float const float charge	const

return	corr = mScalingFactorsqMax[region] * mCalibPolsqMax[region].eval(x)

const float	tanTheta

const float const float	sinPhi

const float const float const float	z

const float const float const float const float	threshold

const float const float const float const float const float charge	const

const float	corr = mScalingFactorsqTot[region] * mCalibPolsqTot[region].eval(x)

const float const float const float const float	relPad

const float const float const float const float const float relTime	const

Additional Inherited Members
Protected Types inherited from o2::gpu::FlatObject
enum	ConstructionState : uint32_t { NotConstructed = 0x0 , Constructed = 0x1 , InProgress = 0x2 }
	GPUCA_GPUCODE. More...

Protected Member Functions inherited from o2::gpu::FlatObject
void	startConstruction ()
	_____________ Construction _________

void	finishConstruction (int32_t flatBufferSize)

void	cloneFromObject (const FlatObject &obj, char *newFlatBufferPtr)

char *	releaseInternalBuffer ()
	_____________ Methods for making the data buffer external __________________________

void	moveBufferTo (char *newBufferPtr)

void	setActualBufferAddress (char *actualFlatBufferPtr)
	_____________ Methods for moving the class with its external buffer to another location __________________________

void	setFutureBufferAddress (char *futureFlatBufferPtr)

	ClassDefNV (FlatObject, 1)
	Pointer to the flat buffer.

Static Protected Member Functions inherited from o2::gpu::FlatObject
static constexpr size_t	getClassAlignmentBytes ()
	_____________ Memory alignment __________________________

static constexpr size_t	getBufferAlignmentBytes ()
	Gives minimal alignment in bytes required for the flat buffer.

Protected Attributes inherited from o2::gpu::FlatObject
int32_t	mFlatBufferSize = 0
	size of the flat buffer

uint32_t	mConstructionMask = ConstructionState::NotConstructed
	mask for constructed object members, first two bytes are used by this class

char *	mFlatBufferContainer = nullptr

char *	mFlatBufferPtr = nullptr

Detailed Description

calibration class for the track topology correction of the dE/dx using multvariate polynomials

Definition at line 46 of file CalibdEdxTrackTopologyPol.h.

Constructor & Destructor Documentation

◆ CalibdEdxTrackTopologyPol() [1/2]

o2::tpc::CalibdEdxTrackTopologyPol::CalibdEdxTrackTopologyPol	(	std::string_view	fileName,
		std::string_view	name = `"CalibdEdxTrackTopologyPol"`
	)

inline

constructor constructs an object Initialized from file

Parameters

fileName name of the input file containing the object \parma name name of the object

Definition at line 53 of file CalibdEdxTrackTopologyPol.h.

◆ CalibdEdxTrackTopologyPol() [2/2]

o2::tpc::CalibdEdxTrackTopologyPol::CalibdEdxTrackTopologyPol ( )

default

Default constructor: creates an empty uninitialized object.

◆ ~CalibdEdxTrackTopologyPol()

o2::tpc::CalibdEdxTrackTopologyPol::~CalibdEdxTrackTopologyPol ( )

default

destructor

Member Function Documentation

◆ cloneFromObject()

void CalibdEdxTrackTopologyPol::cloneFromObject	(	const CalibdEdxTrackTopologyPol &	obj,
		char *	newFlatBufferPtr
	)

========== FlatObject functionality, see FlatObject class for description =================

cloning a container object (use newFlatBufferPtr=nullptr for simple copy)

Definition at line 39 of file CalibdEdxTrackTopologyPol.cxx.

◆ destroy()

void CalibdEdxTrackTopologyPol::destroy ( )

destroy the object (release internal flat buffer)

Definition at line 69 of file CalibdEdxTrackTopologyPol.cxx.

◆ dumpToTree()

void CalibdEdxTrackTopologyPol::dumpToTree	(	const uint32_t	nSamplingPoints[],
		const char *	outName = `"track_topology_corr_debug.root"`
	)		const

dump the correction to a tree for visualisation

Parameters

nSamplingPoints	number of sampling points per dimension
outName	name of the output file

Definition at line 25 of file CalibdEdxTrackTopologyPol.cxx.

◆ getPolyName()

std::string CalibdEdxTrackTopologyPol::getPolyName	(	const int32_t	region,
		const ChargeType	charge
	)

static

Returns: returns the name of the polynomial object which can be read in with the setPolynomialsFromFile() function

Parameters

region	region of the TPC
charge	correction for maximum or total charge

Definition at line 234 of file CalibdEdxTrackTopologyPol.cxx.

◆ getPolyqMax()

const auto & o2::tpc::CalibdEdxTrackTopologyPol::getPolyqMax ( const int32_t region ) const

inline

Returns: returns polynomial for qMax

Parameters

region region of the TPC

Definition at line 137 of file CalibdEdxTrackTopologyPol.h.

◆ getPolyqTot()

const auto & o2::tpc::CalibdEdxTrackTopologyPol::getPolyqTot ( const int32_t region ) const

inline

Returns: returns polynomial for qTot

Parameters

region region of the TPC

Definition at line 133 of file CalibdEdxTrackTopologyPol.h.

◆ GPUd() [1/8]

o2::tpc::CalibdEdxTrackTopologyPol::GPUd ( ) const

Returns: returns the track topology correction

Parameters

region	region of the TPC
charge	correction for maximum or total charge
x	coordinates where the correction is evaluated

◆ GPUd() [2/8]

o2::tpc::CalibdEdxTrackTopologyPol::GPUd ( ) const

Returns: returns the track topology correction

Parameters

region	region of the TPC
chargeT	correction for maximum or total charge
tanTheta	tan of local inclination angle theta
sinPhi	track parameter sinphi
z	z position of the cluster
relPad	absolute relative pad position of the track
relTime	relative time position of the track
threshold	zero supression threshold
charge	charge of the cluster

◆ GPUd() [3/8]

o2::tpc::CalibdEdxTrackTopologyPol::GPUd ( ) const

Returns: returns the track topology correction for qMax

Parameters

region	region of the TPC
tanTheta	tan of local inclination angle theta
sinPhi	track parameter sinphi
z	z position of the cluster
relPad	absolute relative pad position of the track
relTime	relative time position of the track

◆ GPUd() [4/8]

o2::tpc::CalibdEdxTrackTopologyPol::GPUd ( ) const

Returns: returns the track topology correction for qTot

Parameters

region	region of the TPC
tanTheta	tan of local inclination angle theta
sinPhi	track parameter sinphi
z	z position of the cluster
threshold	zero supression threshold
charge	charge of the cluster

◆ GPUd() [5/8]

o2::tpc::CalibdEdxTrackTopologyPol::GPUd ( ) const

inlinepure virtual

returns the maximum zero supression threshold for which the polynomials are valid

Parameters

region region of the TPC

Definition at line 120 of file CalibdEdxTrackTopologyPol.h.

◆ GPUd() [6/8]

o2::tpc::CalibdEdxTrackTopologyPol::GPUd ( ) const

inlinepure virtual

returns the minimum zero supression threshold for which the polynomials are valid

Parameters

region region of the TPC

Definition at line 116 of file CalibdEdxTrackTopologyPol.h.

◆ GPUd() [7/8]

o2::tpc::CalibdEdxTrackTopologyPol::GPUd ( ) const

inline

Returns: returns the the scaling factors for the polynomials for qMax

Parameters

region region of the scaling factor

Definition at line 128 of file CalibdEdxTrackTopologyPol.h.

◆ GPUd() [8/8]

o2::tpc::CalibdEdxTrackTopologyPol::GPUd ( ) const

inline

Returns: returns the the scaling factors for the polynomials for qTot

Parameters

region region of the scaling factor

Definition at line 124 of file CalibdEdxTrackTopologyPol.h.

◆ loadFromFile()

void CalibdEdxTrackTopologyPol::loadFromFile	(	const char *	fileName,
		const char *	name
	)

load members from a file

Parameters

fileName	file where the object will be read from
name	name of the object in the output file

Definition at line 210 of file CalibdEdxTrackTopologyPol.cxx.

◆ moveBufferTo()

void CalibdEdxTrackTopologyPol::moveBufferTo ( char * newBufferPtr )

move flat buffer to new location

Parameters

newBufferPtr new buffer location

Definition at line 60 of file CalibdEdxTrackTopologyPol.cxx.

◆ setActualBufferAddress()

void CalibdEdxTrackTopologyPol::setActualBufferAddress ( char * actualFlatBufferPtr )

set location of external flat buffer

Definition at line 78 of file CalibdEdxTrackTopologyPol.cxx.

◆ setDefaultPolynomials()

void CalibdEdxTrackTopologyPol::setDefaultPolynomials ( )

setting a default topology correction which just returns 1

Definition at line 138 of file CalibdEdxTrackTopologyPol.cxx.

◆ setFromContainer()

void CalibdEdxTrackTopologyPol::setFromContainer ( const CalibdEdxTrackTopologyPolContainer & container )

init parameters from CalibdEdxTrackTopologyPolContainer

Parameters

container container for the members

Definition at line 182 of file CalibdEdxTrackTopologyPol.cxx.

◆ setFutureBufferAddress()

void CalibdEdxTrackTopologyPol::setFutureBufferAddress ( char * futureFlatBufferPtr )

set future location of the flat buffer

Definition at line 94 of file CalibdEdxTrackTopologyPol.cxx.

◆ setPolynomialsFromFile()

void CalibdEdxTrackTopologyPol::setPolynomialsFromFile ( TFile & inpf )

sets the polynomials from an input file. The names of the objects have to be the same as in the getPolyName() function

Parameters

inpf	file where the polynomials are stored

Definition at line 223 of file CalibdEdxTrackTopologyPol.cxx.

◆ setScalingFactorqMax()

void o2::tpc::CalibdEdxTrackTopologyPol::setScalingFactorqMax	(	const float	factor,
		const int32_t	region
	)

inline

set the the scaling factors for the polynomials for qMax

Parameters

factor	scaling factor
region	region of the scaling factor

Definition at line 148 of file CalibdEdxTrackTopologyPol.h.

◆ setScalingFactorqTot()

void o2::tpc::CalibdEdxTrackTopologyPol::setScalingFactorqTot	(	const float	factor,
		const int32_t	region
	)

inline

set the the scaling factors for the polynomials for qTot

Parameters

factor	scaling factor
region	region of the scaling factor

Definition at line 143 of file CalibdEdxTrackTopologyPol.h.

◆ writeToFile()

void CalibdEdxTrackTopologyPol::writeToFile	(	TFile &	outf,
		const char *	name = `"CalibdEdxTrackTopologyPol"`
	)		const

write a class object to the file

Parameters

outf	file where the object will be written to
name	name of the object in the output file

Definition at line 158 of file CalibdEdxTrackTopologyPol.cxx.

Member Data Documentation

◆ charge

const ChargeType o2::tpc::CalibdEdxTrackTopologyPol::charge

Definition at line 65 of file CalibdEdxTrackTopologyPol.h.

◆ chargeT

const ChargeType o2::tpc::CalibdEdxTrackTopologyPol::chargeT

Definition at line 80 of file CalibdEdxTrackTopologyPol.h.

◆ const [1/4]

const ChargeType float x [] o2::tpc::CalibdEdxTrackTopologyPol::const

Initial value:

{

return (charge == ChargeType::Tot) ? mCalibPolsqTot[region].eval(x) : mCalibPolsqMax[region].eval(x)

o2::tpc::CalibdEdxTrackTopologyPol::charge

const ChargeType charge

Definition CalibdEdxTrackTopologyPol.h:65

x

GLint GLenum GLint x

Definition glcorearb.h:403

o2::tpc::Tot

@ Tot

Definition Defs.h:72

Definition at line 65 of file CalibdEdxTrackTopologyPol.h.

◆ const [2/4]

const ChargeType const float const float const float const float const float const float const float charge o2::tpc::CalibdEdxTrackTopologyPol::const

Initial value:

{

const float corr = (chargeT == ChargeType::Tot) ? getCorrectionqTot(region, tanTheta, sinPhi, z, threshold, charge) : getCorrectionqMax(region, tanTheta, sinPhi, z, relPad, relTime)

o2::tpc::CalibdEdxTrackTopologyPol::relTime

const ChargeType const float const float const float const float const float relTime

Definition CalibdEdxTrackTopologyPol.h:80

o2::tpc::CalibdEdxTrackTopologyPol::tanTheta

const ChargeType const float tanTheta

Definition CalibdEdxTrackTopologyPol.h:80

o2::tpc::CalibdEdxTrackTopologyPol::threshold

const ChargeType const float const float const float const float const float const float threshold

Definition CalibdEdxTrackTopologyPol.h:80

o2::tpc::CalibdEdxTrackTopologyPol::chargeT

const ChargeType chargeT

Definition CalibdEdxTrackTopologyPol.h:80

o2::tpc::CalibdEdxTrackTopologyPol::sinPhi

const ChargeType const float const float sinPhi

Definition CalibdEdxTrackTopologyPol.h:80

o2::tpc::CalibdEdxTrackTopologyPol::corr

return corr

Definition CalibdEdxTrackTopologyPol.h:83

o2::tpc::CalibdEdxTrackTopologyPol::relPad

const ChargeType const float const float const float const float relPad

Definition CalibdEdxTrackTopologyPol.h:80

z

GLdouble GLdouble GLdouble z

Definition glcorearb.h:843

Definition at line 80 of file CalibdEdxTrackTopologyPol.h.

◆ const [3/4]

const float const float const float const float const float charge o2::tpc::CalibdEdxTrackTopologyPol::const

Initial value:

{

float x[]{z, tanTheta, sinPhi, threshold, charge}

o2::tpc::CalibdEdxTrackTopologyPol::z

const ChargeType const float const float const float z

Definition CalibdEdxTrackTopologyPol.h:80

Definition at line 93 of file CalibdEdxTrackTopologyPol.h.

◆ const [4/4]

const float const float const float const float const float relTime o2::tpc::CalibdEdxTrackTopologyPol::const

Initial value:

{

float x[]{z, tanTheta, sinPhi, relPad, relTime}

Definition at line 107 of file CalibdEdxTrackTopologyPol.h.

◆ corr [1/2]

return o2::tpc::CalibdEdxTrackTopologyPol::corr = mScalingFactorsqMax[region] * mCalibPolsqMax[region].eval(x)

Definition at line 83 of file CalibdEdxTrackTopologyPol.h.

◆ corr [2/2]

const float o2::tpc::CalibdEdxTrackTopologyPol::corr = mScalingFactorsqTot[region] * mCalibPolsqTot[region].eval(x)

Definition at line 96 of file CalibdEdxTrackTopologyPol.h.

◆ relPad [1/2]

const ChargeType const float const float const float const float o2::tpc::CalibdEdxTrackTopologyPol::relPad

Definition at line 80 of file CalibdEdxTrackTopologyPol.h.

◆ relPad [2/2]

const float const float const float const float o2::tpc::CalibdEdxTrackTopologyPol::relPad

Definition at line 107 of file CalibdEdxTrackTopologyPol.h.

◆ relTime

const ChargeType const float const float const float const float const float o2::tpc::CalibdEdxTrackTopologyPol::relTime

Definition at line 80 of file CalibdEdxTrackTopologyPol.h.

◆ sinPhi [1/2]

const float const float o2::tpc::CalibdEdxTrackTopologyPol::sinPhi

Definition at line 80 of file CalibdEdxTrackTopologyPol.h.

◆ sinPhi [2/2]

const float const float o2::tpc::CalibdEdxTrackTopologyPol::sinPhi

Definition at line 93 of file CalibdEdxTrackTopologyPol.h.

◆ tanTheta [1/2]

const float o2::tpc::CalibdEdxTrackTopologyPol::tanTheta

Definition at line 80 of file CalibdEdxTrackTopologyPol.h.

◆ tanTheta [2/2]

const float o2::tpc::CalibdEdxTrackTopologyPol::tanTheta

Definition at line 93 of file CalibdEdxTrackTopologyPol.h.

◆ threshold [1/2]

const ChargeType const float const float const float const float const float const float o2::tpc::CalibdEdxTrackTopologyPol::threshold

Definition at line 80 of file CalibdEdxTrackTopologyPol.h.

◆ threshold [2/2]

const float const float const float const float o2::tpc::CalibdEdxTrackTopologyPol::threshold

Definition at line 93 of file CalibdEdxTrackTopologyPol.h.

◆ z [1/2]

const float const float const float o2::tpc::CalibdEdxTrackTopologyPol::z

Definition at line 80 of file CalibdEdxTrackTopologyPol.h.

◆ z [2/2]

const float const float const float o2::tpc::CalibdEdxTrackTopologyPol::z

Definition at line 93 of file CalibdEdxTrackTopologyPol.h.

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

/home/runner/work/AliceO2/AliceO2/GPU/GPUTracking/DataTypes/CalibdEdxTrackTopologyPol.h
/home/runner/work/AliceO2/AliceO2/GPU/GPUTracking/DataTypes/CalibdEdxTrackTopologyPol.cxx

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CalibdEdxTrackTopologyPol() [1/2]

◆ CalibdEdxTrackTopologyPol() [2/2]

◆ ~CalibdEdxTrackTopologyPol()

Member Function Documentation

◆ cloneFromObject()

◆ destroy()

◆ dumpToTree()

◆ getPolyName()

◆ getPolyqMax()

◆ getPolyqTot()

◆ GPUd() [1/8]

◆ GPUd() [2/8]

◆ GPUd() [3/8]

◆ GPUd() [4/8]

◆ GPUd() [5/8]

◆ GPUd() [6/8]

◆ GPUd() [7/8]

◆ GPUd() [8/8]

◆ loadFromFile()

◆ moveBufferTo()

◆ setActualBufferAddress()

◆ setDefaultPolynomials()

◆ setFromContainer()

◆ setFutureBufferAddress()

◆ setPolynomialsFromFile()

◆ setScalingFactorqMax()

◆ setScalingFactorqTot()

◆ writeToFile()

Member Data Documentation

◆ charge

◆ chargeT

◆ const [1/4]

◆ const [2/4]

◆ const [3/4]

◆ const [4/4]

◆ corr [1/2]

◆ corr [2/2]

◆ relPad [1/2]

◆ relPad [2/2]

◆ relTime

◆ sinPhi [1/2]

◆ sinPhi [2/2]

◆ tanTheta [1/2]

◆ tanTheta [2/2]

◆ threshold [1/2]

◆ threshold [2/2]

◆ z [1/2]

◆ z [2/2]