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 <TClonesArray.h> // ROOT_TClonesArray
54 //____________________________________________________________________
55 ClassImp(AliFMDRawWriter)
57 ; // This is here to keep Emacs for indenting the next line
60 //____________________________________________________________________
61 AliFMDRawWriter::AliFMDRawWriter(AliFMD* fmd)
62 : TTask("FMDRawWriter", "Writer of Raw ADC values from the FMD"),
69 AliFMDDebug(5, ("Created AliFMDRawWriter object"));
74 //____________________________________________________________________
76 AliFMDRawWriter::Exec(Option_t*)
78 // Turn digits into raw data.
80 // Digits are read from the Digit branch, and processed to make
81 // three DDL files, one for each of the sub-detectors FMD1, FMD2,
84 // The raw data files consists of a header, followed by ALTRO
95 // An ALTRO formatted block, in the FMD context, consists of a
96 // number of counts followed by a trailer.
98 // +------------------+
101 // | possible fillers |
102 // +------------------+
104 // +------------------+
107 // The counts are listed backwards, that is, starting with the
108 // latest count, and ending in the first.
110 // Each count consist of 1 or more ADC samples of the VA1_ALICE
111 // pre-amp. signal. Just how many samples are used depends on
112 // whether the ALTRO over samples the pre-amp. Each sample is a
113 // 10-bit word, and the samples are grouped into 40-bit blocks
115 // +------------------------------------+
116 // | S(1) | S(2) | S(3) | S(4) |
117 // | ... | ... | ... | ... |
118 // | S(n) | T(n) | n+2 | 2AA |
119 // +------------------------------------+
120 // Counts + possible filler
122 // The trailer of the number of words of signales, the starting
123 // strip number, the sector number, and the ring ID; each 10-bit
124 // words, packed into 40-bits.
126 // +------------------------------------+
127 // | 2AAA | Len | A | Address |
128 // +------------------------------------+
131 // Note, that this method assumes that the digits are ordered.
133 AliLoader* loader = fFMD->GetLoader();
134 loader->LoadDigits("READ");
135 TTree* digitTree = loader->TreeD();
137 AliError("no digit tree");
141 TClonesArray* digits = new TClonesArray("AliFMDDigit", 1000);
142 fFMD->SetTreeAddress();
143 TBranch* digitBranch = digitTree->GetBranch(fFMD->GetName());
145 AliError(Form("no branch for %s", fFMD->GetName()));
148 digitBranch->SetAddress(&digits);
150 Int_t nEvents = Int_t(digitTree->GetEntries());
151 AliFMDDebug(5, ("Got a total of %5d events from tree", nEvents));
152 for (Int_t event = 0; event < nEvents; event++) {
154 digitTree->GetEvent(event);
156 // Write out the digits
159 loader->UnloadDigits();
163 //____________________________________________________________________
165 AliFMDRawWriter::WriteDigits(TClonesArray* digits)
167 // WRite an array of digits to disk file
168 Int_t nDigits = digits->GetEntries();
169 if (nDigits < 1) return;
170 AliFMDDebug(5, ("Got a total of %5d digits from tree", nDigits));
172 AliFMDParameters* pars = AliFMDParameters::Instance();
173 UShort_t threshold = 0;
174 UInt_t prevddl = 0xFFFF;
175 UInt_t prevaddr = 0xFFF;
176 // UShort_t prevStrip = 0;
178 // Which channel number in the ALTRO channel we're at
180 UShort_t preSamples = 0;
182 // How many times the ALTRO Samples one VA1_ALICE channel
183 Int_t sampleRate = 1;
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);
190 AliAltroBuffer* altro = 0;
192 // Loop over the digits in the event. Note, that we assume the
193 // the digits are in order in the branch. If they were not, we'd
194 // have to cache all channels before we could write the data to
195 // the ALTRO buffer, or we'd have to set up a map of the digits.
196 UShort_t oldDet = 1000;
197 for (Int_t i = 0; i < nDigits; i++) {
199 AliFMDDigit* digit = static_cast<AliFMDDigit*>(digits->At(i));
200 UShort_t det = digit->Detector();
201 Char_t ring = digit->Ring();
202 UShort_t sector = digit->Sector();
203 UShort_t strip = digit->Strip();
207 AliFMDDebug(5, ("Got new detector: %d (was %d)", det, oldDet));
210 AliFMDDebug(10, ("Processing digit # %5d FMD%d%c[%2d,%3d]",
211 i, det, ring, sector, strip));
212 threshold = pars->GetZeroSuppression(det, ring, sector, strip);
213 if (!pars->Detector2Hardware(det, ring, sector, strip, ddl, addr)) {
214 AliError(Form("Failed to get hardware address for FMD%d%c[%2d,%3d]",
215 det, ring, sector, strip));
218 preSamples = pars->GetPreSamples(det, ring, sector, strip);
220 AliFMDDebug(10, ("FMD%d%c[%2d,%3d]-> ddl: 0x%x addr: 0x%x",
221 det, ring, sector, strip, ddl, addr));
222 if (addr != prevaddr) {
223 // Flush a channel to output
224 AliFMDDebug(15, ("Now hardware address 0x%x from FMD%d%c[%2d,%3d] "
225 "(board 0x%x, chip 0x%x, channel 0x%x), flushing old "
226 "channel at 0x%x with %d words",
227 addr, det, ring, sector, strip,
228 (addr >> 7), (addr >> 4) & 0x7, addr & 0xf,
230 if (altro) altro->WriteChannel(prevaddr,nWords,data.fArray,threshold);
233 for (size_t j = 0; j < nWords; j++) data[j] = digit->Count(0);
235 if (ddl != prevddl) {
236 AliFMDDebug(5, ("FMD: New DDL, was %d, now %d", prevddl, ddl));
237 // If an altro exists, delete the object, flushing the data to
238 // disk, and closing the file.
240 // When the first argument is false, we write the real
242 AliFMDDebug(15, ("Closing output"));
244 altro->WriteDataHeader(kFALSE, kFALSE);
249 // Need to open a new DDL!
250 TString filename(AliDAQ::DdlFileName(fFMD->GetName(), ddl));
251 AliFMDDebug(5, ("New altro buffer with DDL file %s", filename.Data()));
252 // Create a new altro buffer - a `1' as the second argument
253 // means `write mode'
254 altro = new AliAltroBuffer(filename.Data());
255 altro->SetMapping(pars->GetAltroMap());
256 // Write a dummy (first argument is true) header to the DDL
257 // file - later on, when we close the file, we write the real
259 altro->WriteDataHeader(kTRUE, kFALSE);
262 // Store the counts of the ADC in the channel buffer
263 sampleRate = pars->GetSampleRate(det, ring, sector, strip);
264 for (int s = 0; s < sampleRate; s++) {
265 data[nWords] = digit->Count(s);
269 // Finally, we need to close the final ALTRO buffer if it wasn't
272 if (nWords > 0) altro->WriteChannel(prevaddr,nWords,data.fArray,threshold);
274 altro->WriteDataHeader(kFALSE, kFALSE);
279 //____________________________________________________________________
281 AliFMDRawWriter::WriteDigits(TClonesArray* digits)
283 Int_t nDigits = digits->GetEntries();
284 if (nDigits < 1) return;
286 AliFMDParameters* pars = AliFMDParameters::Instance();
287 AliFMDAltroWriter* writer = 0;
288 Int_t sampleRate = -1;
291 std::ofstream* file = 0;
293 for (Int_t i = 0; i < nDigits; i++) {
295 AliFMDDigit* digit = static_cast<AliFMDDigit*>(digits->At(i));
296 UInt_t thisDDL, thisHwaddr;
297 UShort_t det = digit->Detector();
298 Char_t ring = digit->Ring();
299 UShort_t sector = digit->Sector();
300 UShort_t strip = digit->Strip();
301 if (!pars->Detector2Hardware(det,ring,sector,strip,thisDDL,thisHwaddr)) {
302 AliError(Form("Failed to get hardware address for FMD%d%c[%2d,%3d]",
303 det, ring, sector, strip));
306 AliFMDDebug(40, ("Got DDL=%d and address=%d from FMD%d%c[%2d,%3d]",
307 thisDDL, thisHwaddr, det, ring, sector, strip));
308 // Check if we're still in the same channel
309 if (thisHwaddr != hwaddr) {
310 AliFMDDebug(30, ("Now hardware address 0x%x from FMD%d%c[%2d,%3d] "
311 "(board 0x%x, chip 0x%x, channel 0x%x)",
312 thisHwaddr, det, ring, sector, strip,
313 (thisHwaddr >> 7), (thisHwaddr >> 4) & 0x7,
315 if (writer) writer->AddChannelTrailer(hwaddr);
318 // Check if we're still in the same detector (DDL)
319 if (ddl != thisDDL) {
321 AliFMDDebug(1, ("Closing altro writer %p", writer));
322 if ((ret = writer->Close()) < 0) {
323 AliError(Form("Error: %s", writer->ErrorString(ret)));
334 // If we haven't got a writer (either because none were made so
335 // far, or because we've switch DDL), make one.
337 AliFMDDebug(1, ("Opening new ALTRO writer w/file %s",
338 AliDAQ::DdlFileName("FMD",ddl)));
339 file = new std::ofstream(AliDAQ::DdlFileName("FMD",ddl));
340 if (!file || !*file) {
341 AliFatal(Form("Failed to open file %s",
342 AliDAQ::DdlFileName("FMD",ddl)));
345 writer = new AliFMDAltroWriter(*file);
346 writer->SetThreshold(pars->GetZeroSuppression(det, ring, sector, strip));
348 // Write out our signal
349 sampleRate = pars->GetSampleRate(det,ring,sector,strip);
350 writer->AddSignal(digit->Count1());
351 if (sampleRate >= 2) writer->AddSignal(digit->Count2());
352 if (sampleRate >= 3) writer->AddSignal(digit->Count3());
355 writer->AddChannelTrailer(hwaddr);
367 //____________________________________________________________________