#include <TPCFastTransform.h>

Inherits o2::gpu::FlatObject.

Public Member Functions
	TPCFastTransform ()
	_____________ Constructors / destructors __________________________

	TPCFastTransform (const TPCFastTransform &)=delete
	Copy constructor: disabled to avoid ambiguity. Use cloneFromObject() instead.

TPCFastTransform &	operator= (const TPCFastTransform &)=delete
	Assignment operator: disabled to avoid ambiguity. Use cloneFromObject() instead.

void	destroy ()

	~TPCFastTransform ()
	Destructor.

void	cloneFromObject (const TPCFastTransform &obj, char *newFlatBufferPtr)
	Construction interface.

void	moveBufferTo (char *newBufferPtr)

void	setActualBufferAddress (char *actualFlatBufferPtr)
	Moving the class with its external buffer to another location.

void	setFutureBufferAddress (char *futureFlatBufferPtr)

void	startConstruction (const TPCFastSpaceChargeCorrection &correction)
	_______________ Construction interface ________________________

void	setCalibration (int64_t timeStamp, float t0, float vDrift)

void	setLumi (float l)
	Set Lumi info.

void	setLumiError (float e)

void	setLumiScaleFactor (float s)

void	setIDC (float l)

void	setIDCError (float e)

void	setCTP2IDCFallBackThreshold (float v)

void	setTimeStamp (int64_t v)
	Sets the time stamp of the current calibaration.

	GPUdi () const TPCFastSpaceChargeCorrection &getCorrection() const
	Gives a reference for external initialization of TPC corrections.

TPCFastSpaceChargeCorrection &	getCorrection ()
	Gives a reference for external initialization of TPC corrections.

void	finishConstruction ()
	Finishes initialization: puts everything to the flat buffer, releases temporary memory.

	GPUd () void Transform(int32_t sector

	GPUd () void TransformXYZ(int32_t sector

	GPUd () void TransformInTimeFrame(int32_t sector
	Transformation in the time frame.

	GPUd () void TransformInTimeFrame(int32_t sector

	GPUd () void InverseTransformInTimeFrame(int32_t sector
	Inverse transformation.

	GPUd () float InverseTransformInTimeFrame(int32_t sector

	GPUd () void InverseTransformYZtoX(int32_t sector
	Inverse transformation: Transformed Y and Z -> transformed X.

	GPUd () void InverseTransformYZtoNominalYZ(int32_t sector
	Inverse transformation: Transformed Y and Z -> Y and Z, transformed w/o space charge correction.

	GPUd () void InverseTransformXYZtoNominalXYZ(int32_t sector
	Inverse transformation: Transformed X, Y and Z -> X, Y and Z, transformed w/o space charge correction.

	GPUd () void TransformIdeal(int32_t sector
	Ideal transformation with Vdrift only - without calibration.

	GPUd () void TransformIdealZ(int32_t sector

	GPUd () void convPadTimeToLocal(int32_t sector

	GPUd () void convPadTimeToLocalInTimeFrame(int32_t sector

	GPUd () void convLocalToPadTime(int32_t sector

	GPUd () void convLocalToPadTimeInTimeFrame(int32_t sector

	GPUd () float convTimeToZinTimeFrame(int32_t sector

	GPUd () float convZtoTimeInTimeFrame(int32_t sector

	GPUd () float convDeltaTimeToDeltaZinTimeFrame(int32_t sector

	GPUd () float convDeltaZtoDeltaTimeInTimeFrame(int32_t sector

	GPUd () float convDeltaZtoDeltaTimeInTimeFrameAbs(float deltaZ) const

	GPUd () float convZOffsetToVertexTime(int32_t sector

	GPUd () float convVertexTimeToZOffset(int32_t sector

void	setApplyCorrectionOn ()

void	setApplyCorrectionOff ()

bool	isCorrectionApplied ()

	GPUdi () const TPCFastTransformGeo &getGeometry() const
	_______________ Utilities _______________________________________________

	GPUdi () int64_t getTimeStamp() const
	Gives the time stamp of the current calibaration parameters.

	GPUdi () float getVDrift() const
	Return mVDrift in cm / time bin.

	GPUdi () float getT0() const
	Return T0 in time bin units.

	GPUdi () float getLumi() const
	Return map lumi.

	GPUdi () float isLumiSet() const

	GPUdi () float getLumiError() const
	Return map lumi error.

	GPUd () float getIDC() const
	Return map lumi.

	GPUdi () bool isIDCSet() const

	GPUdi () float getIDCError() const
	Return map lumi error.

	GPUdi () float getCTP2IDCFallBackThreshold() const

	GPUdi () float getLumiScaleFactor() const
	Return map user defined lumi scale factor.

	GPUd () float getMaxDriftTime(int32_t sector
	maximal possible drift time of the active area

	GPUd () float getMaxDriftTime(int32_t sector
	maximal possible drift time of the active area

	GPUd () float getMaxDriftTime(int32_t sector) const
	maximal possible drift time of the active area

int32_t	writeToFile (std::string outFName="", std::string name="")

void	rectifyAfterReadingFromFile ()

void	setSlowTPCSCCorrection (TFile &inpf)
	setting the reference corrections

const auto &	getCorrectionSlow () const

void	print () const
	Print method.

	GPUd () float convDriftLengthToTime(float driftLength

char *	releaseInternalBuffer ()
	Making the data buffer external.

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

	~FlatObject ()

	FlatObject (const FlatObject &)=delete

FlatObject &	operator= (const FlatObject &)=delete

template<typename T >
T *	resizeArray (T &ptr, int32_t oldSize, int32_t newSize, T newPtr=nullptr)

template<typename T >
T **	resizeArray (T &ptr, int32_t oldSize, int32_t newSize, T newPtr=nullptr)

void	destroy ()
	_______________ Utilities _______________________________________________

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

	GPUdi () 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 constexpr size_t	getClassAlignmentBytes ()
	_____________ FlatObject functionality, see FlatObject class for description ____________

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

static TPCFastTransform *	loadFromFile (std::string inpFName="", std::string name="")

Static Public Member Functions inherited from o2::gpu::FlatObject
static constexpr 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
int32_t	row

int32_t float	pad

int32_t float float	time

int32_t float float float &	x

int32_t float float float float &	y

int32_t float float float float float &	z

int32_t float float float float float float	vertexTime = 0

int32_t float float float float float float const TPCFastTransform *	ref = nullptr

int32_t float float float float float float const TPCFastTransform const TPCFastTransform *	ref2 = nullptr

int32_t float float float float float float const TPCFastTransform const TPCFastTransform float	scale = 0.f

int32_t float float float float float float const TPCFastTransform const TPCFastTransform float float	scale2 = 0.f

int32_t float float float float float float const TPCFastTransform const TPCFastTransform float float int32_t	scaleMode = 0) const

int32_t float &	x

int32_t float float &	y

int32_t float float float &	z

int32_t float float float const TPCFastTransform *	ref = nullptr

int32_t float float float const TPCFastTransform const TPCFastTransform *	ref2 = nullptr

int32_t float float float const TPCFastTransform const TPCFastTransform float	scale = 0.f

int32_t float float float const TPCFastTransform const TPCFastTransform float float	scale2 = 0.f

int32_t float float float const TPCFastTransform const TPCFastTransform float float int32_t	scaleMode = 0) const

int32_t float float float float float float maxTimeBin	const

float	time

float float &	z

float float float maxTimeBin	const

int32_t	float

int32_t float	y

int32_t float float	z

int32_t float float float &	pad

int32_t float float float float &	time

int32_t float float float float float maxTimeBin	const

float	z

float float maxTimeBin	const

int32_t float float float &	ny

int32_t float float float float &	nz

int32_t float float float float const TPCFastTransform *	ref = nullptr

int32_t float float float float const TPCFastTransform const TPCFastTransform *	ref2 = nullptr

int32_t float float float float const TPCFastTransform const TPCFastTransform float	scale = 0.f

int32_t float float float float const TPCFastTransform const TPCFastTransform float float	scale2 = 0.f

int32_t float float float float const TPCFastTransform const TPCFastTransform float float int32_t	scaleMode = 0) const

int32_t float	x

int32_t float float	y

int32_t float float float	z

int32_t float float float float &	nx

int32_t float float float float float &	ny

int32_t float float float float float float &	nz

int32_t float float float float float float vertexTime	const

float float float vertexTime	const

int32_t float float float &	y

int32_t float float float float &	z

int32_t float float float float float vertexTime	const

float deltaTime	const

float deltaZ	const

float	zOffset

float	vertexTime

int32_t float pad	const

int32_t row	const

float vertexTime	const

Static Public Attributes
static constexpr float	DEFLUMI = -1e6f

static constexpr float	DEFIDC = -1e6f

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 ()
	GPUCA_GPUCODE.

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

The TPCFastTransform class represents transformation of raw TPC coordinates to XYZ

(TPC Row number, Pad, Drift Time) -> (X,Y,Z)

The following coordinate systems are used:

raw coordinate system: TPC row number [int32_t], readout pad number [float], drift time [float]
drift volume coordinate system (x,u,v)[cm]. These are cartesian coordinates: x = local x, u = along the local y axis but towards to the pad increase direction, v = along the global z axis but towards the drift length increase derection.

u and v are mirrored for A/C sides of the TPC
local coordinate system: x,y,z, where global x,y are rotated such that x goes through the middle of the TPC sector
global coordinate system: x,y,z in ALICE coordinate system

The transformation is pefformed as the following:

First, the class transforms input raw coordinates to the drift volume coordinates applying the drift velocity calibration. Then it aplies TPCCorrectionIRS to the drift coordinates. At the end it transforms the drift coordinates to the output local coordinates.

The class is flat C structure. No virtual methods, no ROOT types are used.

Definition at line 94 of file TPCFastTransform.h.

Constructor & Destructor Documentation

◆ TPCFastTransform() [1/2]

TPCFastTransform::TPCFastTransform ( )

_____________ Constructors / destructors __________________________

Default constructor: creates an empty uninitialized object

Definition at line 37 of file TPCFastTransform.cxx.

◆ TPCFastTransform() [2/2]

o2::gpu::TPCFastTransform::TPCFastTransform ( const TPCFastTransform & )

delete

Copy constructor: disabled to avoid ambiguity. Use cloneFromObject() instead.

◆ ~TPCFastTransform()

o2::gpu::TPCFastTransform::~TPCFastTransform ( )

inline

Destructor.

Definition at line 119 of file TPCFastTransform.h.

Member Function Documentation

◆ cloneFromObject()

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

Construction interface.

See FlatObject for description

Definition at line 43 of file TPCFastTransform.cxx.

◆ destroy()

void o2::gpu::TPCFastTransform::destroy ( )

inline

Definition at line 111 of file TPCFastTransform.h.

◆ finishConstruction()

void TPCFastTransform::finishConstruction ( )

Finishes initialization: puts everything to the flat buffer, releases temporary memory.

Finishes initialization: puts everything to the flat buffer, releases temporary memory

Definition at line 129 of file TPCFastTransform.cxx.

◆ getBufferAlignmentBytes()

static constexpr size_t o2::gpu::TPCFastTransform::getBufferAlignmentBytes ( )

inlinestaticconstexpr

Gives minimal alignment in bytes required for the flat buffer.

Definition at line 135 of file TPCFastTransform.h.

◆ getClassAlignmentBytes()

static constexpr size_t o2::gpu::TPCFastTransform::getClassAlignmentBytes ( )

inlinestaticconstexpr

_____________ FlatObject functionality, see FlatObject class for description ____________

Memory alignment Gives minimal alignment in bytes required for the class object

Definition at line 132 of file TPCFastTransform.h.

◆ getCorrection()

TPCFastSpaceChargeCorrection & o2::gpu::TPCFastTransform::getCorrection ( )

inline

Gives a reference for external initialization of TPC corrections.

Definition at line 176 of file TPCFastTransform.h.

◆ getCorrectionSlow()

const auto & o2::gpu::TPCFastTransform::getCorrectionSlow ( ) const

inline

Returns: returns the space charge object which is used for the slow correction

Definition at line 284 of file TPCFastTransform.h.