1 /**************************************************************************
2 * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4 * Author: The ALICE Off-line Project. *
5 * Contributors are mentioned in the code where appropriate. *
7 * Permission to use, copy, modify and distribute this software and its *
8 * documentation strictly for non-commercial purposes is hereby granted *
9 * without fee, provided that the above copyright notice appears in all *
10 * copies and that both the copyright notice and this permission notice *
11 * appear in the supporting documentation. The authors make no claims *
12 * about the suitability of this software for any purpose. It is *
13 * provided "as is" without express or implied warranty. *
14 **************************************************************************/
16 /** @file AliFMDRawWriter.cxx
17 @author Christian Holm Christensen <cholm@nbi.dk>
18 @date Mon Mar 27 12:45:56 2006
19 @brief Class to write raw data
21 //____________________________________________________________________
23 // Class to write ADC values to a raw data file
25 // This class writes FMD Raw data to a file. The sample rate (number
26 // of times the ALTRO ADC samples each pre-amp. channel - that is,
27 // data from a single strip), can be set via SetSampleRate.
29 // Zero-suppression can be enabled by calling SetThreshold with a
30 // non-zero argument. ADC values less than the value set will not be
31 // written to output. Note, that if you use zero-suppression, you
32 // need to explicitly set the sample rate when reading back the data
33 // with AliFMDRawReader.
35 // This class uses the AliAltroBuffer class to write the data in the
36 // ALTRO format. See the Exec member function for more information on
39 // #include <AliLog.h> // ALILOG_H
40 #include "AliFMDDebug.h" // Better debug macros
41 #include <AliLoader.h> // ALILOADER_H
42 #include <AliAltroBuffer.h> // ALIALTROBUFFER_H
43 #include "AliFMD.h" // ALIFMD_H
44 #include "AliFMDParameters.h" // ALIFMDPARAMETERS_H
45 #include "AliFMDDigit.h" // ALIFMDDIGIT_H
46 #include "AliFMDRawWriter.h" // ALIFMDRAWREADER_H
47 #include "AliFMDAltroMapping.h" // ALIFMDALTROMAPPING_H
48 // #include "AliFMDAltroIO.h" // ALIFMDALTROWRITER_H
49 #include <TArrayI.h> // ROOT_TArrayI
50 #include <TArrayF.h> // ROOT_TArrayI
51 #include <TArrayC.h> // ROOT_TArrayI
52 #include <TClonesArray.h> // ROOT_TClonesArray
56 //____________________________________________________________________
57 ClassImp(AliFMDRawWriter)
59 ; // This is here to keep Emacs for indenting the next line
62 //____________________________________________________________________
63 AliFMDRawWriter::AliFMDRawWriter(AliFMD* fmd)
64 : TTask("FMDRawWriter", "Writer of Raw ADC values from the FMD"),
71 AliFMDDebug(5, ("Created AliFMDRawWriter object"));
76 //____________________________________________________________________
78 AliFMDRawWriter::Exec(Option_t*)
80 // Turn digits into raw data.
82 // Digits are read from the Digit branch, and processed to make
83 // three DDL files, one for each of the sub-detectors FMD1, FMD2,
86 // The raw data files consists of a header, followed by ALTRO
97 // An ALTRO formatted block, in the FMD context, consists of a
98 // number of counts followed by a trailer.
100 // +------------------+
103 // | possible fillers |
104 // +------------------+
106 // +------------------+
109 // The counts are listed backwards, that is, starting with the
110 // latest count, and ending in the first.
112 // Each count consist of 1 or more ADC samples of the VA1_ALICE
113 // pre-amp. signal. Just how many samples are used depends on
114 // whether the ALTRO over samples the pre-amp. Each sample is a
115 // 10-bit word, and the samples are grouped into 40-bit blocks
117 // +------------------------------------+
118 // | S(1) | S(2) | S(3) | S(4) |
119 // | ... | ... | ... | ... |
120 // | S(n) | T(n) | n+2 | 2AA |
121 // +------------------------------------+
122 // Counts + possible filler
124 // The trailer of the number of words of signales, the starting
125 // strip number, the sector number, and the ring ID; each 10-bit
126 // words, packed into 40-bits.
128 // +------------------------------------+
129 // | 2AAA | Len | A | Address |
130 // +------------------------------------+
133 // Note, that this method assumes that the digits are ordered.
135 AliLoader* loader = fFMD->GetLoader();
136 loader->LoadDigits("READ");
137 TTree* digitTree = loader->TreeD();
139 AliError("no digit tree");
143 TClonesArray* digits = new TClonesArray("AliFMDDigit", 1000);
144 fFMD->SetTreeAddress();
145 TBranch* digitBranch = digitTree->GetBranch(fFMD->GetName());
147 AliError(Form("no branch for %s", fFMD->GetName()));
150 digitBranch->SetAddress(&digits);
152 Int_t nEvents = Int_t(digitTree->GetEntries());
153 AliFMDDebug(5, ("Got a total of %5d events from tree", nEvents));
154 for (Int_t event = 0; event < nEvents; event++) {
156 digitTree->GetEvent(event);
158 // Write out the digits
161 loader->UnloadDigits();
165 //____________________________________________________________________
167 AliFMDRawWriter::WriteDigits(TClonesArray* digits)
169 // WRite an array of digits to disk file
170 Int_t nDigits = digits->GetEntries();
171 if (nDigits < 1) return;
172 AliFMDDebug(5, ("Got a total of %5d digits from tree", nDigits));
174 AliFMDParameters* pars = AliFMDParameters::Instance();
175 UShort_t threshold = 0;
176 UInt_t prevddl = 0xFFFF;
177 UInt_t prevaddr = 0xFFF;
178 // UShort_t prevStrip = 0;
180 // Which channel number in the ALTRO channel we're at
182 UShort_t preSamples = 0;
183 UShort_t sampleRate = 0;
185 // A buffer to hold 1 ALTRO channel - Normally, one ALTRO channel
186 // holds 128 VA1_ALICE channels, sampled at a rate of `sampleRate'
187 TArrayI data(pars->GetChannelsPerAltro() * 8);
188 TArrayF peds(pars->GetChannelsPerAltro() * 8);
189 TArrayF noise(pars->GetChannelsPerAltro() * 8);
192 AliAltroBuffer* altro = 0;
194 Int_t totalWords = 0;
197 // Loop over the digits in the event. Note, that we assume the
198 // the digits are in order in the branch. If they were not, we'd
199 // have to cache all channels before we could write the data to
200 // the ALTRO buffer, or we'd have to set up a map of the digits.
201 UShort_t oldDet = 1000;
202 for (Int_t i = 0; i < nDigits; i++) {
204 AliFMDDigit* digit = static_cast<AliFMDDigit*>(digits->At(i));
205 UShort_t det = digit->Detector();
206 Char_t ring = digit->Ring();
207 UShort_t sector = digit->Sector();
208 UShort_t strip = digit->Strip();
209 UShort_t ddl, addr, time;
211 AliFMDDebug(15, ("Processing digit # %5d FMD%d%c[%2d,%3d]",
212 i, det, ring, sector, strip));
213 threshold = pars->GetZeroSuppression(det, ring, sector, strip);
214 sampleRate = pars->GetSampleRate(det, ring, sector, strip);
215 preSamples = pars->GetPreSamples(det, ring, sector, strip);
218 AliFMDDebug(5, ("Got new detector: %d (was %d)", det, oldDet));
221 AliFMDDebug(15, ("Sample rate is %d", sampleRate));
223 for (UShort_t j = 0; j < sampleRate; j++) {
224 if (!pars->Detector2Hardware(det,ring,sector,strip,j,ddl,addr,time)){
225 AliError(Form("Failed to get hardware address for FMD%d%c[%2d,%3d]-%d",
226 det, ring, sector, strip, j));
230 AliFMDDebug(10, ("FMD%d%c[%2d,%3d]-%d-> 0x%x/0x%x/%04d",
231 det, ring, sector, strip, j, ddl, addr, time));
232 if (addr != prevaddr) {
233 // Flush a channel to output
234 AliFMDDebug(5, ("Now hardware address 0x%x from FMD%d%c[%2d,%3d]-%d"
235 "(b: 0x%02x, a: 0x%01x, c: 0x%02x, t: %04d), "
236 "flushing old channel at 0x%x with %d words",
237 addr, det, ring, sector, strip, j,
238 (addr >> 7), (addr >> 4) & 0x7, addr & 0xf,
239 time, prevaddr, nWords));
240 totalWords += nWords;
241 ZeroSuppress(data.fArray, nWords, peds.fArray, noise.fArray, threshold);
242 if (altro) altro->WriteChannel(prevaddr,nWords,data.fArray,threshold);
249 if (ddl != prevddl) {
250 AliFMDDebug(10, ("FMD: New DDL, was %d, now %d", prevddl, ddl));
251 // If an altro exists, delete the object, flushing the data to
252 // disk, and closing the file.
254 // When the first argument is false, we write the real
256 AliFMDDebug(15, ("Closing output"));
258 altro->WriteDataHeader(kFALSE, kFALSE);
263 // Need to open a new DDL!
264 TString filename(AliDAQ::DdlFileName(fFMD->GetName(), ddl));
265 AliFMDDebug(5, ("New altro buffer with DDL file %s", filename.Data()));
266 // Create a new altro buffer - a `1' as the second argument
267 // means `write mode'
268 altro = new AliAltroBuffer(filename.Data());
269 altro->SetMapping(pars->GetAltroMap());
270 // Write a dummy (first argument is true) header to the DDL
271 // file - later on, when we close the file, we write the real
273 altro->WriteDataHeader(kTRUE, kFALSE);
276 // Get the pedestal value
277 peds[time] = pars->GetPedestal(det, ring, sector, strip);
278 noise[time] = pars->GetPedestalWidth(det, ring, sector, strip);
280 // Store the counts of the ADC in the channel buffer
281 AliFMDDebug(15, ("Storing FMD%d%c[%02d,%03d]-%d in timebin %d (%d)",
282 det, ring, sector, strip, j, time, preSamples));
283 data[time] = digit->Count(j);
286 if (time == preSamples) {
287 AliFMDDebug(15, ("Filling in %4d for %d presamples",
288 data[time], preSamples));
289 for (int k = 0; k < preSamples; k++) {
290 peds[k] = peds[time];
291 noise[k] = noise[time];
292 data[k] = data[time];
294 nWords += preSamples;
298 // Finally, we need to close the final ALTRO buffer if it wasn't
301 ZeroSuppress(data.fArray, nWords, peds.fArray, noise.fArray, threshold);
302 if (nWords > 0) altro->WriteChannel(prevaddr,nWords,data.fArray,threshold);
304 altro->WriteDataHeader(kFALSE, kFALSE);
307 AliFMDDebug(5, ("Wrote a total of %d words for %d counts",
310 //____________________________________________________________________
312 AliFMDRawWriter::ZeroSuppress(Int_t*& data, Int_t nWords,
314 const Float_t* noise, UShort_t threshold) const
316 // Simulate the ALTRO zero-suppression filter. The data passed in
317 // the first array is modified, such that all suppressed channels
318 // are set to some value below threshold.
320 // If threshold == 0 zero suppression is considered disabled, and no
322 if (threshold <= 0) return;
324 // const Short_t width = 3;
325 // If fPedSubtract is false, compare data-(ped+f*noise), if true
326 // always modify data by -(ped+f*noise), and force negative values
328 Bool_t pedSubtract = AliFMDParameters::Instance()->IsZSPedSubtract();
329 UShort_t pre = AliFMDParameters::Instance()->GetZSPreSamples();
330 UShort_t post = AliFMDParameters::Instance()->GetZSPostSamples();
331 Float_t factor = AliFMDParameters::Instance()->GetPedestalFactor();
333 TArrayC mask(nWords+1);
334 for (Short_t i = 0; i < nWords; i++) {
335 Float_t val = data[i] - peds[i] - factor * noise[i];
336 if (val < 0.5) val = 0;
337 if (pedSubtract) data[i] = Int_t(val) & 0x3FF;
339 mask[i] = (val > threshold ? 1 : 0);
340 AliFMDDebug(10, ("Comparing sample %d %d-%f-%f*%f=%f to %d -> %s",
341 i, data[i], peds[i], factor, noise[i], val, threshold,
342 (mask[i] ? "above" : "below")));
345 for (Short_t i = 0; i < nWords; i++) {
346 if (mask[i]) { // Signal above, so do nothing
347 AliFMDDebug(10, ("Sample %d, above", i));
348 if (i < nWords-1 && !mask[i+1]) {
349 // After a valid sample. Increase the pointer to the next
350 // possible data, thereby skipping over the post-samples
351 AliFMDDebug(10, ("At sample %d, next is below, skipping %d to %d",
358 Short_t lookahead = TMath::Min(Short_t(nWords), Short_t(i+pre));
359 AliFMDDebug(10, ("Sample %d, below, look to %d", i, lookahead));
360 if (mask[lookahead] && pre > 0) {
361 AliFMDDebug(10, ("Sample %d is a pre-sample to %d", i, lookahead));
362 // We're in a presample, so don't modify the data, and increase
363 // counter by the number of pre-samples
368 // This sample must be surpressed
369 data[i] = threshold - 1;
374 //____________________________________________________________________
376 AliFMDRawWriter::WriteDigits(TClonesArray* digits)
378 Int_t nDigits = digits->GetEntries();
379 if (nDigits < 1) return;
381 AliFMDParameters* pars = AliFMDParameters::Instance();
382 AliFMDAltroWriter* writer = 0;
383 Int_t sampleRate = -1;
386 std::ofstream* file = 0;
388 for (Int_t i = 0; i < nDigits; i++) {
390 AliFMDDigit* digit = static_cast<AliFMDDigit*>(digits->At(i));
391 UInt_t thisDDL, thisHwaddr;
392 UShort_t det = digit->Detector();
393 Char_t ring = digit->Ring();
394 UShort_t sector = digit->Sector();
395 UShort_t strip = digit->Strip();
396 if (!pars->Detector2Hardware(det,ring,sector,strip,thisDDL,thisHwaddr)) {
397 AliError(Form("Failed to get hardware address for FMD%d%c[%2d,%3d]",
398 det, ring, sector, strip));
401 AliFMDDebug(40, ("Got DDL=%d and address=%d from FMD%d%c[%2d,%3d]",
402 thisDDL, thisHwaddr, det, ring, sector, strip));
403 // Check if we're still in the same channel
404 if (thisHwaddr != hwaddr) {
405 AliFMDDebug(30, ("Now hardware address 0x%x from FMD%d%c[%2d,%3d] "
406 "(board 0x%x, chip 0x%x, channel 0x%x)",
407 thisHwaddr, det, ring, sector, strip,
408 (thisHwaddr >> 7), (thisHwaddr >> 4) & 0x7,
410 if (writer) writer->AddChannelTrailer(hwaddr);
413 // Check if we're still in the same detector (DDL)
414 if (ddl != thisDDL) {
416 AliFMDDebug(1, ("Closing altro writer %p", writer));
417 if ((ret = writer->Close()) < 0) {
418 AliError(Form("Error: %s", writer->ErrorString(ret)));
429 // If we haven't got a writer (either because none were made so
430 // far, or because we've switch DDL), make one.
432 AliFMDDebug(1, ("Opening new ALTRO writer w/file %s",
433 AliDAQ::DdlFileName("FMD",ddl)));
434 file = new std::ofstream(AliDAQ::DdlFileName("FMD",ddl));
435 if (!file || !*file) {
436 AliFatal(Form("Failed to open file %s",
437 AliDAQ::DdlFileName("FMD",ddl)));
440 writer = new AliFMDAltroWriter(*file);
441 writer->SetThreshold(pars->GetZeroSuppression(det, ring, sector, strip));
443 // Write out our signal
444 sampleRate = pars->GetSampleRate(det,ring,sector,strip);
445 writer->AddSignal(digit->Count1());
446 if (sampleRate >= 2) writer->AddSignal(digit->Count2());
447 if (sampleRate >= 3) writer->AddSignal(digit->Count3());
450 writer->AddChannelTrailer(hwaddr);
462 //____________________________________________________________________