10#include <dqm/analysis/modules/DQMHistAnalysisKLM2.h>
13#include <klm/dataobjects/KLMChannelIndex.h>
32 setDescription(
"Module used to analyze KLM Efficiency DQM histograms (depends on tracking variables).");
35 std::string(
"KLMEfficiencyDQM"));
44 addParam(
"RatioPlot",
m_ratio,
"2D efficiency ratio or difference plot ",
bool(
true));
67 registerEpicsPV(
"KLM:Eff:uncertaintyThreshold",
"uncertaintyThreshold");
70 registerEpicsPV(
"KLM:EFF:deltaEffStopThreshold",
"deltaEffStopThreshold");
82 "Plane Efficiency in BKLM",
84 m_eff_bklm->GetXaxis()->SetTitle(
"Layer number");
89 "Plane Efficiency in EKLM",
91 m_eff_eklm->GetXaxis()->SetTitle(
"Plane number");
96 "Sector Efficiency in BKLM",
103 "Sector Efficiency in EKLM",
123 TString eff2d_hist_bklm_title;
124 TString eff2d_hist_eklm_title;
126 eff2d_hist_bklm_title =
"Plane Efficiency Ratios in BKLM";
127 eff2d_hist_eklm_title =
"Plane Efficiency Ratios in EKLM";
129 eff2d_hist_bklm_title =
"Plane Efficiency Diffs in BKLM";
130 eff2d_hist_eklm_title =
"Plane Efficiency Diffs in EKLM";
149 std::string BB_sec =
"BB" + std::to_string(sec_id);
150 m_eff2d_bklm->GetXaxis()->SetBinLabel(sec_id + 1, BB_sec.c_str());
152 std::string BF_sec =
"BF" + std::to_string(sec_id);
157 std::string B_lay = std::to_string(lay_id);
158 m_eff2d_bklm->GetYaxis()->SetBinLabel(lay_id + 1, B_lay.c_str());
165 n_sectors_eklm, 0.5, n_sectors_eklm + 0.5,
172 n_sectors_eklm, 0.5, n_sectors_eklm + 0.5,
180 for (
int layerGlobal = 1; layerGlobal <= maximalLayer; ++layerGlobal) {
183 layerGlobal, §ion, &layer);
188 name += std::to_string(layer);
189 m_eff2d_eklm->GetXaxis()->SetBinLabel(layerGlobal, name.c_str());
193 std::string E_lay = std::to_string(lay_id);
194 m_eff2d_eklm->GetYaxis()->SetBinLabel(lay_id + 1, E_lay.c_str());
207 B2INFO(
"DQMHistAnalysisKLM2: " + histName +
" histogram was found in reference");
208 hist->SetLineColor(2);
209 hist->SetOption(
"HIST");
210 hist->SetStats(
false);
212 B2WARNING(
"DQMHistAnalysisKLM2: " + histName +
" histogram not found in reference");
213 hist =
new TH1F(histName.c_str(), title.c_str(), maxLayer, 0.5, 0.5 + maxLayer);
214 for (
int lay_id = 0; lay_id < maxLayer; lay_id++) {
215 hist->SetBinContent(lay_id + 1,
m_ratio ? 1 : 0);
265 if (bin < bklmMaxSector)
269 name += std::to_string(bin % bklmMaxSector);
275 if (bin < eklmLocalMaxSector)
279 name += std::to_string(bin % eklmLocalMaxSector);
284 for (
int layer = 0; layer <
m_eff_bklm->GetXaxis()->GetNbins(); layer++) {
287 if (layer / bklmMaxLayer < bklmMaxSector) {
292 name += std::to_string(
int(layer / bklmMaxLayer) % bklmMaxSector) +
"_layer" + std::to_string(1 + (layer % bklmMaxLayer));
295 for (
int layer = 0; layer <
m_eff_eklm->GetXaxis()->GetNbins(); layer++) {
297 if (layer / eklmGlobalMaxSector < eklmBLayerCount)
298 name +=
"B" + std::to_string(layer / eklmGlobalMaxSector + 1);
300 name +=
"F" + std::to_string(layer / eklmGlobalMaxSector - eklmBLayerCount + 1);
301 name += +
"_num" + std::to_string(((layer) % eklmGlobalMaxSector) + 1);
310 std::unique_ptr<TH1> effClone(
static_cast<TH1*
>
313 if (denominator !=
nullptr && numerator !=
nullptr) {
314 effHist->Divide(numerator, denominator, 1, 1,
"B");
319 if (ref) {ref->Draw(
"hist,same");}
325 auto deltaDenom =
getDelta(
"", denominator->GetName());
326 auto deltaNumer =
getDelta(
"", numerator->GetName());
332 if ((deltaNumer !=
nullptr) && (deltaDenom !=
nullptr)) {
333 B2INFO(
"DQMHistAnalysisKLM2: Eff Delta Num/Denom Entries is " << deltaNumer->GetEntries() <<
"/" << deltaDenom->GetEntries());
334 effClone->Divide(deltaNumer, deltaDenom, 1, 1,
"B");
335 effClone->SetLineColor(kOrange);
336 effClone->DrawCopy(
"SAME");
344 const std::string& histName, TH1* histogram)
348 if (canvas == NULL) {
353 histogram->SetStats(
false);
354 double histMin = gPad->GetUymin();
355 double histMax = gPad->GetUymax();
356 double histRange = histMax - histMin;
357 if (histName.find(
"bklm") != std::string::npos) {
361 int bin = maximalLayer * sector + 1;
362 double xLine = histogram->GetXaxis()->GetBinLowEdge(bin);
363 double xText = histogram->GetXaxis()->GetBinLowEdge(bin + maximalLayer / 2);
364 double yText = histMin + 0.98 * histRange;
366 m_PlaneLine.DrawLine(xLine, histMin, xLine, histMin + histRange);
380 for (
int layerGlobal = 1; layerGlobal <= maximalLayer; ++layerGlobal) {
381 int bin = maxPlane * layerGlobal + 1;
382 double xLine = histogram->GetXaxis()->GetBinLowEdge(bin);
383 double xText = histogram->GetXaxis()->GetBinLowEdge(bin - maxPlane / 2);
384 double yText = histMin + 0.98 * histRange;
385 if (layerGlobal < maximalLayer)
386 m_PlaneLine.DrawLine(xLine, histMin, xLine, histMin + histRange);
389 layerGlobal, §ion, &layer);
394 name += std::to_string(layer);
404 TH1* mainHist, TH1* refHist, TH2* eff2dHist, TH2* errHist,
int layers,
int sectors,
bool ratioPlot,
405 int& pvcount,
double layerLimit, TCanvas* eff2dCanv)
413 float maxVal =
m_max;
414 float minVal =
m_min;
416 bool setAlarm =
false;
417 bool setWarn =
false;
425 mainEntries = mainHist->GetEntries();
427 for (
int binx = 0; binx < sectors; binx++) {
429 for (
int biny = 0; biny < layers; biny++) {
431 mainEff = mainHist->GetBinContent(i + 1);
432 mainErr = mainHist->GetBinError(i + 1);
434 refEff = refHist->GetBinContent(i + 1);
435 refErr = refHist->GetBinError(i + 1);
441 if ((mainEff == 0.) and (refEff == 0.)) {
443 eff2dHist->SetBinContent(binx + 1, biny + 1, 0.);
444 }
else if ((refEff == 0.) and (ratioPlot)) {
446 eff2dHist->SetBinContent(binx + 1, biny + 1, maxVal);
447 }
else if (mainEff == 0.) {
449 eff2dHist->SetBinContent(binx + 1, biny + 1, 0.);
450 errHist->SetBinContent(binx + 1, biny + 1, 0.);
456 eff2dVal = mainEff / refEff;
458 sigmaR = eff2dVal *
sqrt(pow(mainErr / mainEff, 2) + pow(refErr / refEff, 2));
466 sigmaR = pow(pow(mainErr, 2) + pow(refErr, 2), 0.5);
467 eff2dVal = (mainEff - refEff);
469 Z = eff2dVal / sigmaR;
473 if ((eff2dVal > minVal) and (eff2dVal < maxVal)) {
475 eff2dHist->SetBinContent(binx + 1, biny + 1, eff2dVal);
476 }
else if (eff2dVal > maxVal) {
478 eff2dHist->SetBinContent(binx + 1, biny + 1, maxVal);
479 }
else if (eff2dVal < minVal) {
481 eff2dHist->SetBinContent(binx + 1, biny + 1, minVal);
490 errHist->SetBinContent(binx + 1, biny + 1, sigmaR);
494 errHist->SetBinContent(binx + 1, biny + 1, sigmaR);
498 errHist->SetBinContent(binx + 1, biny + 1, sigmaR);
515 if ((pvcount - layercount) > (
int) layerLimit) {
518 if (layercount > (
int) layerLimit) {
522 eff2dHist->SetMinimum(minVal);
523 eff2dHist->SetMaximum(maxVal);
526 eff2dHist->Draw(
"COLZ");
527 errHist->Draw(
"TEXT SAME");
530 }
else if (setAlarm) {
532 }
else if (setWarn) {
537 eff2dCanv->Modified();
544 TH1* daqInclusion =
findHist(
"KLM/daq_inclusion");
545 if (not(daqInclusion == NULL)) {
546 int isKlmIncluded = daqInclusion->GetBinContent(daqInclusion->GetXaxis()->FindBin(
"Yes"));
547 if (isKlmIncluded == 0)
567 if ((all_ext_bklm ==
nullptr || matched_hits_bklm ==
nullptr) && (
m_IsPhysicsRun)) {
568 B2INFO(
"Histograms needed for BKLM plane efficiency computation are not found");
571 if ((all_ext_eklm ==
nullptr || matched_hits_eklm ==
nullptr) && (
m_IsPhysicsRun)) {
572 B2INFO(
"Histograms needed for EKLM plane efficiency computation are not found");
574 if ((all_ext_bklm_sector ==
nullptr || matched_hits_bklm_sector ==
nullptr) && (
m_IsPhysicsRun)) {
575 B2INFO(
"Histograms needed for BKLM sector efficiency computation are not found");
577 if ((all_ext_eklm_sector ==
nullptr || matched_hits_eklm_sector ==
nullptr) && (
m_IsPhysicsRun)) {
578 B2INFO(
"Histograms needed for EKLM sector efficiency computation are not found");
602 B2DEBUG(20,
"DQMHistAnalysisKLM2: Updating EPICS PVs");
606 B2INFO(
"DQMHistAnalysisKLM2: Null run detected. No PV Update.");
609 auto* daqDataSize =
findHist(
"DAQ/KLMDataSize");
610 double meanDAQDataSize = 0.;
611 if (daqDataSize !=
nullptr) {
612 meanDAQDataSize = daqDataSize->GetMean();
613 B2INFO(
"DAQ/KLMDataSize's mean is " << meanDAQDataSize);
615 B2WARNING(
"DQMHistAnalysisKLM2: Cannot find KLMDataSize");
616 if ((daqDataSize !=
nullptr) and (meanDAQDataSize != 0.)) {
627 B2INFO(
"DQMHistAnalysisKLM2: KLM Not included. No PV Update. ");
static constexpr int getMaximalLayerGlobalNumber()
Get maximal layer global number.
static constexpr int getMaximalLayerNumber()
Get maximal layer number (1-based).
static constexpr int getMaximalSectorNumber()
Get maximal sector number (1-based).
static constexpr int getMaximalSectorGlobalNumber()
Get maximal sector global number.
TH1 * m_ref_efficiencies_bklm
BKLM efficiencies reference histogram.
TLine m_PlaneLine
TLine for boundary in plane histograms.
int m_nEffEKLMLayers
Number of inefficient EKLM Layers.
void initialize() override final
Initializer.
double m_stopThr
efficiency ratio (run-)stop threshold
TCanvas * m_c_eff2d_bklm
BKLM efficiencies ratio canvas.
std::string m_refHistogramDirectoryName
Name of histogram directory for reference file.
TCanvas * m_c_eff2d_eklm
EKLM efficiencies ratio canvas.
TH1 * m_eff_bklm_sector
Histogram for BKLM sector efficiency.
void processPlaneHistogram(const std::string &histName, TH1 *histogram)
Process histogram containing the number of hits in plane.
bool m_IsPhysicsRun
Run type flag for null runs.
double m_minEntries
Minimal number of entries for delta histogram and PV update.
double m_alarmThr
efficiency ratio alarm threshold
double m_zEffThreshold
efficiency threshold for z-score calculation
TH1 * m_eff_eklm
Histogram for EKLM plane efficiency.
void processEfficiencyHistogram(TH1 *effHist, TH1 *denominator, TH1 *numerator, TCanvas *canvas)
Process histogram containing the efficiencies.
TCanvas * m_c_eff_eklm_sector
Histogram for EKLM sector efficiency.
const EKLMElementNumbers * m_EklmElementNumbers
EKLM element numbers.
TH1 * m_eff_eklm_sector
Histogram for EKLM sector efficiency.
float m_max
efficiency ratio max z scale
MonitoringObject * m_monObj
Monitoring object.
TH1 * m_ref_efficiencies_eklm
ELM efficiencies reference histogram.
double m_errorThreshold
uncertainty threshold for low statistics
void event() override final
This method is called for each event.
void process2DEffHistogram(TH1 *mainHist, TH1 *refHist, TH2 *planeHist, TH2 *errHist, int layers, int sectors, bool ratioPlot, int &pvcount, double layerLimit, TCanvas *eff2dCanv)
Process 2D efficiency histograms.
TCanvas * m_c_eff_bklm_sector
Histogram for BKLM sector efficiency.
std::string m_histogramDirectoryName
Name of histogram directory.
TH2 * m_err_bklm
BKLM efficiencies error histogram.
float m_min
efficiency ratio min z scale
TH2 * m_eff2d_bklm
BKLM efficiencies 2dim histogram.
TH1 * m_eff_bklm
Histogram for BKLM plane efficiency.
TCanvas * m_c_eff_bklm
BKLM plane efficiency canvas.
TText m_PlaneText
TText for names in plane histograms.
TCanvas * m_c_eff_eklm
EKLM plane efficiency canvas.
void endRun() override final
This method is called if the current run ends.
double m_BKLMLayerAlarm
alarm limits from inefficient BKLM layers PV
void beginRun() override final
Called when entering a new run.
void initialize2DRefHistogram(TH1 *&hist, const std::string &histName, const std::string &title, int maxLayer)
Initialize a histogram by either finding a reference histogram or creating a new one.
double m_zThreshold
z-score threshold for inefficient layers
bool m_ratio
show efficiency ratio or difference
double m_EKLMLayerAlarm
alarm limits from inefficient EKLM layers PV
TH2 * m_err_eklm
EKLM efficiencies error histogram.
bool m_IsNullRun
Run type flag for null runs.
TH2 * m_eff2d_eklm
EKLM efficiencies 2dim histogram.
int m_nEffBKLMLayers
Number of inefficient BKLM layers.
double m_warnThr
efficiency ratio warning threshold
DQMHistAnalysisKLM2Module()
Constructor.
TCanvas * findCanvas(TString cname)
Find canvas by name.
static TH1 * findRefHist(const std::string &histname, ERefScaling scaling=ERefScaling::c_RefScaleNone, const TH1 *hist=nullptr)
Get referencehistogram from list (no other search).
static MonitoringObject * getMonitoringObject(const std::string &name)
Get MonitoringObject with given name (new object is created if non-existing)
void addDeltaPar(const std::string &dirname, const std::string &histname, HistDelta::EDeltaType t, int p, unsigned int a=1)
Add Delta histogram parameters.
void colorizeCanvas(TCanvas *canvas, EStatus status)
Helper function for Canvas colorization.
static TH1 * findHist(const std::string &histname, bool onlyIfUpdated=false)
Get histogram from list (no other search).
static const std::string & getRunType(void)
Get the list of the reference histograms.
TH1 * getDelta(const std::string &fullname, int n=0, bool onlyIfUpdated=true)
Get Delta histogram.
void setEpicsPV(std::string keyname, double value)
Write value to a EPICS PV.
DQMHistAnalysisModule()
Constructor / Destructor.
@ c_StatusTooFew
Not enough entries/event to judge.
@ c_StatusError
Analysis result: Severe issue found.
@ c_StatusWarning
Analysis result: Warning, there may be minor issues.
@ c_StatusGood
Analysis result: Good.
@ c_RefScaleNone
no scaling
static int getEventProcessed(void)
Get the number of processed events.
int registerEpicsPV(std::string pvname, std::string keyname="")
EPICS related Functions.
void UpdateCanvas(std::string name, bool updated=true)
Mark canvas as updated (or not)
bool requestLimitsFromEpicsPVs(chid id, double &lowerAlarm, double &lowerWarn, double &upperWarn, double &upperAlarm)
Get Alarm Limits from EPICS PV.
static constexpr int getMaximalLayerGlobalNumber()
Get maximal detector layer global number.
static constexpr int getMaximalPlaneGlobalNumber()
Get maximal plane global number.
@ c_BackwardSection
Backward.
static constexpr int getMaximalSectorNumber()
Get maximal sector number.
static constexpr int getMaximalPlaneNumber()
Get maximal plane number.
static constexpr int getMaximalSectorGlobalNumberKLMOrder()
Get maximal sector global number with KLM ordering (section, sector).
void setDescription(const std::string &description)
Sets the description of the module.
void addParam(const std::string &name, T ¶mVariable, const std::string &description, const T &defaultValue)
Adds a new parameter to the module.
#define REG_MODULE(moduleName)
Register the given module (without 'Module' suffix) with the framework.
double sqrt(double a)
sqrt for double
Abstract base class for different kinds of events.