Project
Loading...
Searching...
No Matches
NoiseCalibSpec.cxx
Go to the documentation of this file.
1// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
2// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
3// All rights not expressly granted are reserved.
4//
5// This software is distributed under the terms of the GNU General Public
6// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
7//
8// In applying this license CERN does not waive the privileges and immunities
9// granted to it by virtue of its status as an Intergovernmental Organization
10// or submit itself to any jurisdiction.
11
15
16#include <iostream>
17#include <vector>
18#include <string>
19#include <gsl/span>
20#include <filesystem>
23#include "CCDB/CcdbApi.h"
24#include "Framework/Logger.h"
40
41using namespace o2::framework;
42
43namespace o2
44{
45namespace zdc
46{
47
49{
50 mTimer.Stop();
51 mTimer.Reset();
52}
53
55{
56 mTimer.Stop();
57 mTimer.Reset();
58}
59
61{
62 mVerbosity = ic.options().get<int>("verbosity-level");
63 mWorker.setVerbosity(mVerbosity);
64 mTimer.Start(false);
65}
66
68{
69 // we call these methods just to trigger finaliseCCDB callback
70 pc.inputs().get<o2::zdc::ModuleConfig*>("moduleconfig");
71}
72
74{
75 if (matcher == ConcreteDataMatcher("ZDC", "MODULECONFIG", 0)) {
76 auto* config = (const o2::zdc::ModuleConfig*)obj;
77 if (mVerbosity > DbgZero) {
78 config->print();
79 }
80 mWorker.setModuleConfig(config);
81 }
82}
83
85{
86 if (!mInitialized) {
87 mInitialized = true;
89 mOutput = &(pc.outputs());
90 mHistoFileMetaData = std::make_unique<o2::dataformats::FileMetaData>();
91 mHistoFileMetaData->setDataTakingContext(pc.services().get<o2::framework::DataTakingContext>());
92 mTimer.Stop();
93 mTimer.Reset();
94 mTimer.Start(false);
95 }
96 if (mRunStartTime == 0) {
97 const auto& tinfo = pc.services().get<o2::framework::TimingInfo>();
98 mRunStartTime = tinfo.creation; // approximate time in ms
99 mRunNumber = tinfo.runNumber;
100 }
101 {
102 std::vector<InputSpec> filterHisto = {{"noise_1dh", ConcreteDataTypeMatcher{"ZDC", "NOISE_1DH"}, Lifetime::Sporadic}};
103 for (auto const& inputRef : InputRecordWalker(pc.inputs(), filterHisto)) {
104 auto const* dh = framework::DataRefUtils::getHeader<o2::header::DataHeader*>(inputRef);
105 o2::dataformats::FlatHisto1D<double> histoView(pc.inputs().get<gsl::span<double>>(inputRef));
106 mWorker.add(dh->subSpecification, 0, histoView);
107 }
108 }
109 {
110 std::vector<InputSpec> filterHisto = {{"noise_1dh_s", ConcreteDataTypeMatcher{"ZDC", "NOISE_1DH_S"}, Lifetime::Sporadic}};
111 for (auto const& inputRef : InputRecordWalker(pc.inputs(), filterHisto)) {
112 auto const* dh = framework::DataRefUtils::getHeader<o2::header::DataHeader*>(inputRef);
113 o2::dataformats::FlatHisto1D<double> histoView(pc.inputs().get<gsl::span<double>>(inputRef));
114 mWorker.add(dh->subSpecification, 1, histoView);
115 }
116 }
117 {
118 std::vector<InputSpec> filterHisto = {{"noise_1dh_d", ConcreteDataTypeMatcher{"ZDC", "NOISE_1DH_D"}, Lifetime::Sporadic}};
119 for (auto const& inputRef : InputRecordWalker(pc.inputs(), filterHisto)) {
120 auto const* dh = framework::DataRefUtils::getHeader<o2::header::DataHeader*>(inputRef);
121 o2::dataformats::FlatHisto1D<double> histoView(pc.inputs().get<gsl::span<double>>(inputRef));
122 mWorker.add(dh->subSpecification, 2, histoView);
123 }
124 }
125 auto data = pc.inputs().get<o2::zdc::NoiseCalibSummaryData*>("noisecalibdata");
126 mWorker.process(data.get());
127}
128
130{
131 mWorker.endOfRun();
132 mTimer.Stop();
133 sendOutput(ec);
134 LOGF(info, "ZDC Noise calibration total timing: Cpu: %.3e Real: %.3e s in %d slots", mTimer.CpuTime(), mTimer.RealTime(), mTimer.Counter() - 1);
135}
136
137//________________________________________________________________
139{
140 std::string fn = "ZDC_NoiseCalib";
142
143 // extract CCDB infos and calibration objects, convert it to TMemFile and send them to the output
144 // TODO in principle, this routine is generic, can be moved to Utils.h
146 const auto& payload = mWorker.getParam();
147 auto& info = mWorker.getCcdbObjectInfo();
148 const auto& opt = CalibParamZDC::Instance();
149 opt.updateCcdbObjectInfo(info);
150
151 auto image = o2::ccdb::CcdbApi::createObjectImage<NoiseParam>(&payload, &info);
152 LOG(info) << "Sending object " << info.getPath() << "/" << info.getFileName() << " of size " << image->size()
153 << " bytes, valid for " << info.getStartValidityTimestamp() << " : " << info.getEndValidityTimestamp();
154 if (mVerbosity > DbgMinimal) {
155 payload.print();
156 }
157 mOutput->snapshot(Output{o2::calibration::Utils::gDataOriginCDBPayload, "ZDCNoisecalib", 0}, *image.get()); // vector<char>
158 mOutput->snapshot(Output{o2::calibration::Utils::gDataOriginCDBWrapper, "ZDCNoisecalib", 0}, info); // root-serialized
159 // TODO: reset the outputs once they are already sent (is it necessary?)
160 // mWorker.init();
161
162 if (opt.rootOutput == true) {
163 mOutputDir = opt.outputDir;
164 if (mOutputDir.compare("/dev/null")) {
165 mHistoFileName = fmt::format("{}{}{}_{}.root", mOutputDir, mOutputDir.back() == '/' ? "" : "/", fn, mRunNumber);
166 int rval = mWorker.saveDebugHistos(mHistoFileName);
167 if (rval) {
168 LOG(error) << "Cannot create output file " << mHistoFileName;
169 return;
170 }
171 std::string metaFileDir = opt.metaFileDir;
172 if (metaFileDir.compare("/dev/null")) {
173 mHistoFileMetaData->fillFileData(mHistoFileName);
174 mHistoFileMetaData->type = "calib";
175 mHistoFileMetaData->priority = "high";
176 std::string metaFileNameTmp = metaFileDir + (metaFileDir.back() == '/' ? "" : "/") + fmt::format("{}_{}.tmp", fn, mRunNumber);
177 std::string metaFileName = metaFileDir + (metaFileDir.back() == '/' ? "" : "/") + fmt::format("{}_{}.done", fn, mRunNumber);
178 try {
179 std::ofstream metaFileOut(metaFileNameTmp);
180 metaFileOut << *mHistoFileMetaData.get();
181 metaFileOut.close();
182 std::filesystem::rename(metaFileNameTmp, metaFileName);
183 } catch (std::exception const& e) {
184 LOG(error) << "Failed to store ZDC meta data file " << metaFileName << ", reason: " << e.what();
185 }
186 LOG(info) << "Stored metadata file " << metaFileName << ".done";
187 } else {
188 LOG(info) << "Did not store metafile as meta-dir=" << metaFileDir;
189 }
190 } else {
191 LOG(warn) << "Do not create output file since output dir is " << mOutputDir;
192 }
193 }
194}
195
197{
200
201 std::vector<InputSpec> inputs;
202 inputs.emplace_back("noisecalibdata", "ZDC", "NOISECALIBDATA", 0, Lifetime::Sporadic);
203 inputs.emplace_back("moduleconfig", "ZDC", "MODULECONFIG", 0, Lifetime::Condition, o2::framework::ccdbParamSpec(o2::zdc::CCDBPathConfigModule.data()));
204 inputs.emplace_back("noise_1dh", ConcreteDataTypeMatcher{"ZDC", "NOISE_1DH"}, Lifetime::Sporadic);
205 inputs.emplace_back("noise_1dh_s", ConcreteDataTypeMatcher{"ZDC", "NOISE_1DH_S"}, Lifetime::Sporadic);
206 inputs.emplace_back("noise_1dh_d", ConcreteDataTypeMatcher{"ZDC", "NOISE_1DH_D"}, Lifetime::Sporadic);
207
208 std::vector<OutputSpec> outputs;
209 outputs.emplace_back(ConcreteDataTypeMatcher{o2::calibration::Utils::gDataOriginCDBPayload, "ZDCNoisecalib"}, Lifetime::Sporadic);
210 outputs.emplace_back(ConcreteDataTypeMatcher{o2::calibration::Utils::gDataOriginCDBWrapper, "ZDCNoisecalib"}, Lifetime::Sporadic);
211
212 return DataProcessorSpec{
213 "zdc-calib-noise",
214 inputs,
215 outputs,
216 AlgorithmSpec{adaptFromTask<device>()},
217 Options{{"verbosity-level", o2::framework::VariantType::Int, 1, {"Verbosity level"}}}};
218}
219
220} // namespace zdc
221} // namespace o2
#define verbosity
ZDC calibration common parameters.
Timeframe settings Average distance in cm of events merged into Randomize distance around average distance of merged events Simulate correct bunch interactions instead of placing only the average number of events A value[n] sets TFlen for[n] collisions in Number of bunches per trainsort Number of bunch trains Instantaneous interaction rate Do not simulate border Total number of collisions to be placed in the interior of all time Do not select random but walk over array of events in stride steps h Event generator settings h configStandalone Use CPU for GPU Force usage of the specified GPU device no CPU fallback Continue processing after an error First event to Number of events to Number of iterations to Number of iterations to Number of initial iterations excluded from const char e
configStandalone Reconstruction rec_tpc multiplier for the combined cluster track error during track following area in cm for the search of for z only used if decrease removal by when above this local occupancy rowx Shift of TPC revert cluster flag edge bit distance to edge exceeds this ZOffset for secondary multiple of radius max P of electron K BB bands crossing max P of electron p BB bands crossing max P of electron d BB bands crossing max P of electron t BB bands crossing min accepted dEdxMaxTPC of the track Additive extra cluster error for Y2 if edge flag set Additive extra cluster error for Y2 if single set Additive extra cluster error for Y2 if or single set Additive extra cluster error for Z2 if or single set Extra errors to add to track when crossing depending on addErrorsCECrossing Inner portion of y range in sector that is not used in searching for extrapolated track candidates factor2YS for track merging factor2K for track merging Margin in cm of Y position when rejecting edge clusters based on uncorrected track Y Max fraction of shared clusters for tracklet Except pad from cluster finding if total number of charges in a fragment is above this Except pad from cluster finding if number of consecutive charges in a fragment is above this Threshold where a timebin is considered disabling the noisy pad check for that pad Treat signal above this minimum as saturated Smoothing factor for the exponential Highly Ionising Particle tail filter Number of timebins to use for the averaging Add additional custom track errors when crossing relative as fraction of Do N fit passes in final fit of< 0:reject at max -n hits") AddOptionRTC(rejectIFCLowRadiusCluster, uint8_t, 1, "", 0, "Reject clusters that get the IFC mask error during refit") AddOptionRTC(dEdxTruncLow, uint8_t, 2, "", 0, "Low truncation threshold, fraction of 128") AddOptionRTC(dEdxTruncHigh, uint8_t, 77, "", 0, "High truncation threshold, fraction of 128") AddOptionRTC(extrapolationTracking, int8_t, 1, "", 0, "Enable Extrapolation Tracking(prolong tracks to adjacent sectors to find short segments)") AddOptionRTC(disableRefitAttachment, uint8_t, 0, "", 0, "Bitmask to disable certain attachment steps during refit(1:attachment, 2:propagation, 4:loop following, 8:mirroring)") AddOptionRTC(rejectionStrategy, uint8_t, o2::gpu::GPUSettings::RejectionStrategyA, "", 0, "Enable rejection of TPC clusters for compression(0=no, 1=strategy A, 2=strategy B)") AddOptionRTC(mergeLoopersAfterburner, uint8_t, 1, "", 0, "Run afterburner for additional looper merging") AddOptionRTC(compressionTypeMask, uint8_t, o2::gpu::GPUSettings::CompressionFull, "", 0, "TPC Compression mode bits(1=truncate charge/width LSB, 2=differences, 4=track-model)") AddOptionRTC(compressionSortOrder, uint8_t, o2::gpu::GPUSettings::SortTime, "", 0, "Sort order of TPC compression(0=time, 1=pad, 2=Z-time-pad, 3=Z-pad-time, 4=no sorting(use incoming order))") AddOptionRTC(sigBitsCharge, uint8_t, 4, "", 0, "Number of significant bits for TPC cluster charge in compression mode 1") AddOptionRTC(sigBitsWidth, uint8_t, 3, "", 0, "Number of significant bits for TPC cluster width in compression mode 1") AddOptionRTC(dropLoopers, uint8_t, 0, "", 0, "Drop looping tracks starting from second loop") AddOptionRTC(mergerInterpolateErrors, uint8_t, 1, "", 0, "Use interpolation instead of extrapolation for chi2 based cluster rejection") AddOptionRTC(mergerInterpolateRejectAlsoOnCurrentPosition, uint8_t, 1, "", 0, "When using mergerInterpolateErrors, reject based on chi2 twice computed with interpolated and current track position starting from NDF > mergerNonInterpolateRejectMinNDF Merge tracks accross the central electrode Enable PID response Add sub threshold clusters in TPC dEdx computation OR mask of TPC flags that will reject the cluster in alternative dEdx Reject edge clusters based on uncorrected track Y during track fit Increase decrease removal by when on this number of pads from the edge h configStandalone Reconstruction rec_trd Max chi2 for TRD tracklets to be matched to a track Chi2 cut for strict matching mode Number of sigmas for ITS TPC track time error estimate Addition to search road around track prolongation along Y in cm Optimal tracklet rphi resolution in maximum chi2 per attached tracklet for TRD tracks take into account the full likelihood of the slope including exponential tails Tracks with less attached tracklets are discarded after the tracking Post trigger Pile up integration time in BCs fits all iterations but the last one in projections Use material lookup table for TPC refit Apply workarounds to avoid cyclic merge should not be needed tpc dyn configStandalone Processing proc_rtc Replace constant variables static by constexpr expressions Compile RTC in deterministic with NO_FAST_MATH flags and GPUCA_DETERMINISTIC_MODE define Use RTC to optimize GPU code h configStandalone Processing proc_rtctech Use a file lock to serialize access to the cache folder Print launch bounds used for RTC code as debugging for exit after Allow RTC with slave GPUReconstruction instances with optConstexpr and optSpecialcode Maximum number of RTC cache files per backend in the cache the oldest are Prepend RTC compilation commands by this string Load a parameter object containing the launch bounds from a file h configStandalone Processing proc_param TPC Cluster Z Error Parameterization h configStandalone Processing settings for neural network proc_nn std::string Specify inference device(cpu(default), rocm, cuda)") AddOption(nnInferenceDeviceId
char error[CURL_ERROR_SIZE]
A helper class to iteratate over all parts of all input routes.
void output(const std::map< std::string, ChannelStat > &channels)
Definition rawdump.cxx:197
Definition of the Names Generator class.
Format of noise calibration intermediate data.
void snapshot(const Output &spec, T const &object)
ConfigParamRegistry const & options()
Definition InitContext.h:33
A helper class to iteratate over all parts of all input routes.
decltype(auto) get(R binding, int part=0) const
DataAllocator & outputs()
The data allocator is used to allocate memory for the output data.
InputRecord & inputs()
The inputs associated with this processing context.
ServiceRegistryRef services()
The services registry associated with this processing context.
void finaliseCCDB(o2::framework::ConcreteDataMatcher &matcher, void *obj) final
void init(o2::framework::InitContext &ic) final
void updateTimeDependentParams(o2::framework::ProcessingContext &pc)
void sendOutput(o2::framework::EndOfStreamContext &ec)
void run(o2::framework::ProcessingContext &pc) final
void endOfStream(o2::framework::EndOfStreamContext &ec) final
This is invoked whenever we have an EndOfStream event.
void add(int ih, int iarr, o2::dataformats::FlatHisto1D< double > &h1)
void setVerbosity(int v)
Definition NoiseCalib.h:48
int process(const o2::zdc::NoiseCalibSummaryData *data)
CcdbObjectInfo & getCcdbObjectInfo()
Definition NoiseCalib.h:46
NoiseParam & getParam()
Definition NoiseCalib.h:52
int saveDebugHistos(const std::string fn="ZDCNoiseCalib.root")
void setModuleConfig(const ModuleConfig *moduleConfig)
Definition NoiseCalib.h:34
GLeglImageOES image
Definition glcorearb.h:4021
Defining ITS Vertex explicitly as messageable.
Definition Cartesian.h:288
std::vector< ConfigParamSpec > ccdbParamSpec(std::string const &path, int runDependent, std::vector< CCDBMetadata > metadata={}, int qrate=0)
struct o2::upgrades_utils::@482 zdc
structure to keep FT0 information
framework::DataProcessorSpec getNoiseCalibSpec()
constexpr int DbgMinimal
Definition Constants.h:208
constexpr int DbgZero
Definition Constants.h:207
const std::string CCDBPathConfigModule
Definition Constants.h:219
a couple of static helper functions to create timestamp values for CCDB queries or override obsolete ...
static constexpr o2::header::DataOrigin gDataOriginCDBWrapper
Definition Utils.h:44
static constexpr o2::header::DataOrigin gDataOriginCDBPayload
Definition Utils.h:43
LOG(info)<< "Compressed in "<< sw.CpuTime()<< " s"