Skip to content

Commit 42a7fe0

Browse files
author
Marcello Di Costanzo
committed
Add documentation
1 parent 49f1734 commit 42a7fe0

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

Common/TableProducer/qVectorsTable.cxx

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -398,6 +398,13 @@ struct qVectorsTable {
398398
}
399399
}
400400

401+
/// Function to normalize the q-vectors
402+
/// \param QvecReNorm is the vector with the normalized real part of the q-vector for each detector and correction step
403+
/// \param QvecImNorm is the vector with the normalized imaginary part of the q-vector for each detector and correction step
404+
/// \param QvecReRaw is the vector with the raw real part of the q-vector for each detector and correction step
405+
/// \param QvecImRaw is the vector with the raw imaginary part of the q-vector for each detector and correction step
406+
/// \param QvecAmp is the vector with the amplitude of the q-vector for each detector and correction step
407+
/// \param normType is the type of normalization to apply to the q-vectors
401408
void NormalizeQvec(std::vector<float>& QvecReNorm,
402409
std::vector<float>& QvecImNorm,
403410
std::vector<float> QvecReRaw,
@@ -430,6 +437,12 @@ struct qVectorsTable {
430437
}
431438
}
432439

440+
/// Function to calculate the un-normalized q-vectors
441+
/// \param cent is the collision centrality
442+
/// \param qvecRe is the vector with the real part of the q-vector for each detector and correction step
443+
/// \param qvecIm is the vector with the imaginary part of the q-vector for each detector and correction step
444+
/// \param histsCorrs is the vector with the histograms with the correction constants for each detector and correction step
445+
/// \param nMode is the modulation of interest
433446
void CorrectQvec(float cent, std::vector<float>& qvecRe, std::vector<float>& qvecIm, TH3F* histsCorrs, int nMode) {
434447
int nCorrections = static_cast<int>(Corrections::kNCorrections);
435448
if (cent < cfgMaxCentrality) {
@@ -533,6 +546,16 @@ struct qVectorsTable {
533546
}
534547
}
535548

549+
/// Function to calculate the un-normalized q-vectors
550+
/// \param nMode is the harmonic number of the q-vector
551+
/// \param coll is the collision object
552+
/// \param track are the tracks associated to the collision
553+
/// \param QvecRe is the vector with the real part of the q-vector for each detector
554+
/// \param QvecIm is the vector with the imaginary part of the q-vector for each detector
555+
/// \param QvecAmp is the vector with the amplitude of the signal in each detector
556+
/// \param TrkTPCposLabel is the vector with the number of TPC tracks with positive eta
557+
/// \param TrkTPCnegLabel is the vector with the number of TPC tracks with negative eta
558+
/// \param TrkTPCallLabel is the vector with the number of TPC tracks with any eta
536559
template <typename Nmode, typename CollType, typename TrackType>
537560
void CalQvec(const Nmode nMode, const CollType& coll, const TrackType& track, std::vector<float>& QvecRe, std::vector<float>& QvecIm, std::vector<float>& QvecAmp, std::vector<int>& TrkTPCposLabel, std::vector<int>& TrkTPCnegLabel, std::vector<int>& TrkTPCallLabel)
538561
{

0 commit comments

Comments
 (0)