-
Notifications
You must be signed in to change notification settings - Fork 494
Expand file tree
/
Copy pathCTFCoder.cxx
More file actions
221 lines (203 loc) · 10.4 KB
/
CTFCoder.cxx
File metadata and controls
221 lines (203 loc) · 10.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
// Copyright CERN and copyright holders of ALICE O2. This software is
// distributed under the terms of the GNU General Public License v3 (GPL
// Version 3), copied verbatim in the file "COPYING".
//
// See http://alice-o2.web.cern.ch/license for full licensing information.
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
/// \file CTFCoder.cxx
/// \author ruben.shahoyan@cern.ch
/// \brief class for entropy encoding/decoding of TPC compressed clusters data
#include "TPCReconstruction/CTFCoder.h"
#include <fmt/format.h>
using namespace o2::tpc;
/// estimate size needed to store in the flat buffer the payload of the CompressedClusters (here only the counters are used)
size_t CTFCoder::estimateSize(CompressedClusters& c)
{
const CompressedClustersCounters& header = c;
size_t sz = 0;
sz += alignSize(c.qTotU, header.nUnattachedClusters);
sz += alignSize(c.qMaxU, header.nUnattachedClusters);
sz += alignSize(c.flagsU, header.nUnattachedClusters);
sz += alignSize(c.padDiffU, header.nUnattachedClusters);
sz += alignSize(c.timeDiffU, header.nUnattachedClusters);
sz += alignSize(c.sigmaPadU, header.nUnattachedClusters);
sz += alignSize(c.sigmaTimeU, header.nUnattachedClusters);
sz += alignSize(c.nSliceRowClusters, header.nSliceRows);
if (header.nAttachedClusters) {
sz += alignSize(c.qTotA, header.nAttachedClusters);
sz += alignSize(c.qMaxA, header.nAttachedClusters);
sz += alignSize(c.flagsA, header.nAttachedClusters);
sz += alignSize(c.rowDiffA, header.nAttachedClustersReduced);
sz += alignSize(c.sliceLegDiffA, header.nAttachedClustersReduced);
sz += alignSize(c.padResA, header.nAttachedClustersReduced);
sz += alignSize(c.timeResA, header.nAttachedClustersReduced);
sz += alignSize(c.sigmaPadA, header.nAttachedClusters);
sz += alignSize(c.sigmaTimeA, header.nAttachedClusters);
sz += alignSize(c.qPtA, header.nTracks);
sz += alignSize(c.rowA, header.nTracks);
sz += alignSize(c.sliceA, header.nTracks);
sz += alignSize(c.timeA, header.nTracks);
sz += alignSize(c.padA, header.nTracks);
sz += alignSize(c.nTrackClusters, header.nTracks);
}
return sz;
}
/// set addresses of the CompressedClusters fields to point on already reserved memory region
void CTFCoder::setCompClusAddresses(CompressedClusters& c, void*& buff)
{
const CompressedClustersCounters& header = c;
setAlignedPtr(buff, c.qTotU, header.nUnattachedClusters);
setAlignedPtr(buff, c.qMaxU, header.nUnattachedClusters);
setAlignedPtr(buff, c.flagsU, header.nUnattachedClusters);
setAlignedPtr(buff, c.padDiffU, header.nUnattachedClusters);
setAlignedPtr(buff, c.timeDiffU, header.nUnattachedClusters);
setAlignedPtr(buff, c.sigmaPadU, header.nUnattachedClusters);
setAlignedPtr(buff, c.sigmaTimeU, header.nUnattachedClusters);
setAlignedPtr(buff, c.nSliceRowClusters, header.nSliceRows);
if (header.nAttachedClusters) {
setAlignedPtr(buff, c.qTotA, header.nAttachedClusters);
setAlignedPtr(buff, c.qMaxA, header.nAttachedClusters);
setAlignedPtr(buff, c.flagsA, header.nAttachedClusters);
setAlignedPtr(buff, c.rowDiffA, header.nAttachedClustersReduced);
setAlignedPtr(buff, c.sliceLegDiffA, header.nAttachedClustersReduced);
setAlignedPtr(buff, c.padResA, header.nAttachedClustersReduced);
setAlignedPtr(buff, c.timeResA, header.nAttachedClustersReduced);
setAlignedPtr(buff, c.sigmaPadA, header.nAttachedClusters);
setAlignedPtr(buff, c.sigmaTimeA, header.nAttachedClusters);
setAlignedPtr(buff, c.qPtA, header.nTracks);
setAlignedPtr(buff, c.rowA, header.nTracks);
setAlignedPtr(buff, c.sliceA, header.nTracks);
setAlignedPtr(buff, c.timeA, header.nTracks);
setAlignedPtr(buff, c.padA, header.nTracks);
setAlignedPtr(buff, c.nTrackClusters, header.nTracks);
}
}
///________________________________
void CTFCoder::createCoders(const std::string& dictPath, o2::ctf::CTFCoderBase::OpType op)
{
bool mayFail = true; // RS FIXME if the dictionary file is not there, do not produce exception
auto buff = readDictionaryFromFile<CTF>(dictPath, mayFail);
if (!buff.size()) {
if (mayFail) {
return;
}
throw std::runtime_error("Failed to create CTF dictionaty");
}
const auto* ctf = CTF::get(buff.data());
mCombineColumns = ctf->getHeader().flags & CTFHeader::CombinedColumns;
LOG(INFO) << "TPC CTF Columns Combining " << (mCombineColumns ? "ON" : "OFF");
auto getFreq = [ctf](CTF::Slots slot) -> o2::rans::FrequencyTable {
o2::rans::FrequencyTable ft;
auto bl = ctf->getBlock(slot);
auto md = ctf->getMetadata(slot);
ft.addFrequencies(bl.getDict(), bl.getDict() + bl.getNDict(), md.min, md.max);
return std::move(ft);
};
auto getProbBits = [ctf](CTF::Slots slot) -> int {
return ctf->getMetadata(slot).probabilityBits;
};
CompressedClusters cc; // just to get member types
#define MAKECODER(part, slot) createCoder<std::remove_pointer<decltype(part)>::type>(op, getFreq(slot), getProbBits(slot), int(slot))
// clang-format off
if (mCombineColumns) {
MAKECODER( (MPTR<CTF::NBitsQTot, CTF::NBitsQMax>()), CTF::BLCqTotA); // merged qTotA and qMaxA
}
else {
MAKECODER(cc.qTotA, CTF::BLCqTotA);
}
MAKECODER(cc.qMaxA, CTF::BLCqMaxA);
MAKECODER(cc.flagsA, CTF::BLCflagsA);
if (mCombineColumns) {
MAKECODER( (MPTR<CTF::NBitsRowDiff, CTF::NBitsSliceLegDiff>()), CTF::BLCrowDiffA); // merged rowDiffA and sliceLegDiffA
}
else {
MAKECODER(cc.rowDiffA, CTF::BLCrowDiffA);
}
MAKECODER(cc.sliceLegDiffA, CTF::BLCsliceLegDiffA);
MAKECODER(cc.padResA, CTF::BLCpadResA);
MAKECODER(cc.timeResA, CTF::BLCtimeResA);
if (mCombineColumns) {
MAKECODER( (MPTR<CTF::NBitsSigmaPad, CTF::NBitsSigmaTime>()), CTF::BLCsigmaPadA); // merged sigmaPadA and sigmaTimeA
}
else {
MAKECODER(cc.sigmaPadA, CTF::BLCsigmaPadA);
}
MAKECODER(cc.sigmaTimeA, CTF::BLCsigmaTimeA);
MAKECODER(cc.qPtA, CTF::BLCqPtA);
MAKECODER(cc.rowA, CTF::BLCrowA);
MAKECODER(cc.sliceA, CTF::BLCsliceA);
MAKECODER(cc.timeA, CTF::BLCtimeA);
MAKECODER(cc.padA, CTF::BLCpadA);
if (mCombineColumns) {
MAKECODER( (MPTR<CTF::NBitsQTot, CTF::NBitsQMax>()), CTF::BLCqTotU); // merged qTotU and qMaxU
}
else {
MAKECODER(cc.qTotU, CTF::BLCqTotU);
}
MAKECODER(cc.qMaxU, CTF::BLCqMaxU);
MAKECODER(cc.flagsU, CTF::BLCflagsU);
MAKECODER(cc.padDiffU, CTF::BLCpadDiffU);
MAKECODER(cc.timeDiffU, CTF::BLCtimeDiffU);
if (mCombineColumns) {
MAKECODER( (MPTR<CTF::NBitsSigmaPad, CTF::NBitsSigmaTime>()), CTF::BLCsigmaPadU); // merged sigmaPadA and sigmaTimeA
}
else {
MAKECODER(cc.sigmaPadU, CTF::BLCsigmaPadU);
}
MAKECODER(cc.sigmaTimeU, CTF::BLCsigmaTimeU);
MAKECODER(cc.nTrackClusters, CTF::BLCnTrackClusters);
MAKECODER(cc.nSliceRowClusters, CTF::BLCnSliceRowClusters);
// clang-format on
}
/// make sure loaded dictionaries (if any) are consistent with data
void CTFCoder::checkDataDictionaryConsistency(const CTFHeader& h)
{
if (mCoders[0]) { // if external dictionary is provided (it will set , make sure its columns combining option is the same as
if (mCombineColumns != (h.flags & CTFHeader::CombinedColumns)) {
throw std::runtime_error(fmt::format("Mismatch in columns combining mode, Dictionary:{:s} CTFHeader:{:s}",
mCombineColumns ? "ON" : "OFF", (h.flags & CTFHeader::CombinedColumns) ? "ON" : "OFF"));
}
} else {
setCombineColumns(h.flags & CTFHeader::CombinedColumns);
LOG(INFO) << "CTF with stored dictionaries, columns combining " << (mCombineColumns ? "ON" : "OFF");
}
}
///________________________________
size_t CTFCoder::estimateCompressedSize(const CompressedClusters& ccl)
{
size_t sz = 0;
// clang-format off
// RS FIXME this is very crude estimate, instead, an empirical values should be used
#define ESTSIZE(slot, ptr, n) mCoders[int(slot)] ? \
rans::calculateMaxBufferSize(n, reinterpret_cast<const o2::rans::LiteralEncoder64<std::remove_pointer<decltype(ptr)>::type>*>(mCoders[int(slot)].get())->getAlphabetRangeBits(), \
sizeof(std::remove_pointer<decltype(ptr)>::type)) : n*sizeof(std::remove_pointer<decltype(ptr)>)
sz += ESTSIZE(CTF::BLCqTotA, ccl.qTotA, ccl.nAttachedClusters);
sz += ESTSIZE(CTF::BLCqMaxA, ccl.qMaxA, ccl.nAttachedClusters);
sz += ESTSIZE(CTF::BLCflagsA, ccl.flagsA, ccl.nAttachedClusters);
sz += ESTSIZE(CTF::BLCrowDiffA, ccl.rowDiffA, ccl.nAttachedClustersReduced);
sz += ESTSIZE(CTF::BLCsliceLegDiffA, ccl.sliceLegDiffA, ccl.nAttachedClustersReduced);
sz += ESTSIZE(CTF::BLCpadResA, ccl.padResA, ccl.nAttachedClustersReduced);
sz += ESTSIZE(CTF::BLCtimeResA, ccl.timeResA, ccl.nAttachedClustersReduced);
sz += ESTSIZE(CTF::BLCsigmaPadA, ccl.sigmaPadA, ccl.nAttachedClusters);
sz += ESTSIZE(CTF::BLCsigmaTimeA, ccl.sigmaTimeA, ccl.nAttachedClusters);
sz += ESTSIZE(CTF::BLCqPtA, ccl.qPtA, ccl.nTracks);
sz += ESTSIZE(CTF::BLCrowA, ccl.rowA, ccl.nTracks);
sz += ESTSIZE(CTF::BLCsliceA, ccl.sliceA, ccl.nTracks);
sz += ESTSIZE(CTF::BLCtimeA, ccl.timeA, ccl.nTracks);
sz += ESTSIZE(CTF::BLCpadA, ccl.padA, ccl.nTracks);
sz += ESTSIZE(CTF::BLCqTotU, ccl.qTotU, ccl.nUnattachedClusters);
sz += ESTSIZE(CTF::BLCqMaxU, ccl.qMaxU, ccl.nUnattachedClusters);
sz += ESTSIZE(CTF::BLCflagsU, ccl.flagsU, ccl.nUnattachedClusters);
sz += ESTSIZE(CTF::BLCpadDiffU, ccl.padDiffU, ccl.nUnattachedClusters);
sz += ESTSIZE(CTF::BLCtimeDiffU, ccl.timeDiffU, ccl.nUnattachedClusters);
sz += ESTSIZE(CTF::BLCsigmaPadU, ccl.sigmaPadU, ccl.nUnattachedClusters);
sz += ESTSIZE(CTF::BLCsigmaTimeU, ccl.sigmaTimeU, ccl.nUnattachedClusters);
sz += ESTSIZE(CTF::BLCnTrackClusters, ccl.nTrackClusters, ccl.nTracks);
sz += ESTSIZE(CTF::BLCnSliceRowClusters, ccl.nSliceRowClusters, ccl.nSliceRows);
// clang-format on
LOG(INFO) << "Estimated output size is " << sz << " bytes";
return sz;
}