Project
Loading...
Searching...
No Matches
GainCalibratorSpec.h
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
12#include "Framework/Task.h"
17#include "CCDB/CcdbApi.h"
18#include "CCDB/CcdbObjectInfo.h"
25
26using namespace o2::framework;
27
28namespace o2
29{
30namespace calibration
31{
33{
34 public:
35 CPVGainCalibratorSpec(std::shared_ptr<o2::base::GRPGeomRequest> req) : mCCDBRequest(req) {}
36
37 //_________________________________________________________________
39 {
41 auto updateInterval = ic.options().get<uint32_t>("updateInterval"); // in TF
42 bool updateAtTheEndOfRunOnly = ic.options().get<bool>("updateAtTheEndOfRunOnly");
43 mCalibrator = std::make_unique<o2::cpv::GainCalibrator>();
44 mCalibrator->setSlotLength(0); // infinite TF slot
45 mCalibrator->setMaxSlotsDelay(10000);
46 if (updateAtTheEndOfRunOnly) {
47 mCalibrator->setUpdateAtTheEndOfRunOnly();
48 }
49 mCalibrator->setCheckIntervalInfiniteSlot(updateInterval);
50 LOG(info) << "CPVGainCalibratorSpec initialized";
51 LOG(info) << "tf-per-slot = 0 (inconfigurable, this calibrator works only in single infinite slot mode)";
52 LOG(info) << "max-delay = 10000 (inconfigurable for this calibrator)";
53 LOG(info) << "updateInterval = " << updateInterval;
54 LOG(info) << "updateAtTheEndOfRunOnly = " << updateAtTheEndOfRunOnly;
55 }
56
57 void finaliseCCDB(o2::framework::ConcreteDataMatcher& matcher, void* obj) final
58 {
60 }
61
62 //_________________________________________________________________
64 {
66 o2::base::TFIDInfoHelper::fillTFIDInfo(pc, mCalibrator->getCurrentTFInfo());
67 TFType tfcounter = mCalibrator->getCurrentTFInfo().startTime;
68
69 // update config
70 static bool isConfigFetched = false;
71 if (!isConfigFetched) {
72 LOG(info) << "GainCalibratorSpec::run() : fetching o2::cpv::CPVCalibParams from CCDB";
73 pc.inputs().get<o2::cpv::CPVCalibParams*>("calibparams");
74 LOG(info) << "GainCalibratorSpec::run() : o2::cpv::CPVCalibParams::Instance() now is following:";
76 mCalibrator->configParameters();
77 isConfigFetched = true;
78 }
79
80 // previous gains
81 if (!mCalibrator->isSettedPreviousGains()) {
82 const auto previousGains = pc.inputs().get<o2::cpv::CalibParams*>("gains");
83 if (previousGains) {
84 mCalibrator->setPreviousGains(new o2::cpv::CalibParams(*previousGains));
85 LOG(info) << "GainCalibratorSpec()::run() : I got previous gains";
86 }
87 }
88
89 // previous calib data
90 if (!mCalibrator->isSettedPreviousGainCalibData()) {
91 // const auto previousGainCalibData = o2::framework::DataRefUtils::as<CCDBSerialized<o2::cpv::GainCalibData>>(pc.inputs().get("calibdata"));
92 const auto previousGainCalibData = pc.inputs().get<o2::cpv::GainCalibData*>("calibdata");
93 if (previousGainCalibData) {
94 mCalibrator->setPreviousGainCalibData(new o2::cpv::GainCalibData(*previousGainCalibData));
95 LOG(info) << "GainCalibratorSpec()::run() : I got previous GainCalibData: ";
96 previousGainCalibData->print();
97 }
98 }
99
100 // process calib input
101 auto&& digits = pc.inputs().get<gsl::span<o2::cpv::Digit>>("calibdigs");
102
103 // fill statistics
104 LOG(detail) << "Processing TF " << tfcounter << " with " << digits.size() << " digits";
105 mCalibrator->process(digits); // fill TimeSlot with digits from 1 event and check slots for finalization
106
107 // inform about results and send output to ccdb
108 auto gainsInfoVecSize = mCalibrator->getCcdbInfoGainsVector().size();
109 if (gainsInfoVecSize) {
110 LOG(info) << "Created " << gainsInfoVecSize << " o2::cpv::CalibParams objects.";
111 sendOutput(pc.outputs());
112 }
113
114 // and send results to CCDB (if any)
115 if (gainsInfoVecSize) {
116 sendOutput(pc.outputs());
117 }
118 }
120 {
121 // prepare GainCalibData outputs and send it to ccdb
122 mCalibrator->prepareForEnding();
123 auto gainCDInfoVecSize = mCalibrator->getCcdbInfoGainCalibDataVector().size();
124 if (gainCDInfoVecSize) {
125 LOG(info) << "Created " << gainCDInfoVecSize << " o2::cpv::GainCalibData objects.";
126 sendOutput(ec.outputs());
127 }
128 }
129 //_________________________________________________________________
130 private:
131 std::unique_ptr<o2::cpv::GainCalibrator> mCalibrator;
132 std::shared_ptr<o2::base::GRPGeomRequest> mCCDBRequest;
133 //_________________________________________________________________
134 void sendOutput(DataAllocator& output)
135 {
136 bool isSomethingSent = false;
137 isSomethingSent = sendOutputWhat<o2::cpv::CalibParams>(mCalibrator->getGainsVector(), mCalibrator->getCcdbInfoGainsVector(), "CPV_Gains", output);
138 isSomethingSent += sendOutputWhat<o2::cpv::GainCalibData>(mCalibrator->getGainCalibDataVector(), mCalibrator->getCcdbInfoGainCalibDataVector(), "CPV_GainCD", output);
139
140 if (isSomethingSent) {
141 mCalibrator->initOutput(); // reset the outputs once they are already sent
142 }
143 }
144
145 template <class Payload>
146 bool sendOutputWhat(const std::vector<Payload>& payloadVec, std::vector<o2::ccdb::CcdbObjectInfo>& infoVec, header::DataDescription what, DataAllocator& output)
147 {
148 assert(payloadVec.size() == infoVec.size());
149 if (!payloadVec.size()) {
150 return false;
151 }
152
153 for (uint32_t i = 0; i < payloadVec.size(); i++) {
154 auto& w = infoVec[i];
155 auto image = o2::ccdb::CcdbApi::createObjectImage(&payloadVec[i], &w);
156 LOG(info) << "Sending object " << w.getPath() << "/" << w.getFileName() << " of size " << image->size()
157 << " bytes, valid for " << w.getStartValidityTimestamp() << " : " << w.getEndValidityTimestamp();
158 output.snapshot(Output{o2::calibration::Utils::gDataOriginCDBPayload, what, i}, *image.get()); // vector<char>
159 output.snapshot(Output{o2::calibration::Utils::gDataOriginCDBWrapper, what, i}, w); // root-serialized
160 }
161
162 return true;
163 }
164 //_________________________________________________________________
165}; // class CPVGainCalibratorSpec
166} // namespace calibration
167
168namespace framework
169{
170DataProcessorSpec getCPVGainCalibratorSpec()
171{
173
174 std::vector<InputSpec> inputs;
175 inputs.emplace_back("calibdigs", "CPV", "CALIBDIGITS", 0, Lifetime::Timeframe);
176 inputs.emplace_back("calibdata", "CPV", "CPV_GainCD", 0, Lifetime::Condition, ccdbParamSpec("CPV/PhysicsRun/GainCalibData"));
177 inputs.emplace_back("gains", "CPV", "CPV_Gains", 0, Lifetime::Condition, ccdbParamSpec("CPV/Calib/Gains"));
178 inputs.emplace_back("calibparams", "CPV", "CPV_CalibPars", 0, Lifetime::Condition, ccdbParamSpec("CPV/Config/CPVCalibParams"));
179
180 auto ccdbRequest = std::make_shared<o2::base::GRPGeomRequest>(true, // orbitResetTime
181 true, // GRPECS=true
182 false, // GRPLHCIF
183 false, // GRPMagField
184 false, // askMatLUT
186 inputs);
187 std::vector<OutputSpec> outputs;
188 // Length of data description ("CPV_Pedestals") must be < 16 characters.
189 outputs.emplace_back(ConcreteDataMatcher{o2::calibration::Utils::gDataOriginCDBPayload, "CPV_Gains", 0}, Lifetime::Sporadic);
190 outputs.emplace_back(ConcreteDataMatcher{o2::calibration::Utils::gDataOriginCDBWrapper, "CPV_Gains", 0}, Lifetime::Sporadic);
191 outputs.emplace_back(ConcreteDataMatcher{o2::calibration::Utils::gDataOriginCDBPayload, "CPV_GainCD", 0}, Lifetime::Sporadic);
192 outputs.emplace_back(ConcreteDataMatcher{o2::calibration::Utils::gDataOriginCDBWrapper, "CPV_GainCD", 0}, Lifetime::Sporadic);
193
194 return DataProcessorSpec{
195 "cpv-gain-calibration",
196 inputs,
197 outputs,
198 AlgorithmSpec{adaptFromTask<device>(ccdbRequest)},
199 Options{
200 {"updateAtTheEndOfRunOnly", VariantType::Bool, false, {"finalize the slots and prepare the CCDB entries only at the end of the run."}},
201 {"updateInterval", VariantType::UInt32, 100u, {"try to finalize the slot (and produce calibration) when the updateInterval has passed."}}}};
202}
203} // namespace framework
204} // namespace o2
Utils and constants for calibration and related workflows.
unsigned int uint32_t
int32_t i
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
Helper for geometry and GRP related CCDB requests.
void output(const std::map< std::string, ChannelStat > &channels)
Definition rawdump.cxx:197
void checkUpdates(o2::framework::ProcessingContext &pc)
bool finaliseCCDB(o2::framework::ConcreteDataMatcher &matcher, void *obj)
static GRPGeomHelper & instance()
void setRequest(std::shared_ptr< GRPGeomRequest > req)
CPVGainCalibratorSpec(std::shared_ptr< o2::base::GRPGeomRequest > req)
void endOfStream(o2::framework::EndOfStreamContext &ec) final
This is invoked whenever we have an EndOfStream event.
void init(o2::framework::InitContext &ic) final
void finaliseCCDB(o2::framework::ConcreteDataMatcher &matcher, void *obj) final
void run(o2::framework::ProcessingContext &pc) final
static std::unique_ptr< std::vector< char > > createObjectImage(const T *obj, CcdbObjectInfo *info=nullptr)
Definition CcdbApi.h:109
void printKeyValues(bool showProv=true, bool useLogger=false, bool withPadding=true, bool showHash=true) const final
GLeglImageOES image
Definition glcorearb.h:4021
GLubyte GLubyte GLubyte GLubyte w
Definition glcorearb.h:852
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)
a couple of static helper functions to create timestamp values for CCDB queries or override obsolete ...
static void fillTFIDInfo(o2::framework::ProcessingContext &pc, o2::dataformats::TFIDInfo &ti)
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"
std::vector< Digit > digits