Belle II Software development
CDCDedxCosineAlgorithm Class Reference

A calibration algorithm for CDC dE/dx electron cos(theta) dependence. More...

#include <CDCDedxCosineAlgorithm.h>

Inheritance diagram for CDCDedxCosineAlgorithm:
CalibrationAlgorithm

Classes

struct  FitValues
 Container for Gaussian fit results of a histogram. More...
 

Public Types

enum  EResult {
  c_OK ,
  c_Iterate ,
  c_NotEnoughData ,
  c_Failure ,
  c_Undefined
}
 The result of calibration. More...
 

Public Member Functions

 CDCDedxCosineAlgorithm ()
 Constructor: Sets the description, the properties and the parameters of the algorithm.
 
virtual ~CDCDedxCosineAlgorithm ()
 Destructor.
 
void setMethodSep (bool value=true)
 function to make flag active for method of sep
 
void setMonitoringPlots (bool value=false)
 function to make flag active for plotting
 
void setMergePayload (bool value=true)
 function to decide merge vs relative gains
 
void setFitWidth (double value=2.5)
 set sigma to restrict fit range around mean
 
void setCosineBins (unsigned int value=100)
 function to set number of cosine bins for calibration
 
void setCosineRange (double min=-1.0, double max=1.0)
 function to set min/max range of cosine for calibration
 
void setHistBins (int value=250)
 function to set nbins of dedx dist for calibration
 
void setHistRange (double min=0.0, double max=5.0)
 function to set min/max range of dedx dist for calibration
 
void setSuffix (const std::string &value)
 adding suffix to control plots
 
void getExpRunInfo ()
 function to extract calibration run/exp
 
void defineHisto (std::vector< TH1D * > &hdedx, const std::string &tag, const std::string &chargeLabel)
 function to define dE/dx histograms
 
TH1D * defineCosthHist (const std::string &tag)
 function to define cosine histograms
 
void fitGaussianWithRange (TH1D *&temphist, TString &status)
 function to fit histogram in each cosine bin
 
void createPayload (std::vector< double > cosine)
 function to store new payload after full calibration
 
void plotdedxHist (std::vector< TH1D * > &hDedxCos_all, std::vector< TH1D * > &hDedxCos_neg, std::vector< TH1D * > &hDedxCos_pos)
 function to draw the dE/dx histogram in costh bins
 
void setHist (TH1D *h, int color, const char *title, double ymin, double ymax, int marker=20)
 Set basic style (color, marker, title, y-range) for a TH1D histogram.
 
void plotCosThetaDist (TH1D *hCosth_all, TH1D *hCosth_pos, TH1D *hCosth_neg)
 Plot cos(theta) distributions for all, positive, and negative tracks.
 
void plotFitResults (const std::vector< std::vector< double > > &dedxAll, const std::vector< std::vector< double > > &dedxNeg, const std::vector< std::vector< double > > &dedxPos)
 Plot dE/dx fit results for all, negative, and positive tracks.
 
void plotEventStats ()
 function to draw the stats plots
 
void plotConstants ()
 function to draw the old/new final constants
 
unsigned int getRepresentativeLayer (unsigned int igroup) const
 Representative CDC layer for each SL group (used to access group-wise constants): SL0 => 1, SL1 => 9, SL2-8 => 17.
 
const std::string & getPrefix () const
 Get the prefix used for getting calibration data.
 
const std::string & getCollectorName () const
 Alias for prefix.
 
void setPrefix (const std::string &prefix)
 Set the prefix used to identify datastore objects.
 
void setInputFileNames (PyObject *inputFileNames)
 Set the input file names used for this algorithm from a Python list.
 
PyObject * getInputFileNames ()
 Get the input file names used for this algorithm and pass them out as a Python list of unicode strings.
 
std::vector< Calibration::ExpRun > getRunListFromAllData () const
 Get the complete list of runs from inspection of collected data.
 
RunRange getRunRangeFromAllData () const
 Get the complete RunRange from inspection of collected data.
 
IntervalOfValidity getIovFromAllData () const
 Get the complete IoV from inspection of collected data.
 
void fillRunToInputFilesMap ()
 Fill the mapping of ExpRun -> Files.
 
const std::string & getGranularity () const
 Get the granularity of collected data.
 
EResult execute (std::vector< Calibration::ExpRun > runs={}, int iteration=0, IntervalOfValidity iov=IntervalOfValidity())
 Runs calibration over vector of runs for a given iteration.
 
EResult execute (PyObject *runs, int iteration=0, IntervalOfValidity iov=IntervalOfValidity())
 Runs calibration over Python list of runs. Converts to C++ and then calls the other execute() function.
 
std::list< Database::DBImportQuery > & getPayloads ()
 Get constants (in TObjects) for database update from last execution.
 
const std::list< Database::DBImportQuery > & getPayloadValues () const
 Get constants (in TObjects) for database update from last execution.
 
bool commit ()
 Submit constants from last calibration into database.
 
bool commit (std::list< Database::DBImportQuery > payloads)
 Submit constants from a (potentially previous) set of payloads.
 
const std::string & getDescription () const
 Get the description of the algorithm (set by developers in constructor)
 
bool loadInputJson (const std::string &jsonString)
 Load the m_inputJson variable from a string (useful from Python interface). The return bool indicates success or failure.
 
const std::string dumpOutputJson () const
 Dump the JSON string of the output JSON object.
 
const std::vector< Calibration::ExpRun > findPayloadBoundaries (std::vector< Calibration::ExpRun > runs, int iteration=0)
 Used to discover the ExpRun boundaries that you want the Python CAF to execute on. This is optional and only used in some.
 
template<>
std::shared_ptr< TTree > getObjectPtr (const std::string &name, const std::vector< Calibration::ExpRun > &requestedRuns)
 Specialization of getObjectPtr<TTree>.
 

Static Public Member Functions

static bool checkPyExpRun (PyObject *pyObj)
 Checks that a PyObject can be successfully converted to an ExpRun type.
 
static Calibration::ExpRun convertPyExpRun (PyObject *pyObj)
 Performs the conversion of PyObject to ExpRun.
 

Static Public Attributes

static constexpr int m_kNGroups = 3
 SL grouping: inner (SL0), middle (SL1), outer (SL2–8)
 

Protected Member Functions

virtual EResult calibrate () override
 Cosine algorithm.
 
void setInputFileNames (const std::vector< std::string > &inputFileNames)
 Set the input file names used for this algorithm.
 
virtual bool isBoundaryRequired (const Calibration::ExpRun &)
 Given the current collector data, make a decision about whether or not this run should be the start of a payload boundary.
 
virtual void boundaryFindingSetup (std::vector< Calibration::ExpRun >, int)
 If you need to make some changes to your algorithm class before 'findPayloadBoundaries' is run, make them in this function.
 
virtual void boundaryFindingTearDown ()
 Put your algorithm back into a state ready for normal execution if you need to.
 
const std::vector< Calibration::ExpRun > & getRunList () const
 Get the list of runs for which calibration is called.
 
int getIteration () const
 Get current iteration.
 
const std::vector< std::string > & getVecInputFileNames () const
 Get the input file names used for this algorithm as a STL vector.
 
template<class T>
std::shared_ptr< T > getObjectPtr (const std::string &name, const std::vector< Calibration::ExpRun > &requestedRuns)
 Get calibration data object by name and list of runs, the Merge function will be called to generate the overall object.
 
template<class T>
std::shared_ptr< T > getObjectPtr (std::string name)
 Get calibration data object (for all runs the calibration is requested for) This function will only work during or after execute() has been called once.
 
template<>
shared_ptr< TTree > getObjectPtr (const string &name, const vector< ExpRun > &requestedRuns)
 We cheekily cast the TChain to TTree for the returned pointer so that the user never knows Hopefully this doesn't cause issues if people do low level stuff to the tree...
 
std::string getGranularityFromData () const
 Get the granularity of collected data.
 
void saveCalibration (TClonesArray *data, const std::string &name)
 Store DBArray payload with given name with default IOV.
 
void saveCalibration (TClonesArray *data, const std::string &name, const IntervalOfValidity &iov)
 Store DBArray with given name and custom IOV.
 
void saveCalibration (TObject *data)
 Store DB payload with default name and default IOV.
 
void saveCalibration (TObject *data, const IntervalOfValidity &iov)
 Store DB payload with default name and custom IOV.
 
void saveCalibration (TObject *data, const std::string &name)
 Store DB payload with given name with default IOV.
 
void saveCalibration (TObject *data, const std::string &name, const IntervalOfValidity &iov)
 Store DB payload with given name and custom IOV.
 
void setDescription (const std::string &description)
 Set algorithm description (in constructor)
 
void clearCalibrationData ()
 Clear calibration data.
 
void resetInputJson ()
 Clears the m_inputJson member variable.
 
void resetOutputJson ()
 Clears the m_outputJson member variable.
 
template<class T>
void setOutputJsonValue (const std::string &key, const T &value)
 Set a key:value pair for the outputJson object, expected to used internally during calibrate()
 
template<class T>
const T getOutputJsonValue (const std::string &key) const
 Get a value using a key from the JSON output object, not sure why you would want to do this.
 
template<class T>
const T getInputJsonValue (const std::string &key) const
 Get an input JSON value using a key. The normal exceptions are raised when the key doesn't exist.
 
const nlohmann::json & getInputJsonObject () const
 Get the entire top level JSON object. We explicitly say this must be of object type so that we might pick.
 
bool inputJsonKeyExists (const std::string &key) const
 Test for a key in the input JSON object.
 

Static Protected Member Functions

static void updateDBObjPtrs (const unsigned int event, const int run, const int experiment)
 Updates any DBObjPtrs by calling update(event) for DBStore.
 
static Calibration::ExpRun getAllGranularityExpRun ()
 Returns the Exp,Run pair that means 'Everything'. Currently unused.
 

Protected Attributes

std::vector< Calibration::ExpRun > m_boundaries
 When using the boundaries functionality from isBoundaryRequired, this is used to store the boundaries. It is cleared when.
 

Private Member Functions

FitValues fitHistogram (TH1D *&hist)
 Fit histogram with Gaussian and return mean, error, and width.
 
std::string getExpRunString (Calibration::ExpRun &expRun) const
 Gets the "exp.run" string repr. of (exp,run)
 
std::string getFullObjectPath (const std::string &name, Calibration::ExpRun expRun) const
 constructs the full TDirectory + Key name of an object in a TFile based on its name and exprun
 

Private Attributes

bool isMethodSep
 if e+ e- need to be consider sep
 
bool isMakePlots
 produce plots for status
 
bool isMergePayload
 merge payload at the time of calibration
 
double m_sigLim
 gaussian fit sigma limit
 
unsigned int m_cosBin
 number of bins across cosine range
 
double m_cosMin
 min cosine angle for cal
 
double m_cosMax
 max cosine angle for cal
 
int m_dedxBin
 number of bins for dedx histogram
 
double m_dedxMin
 min dedx range for gain cal
 
double m_dedxMax
 max dedx range for gain cal
 
std::string m_suffix
 add suffix to all plot name
 
std::vector< std::vector< double > > m_coscors
 final vectors of calibration
 
const std::array< std::string, m_kNGroupsm_label = {"SL0", "SL1", "SL2-8"}
 add inner/outer superlayer label
 
DBObjPtr< CDCDedxCosineCorm_DBCosineCor
 Electron saturation correction DB object.
 
std::vector< std::string > m_inputFileNames
 List of input files to the Algorithm, will initially be user defined but then gets the wildcards expanded during execute()
 
std::map< Calibration::ExpRun, std::vector< std::string > > m_runsToInputFiles
 Map of Runs to input files. Gets filled when you call getRunRangeFromAllData, gets cleared when setting input files again.
 
std::string m_granularityOfData
 Granularity of input data. This only changes when the input files change so it isn't specific to an execution.
 
ExecutionData m_data
 Data specific to a SINGLE execution of the algorithm. Gets reset at the beginning of execution.
 
std::string m_description {""}
 Description of the algorithm.
 
std::string m_prefix {""}
 The name of the TDirectory the collector objects are contained within.
 
nlohmann::json m_jsonExecutionInput = nlohmann::json::object()
 Optional input JSON object used to make decisions about how to execute the algorithm code.
 
nlohmann::json m_jsonExecutionOutput = nlohmann::json::object()
 Optional output JSON object that can be set during the execution by the underlying algorithm code.
 

Static Private Attributes

static const Calibration::ExpRun m_allExpRun = make_pair(-1, -1)
 allExpRun
 

Detailed Description

A calibration algorithm for CDC dE/dx electron cos(theta) dependence.

Definition at line 26 of file CDCDedxCosineAlgorithm.h.

Member Enumeration Documentation

◆ EResult

enum EResult
inherited

The result of calibration.

Enumerator
c_OK 

Finished successfully =0 in Python.

c_Iterate 

Needs iteration =1 in Python.

c_NotEnoughData 

Needs more data =2 in Python.

c_Failure 

Failed =3 in Python.

c_Undefined 

Not yet known (before execution) =4 in Python.

Definition at line 40 of file CalibrationAlgorithm.h.

40 {
41 c_OK,
42 c_Iterate,
43 c_NotEnoughData,
44 c_Failure,
45 c_Undefined
46 };

Constructor & Destructor Documentation

◆ CDCDedxCosineAlgorithm()

Constructor: Sets the description, the properties and the parameters of the algorithm.

Definition at line 22 of file CDCDedxCosineAlgorithm.cc.

22 :
23 CalibrationAlgorithm("CDCDedxElectronCollector"),
24 isMethodSep(true),
25 isMakePlots(true),
26 isMergePayload(true),
27 m_sigLim(2.5),
28 m_cosBin(100),
29 m_cosMin(-1.0),
30 m_cosMax(1.0),
31 m_dedxBin(250),
32 m_dedxMin(0.0),
33 m_dedxMax(5.0),
34 m_suffix("")
35
36{
37 // Set module properties
38 setDescription("A calibration algorithm for CDC dE/dx electron cos(theta) dependence");
39
40}
int m_dedxBin
number of bins for dedx histogram
double m_cosMax
max cosine angle for cal
bool isMergePayload
merge payload at the time of calibration
std::string m_suffix
add suffix to all plot name
double m_cosMin
min cosine angle for cal
double m_sigLim
gaussian fit sigma limit
bool isMethodSep
if e+ e- need to be consider sep
double m_dedxMax
max dedx range for gain cal
bool isMakePlots
produce plots for status
double m_dedxMin
min dedx range for gain cal
unsigned int m_cosBin
number of bins across cosine range
void setDescription(const std::string &description)
Set algorithm description (in constructor)
CalibrationAlgorithm(const std::string &collectorModuleName)
Constructor - sets the prefix for collected objects (won't be accesses until execute(....

◆ ~CDCDedxCosineAlgorithm()

virtual ~CDCDedxCosineAlgorithm ( )
inlinevirtual

Destructor.

Definition at line 40 of file CDCDedxCosineAlgorithm.h.

40{}

Member Function Documentation

◆ boundaryFindingSetup()

virtual void boundaryFindingSetup ( std::vector< Calibration::ExpRun > ,
int  )
inlineprotectedvirtualinherited

If you need to make some changes to your algorithm class before 'findPayloadBoundaries' is run, make them in this function.

Reimplemented in PXDAnalyticGainCalibrationAlgorithm, PXDValidationAlgorithm, SVD3SampleCoGTimeCalibrationAlgorithm, SVD3SampleELSTimeCalibrationAlgorithm, SVDCoGTimeCalibrationAlgorithm, TestBoundarySettingAlgorithm, and TestCalibrationAlgorithm.

Definition at line 252 of file CalibrationAlgorithm.h.

252{};

◆ boundaryFindingTearDown()

virtual void boundaryFindingTearDown ( )
inlineprotectedvirtualinherited

Put your algorithm back into a state ready for normal execution if you need to.

Definition at line 257 of file CalibrationAlgorithm.h.

257{};

◆ calibrate()

CalibrationAlgorithm::EResult calibrate ( )
overrideprotectedvirtual

Cosine algorithm.

Implements CalibrationAlgorithm.

Definition at line 45 of file CDCDedxCosineAlgorithm.cc.

46{
47
49
50 if (!m_DBCosineCor.isValid())
51 B2FATAL("There is no valid previous payload for CDCDedxCosineCor");
52
53 B2INFO("Preparing dE/dx calibration for CDC dE/dx electron saturation");
54
55 // Get data objects
56 auto ttree = getObjectPtr<TTree>("tree");
57 if (!ttree) {
58 B2ERROR("Input tree 'tree' not found");
59 return c_Failure;
60 }
61 if (ttree->GetEntries() < 100)return c_NotEnoughData;
62
63 double dedx, costh; int charge;
64 ttree->SetBranchAddress("dedx", &dedx);
65 ttree->SetBranchAddress("costh", &costh);
66 ttree->SetBranchAddress("charge", &charge);
67
68
69 // make histograms to store dE/dx values in bins of cos(theta)
70 // bin size can be arbitrary, but for now just make uniform bins
71 std::vector<TH1D*> hDedxCos_neg, hDedxCos_pos, hDedxCos_all;
72
73 const double binW = (m_cosMax - m_cosMin) / m_cosBin;
74
75 defineHisto(hDedxCos_neg, "neg", "e-");
76 defineHisto(hDedxCos_pos, "pos", "e+");
77 defineHisto(hDedxCos_all, "all", "e-,e+");
78
79 // fill histograms, bin size may be arbitrary
80 TH1D* hCosth_neg = defineCosthHist("neg");
81 TH1D* hCosth_pos = defineCosthHist("pos");
82 TH1D* hCosth_all = defineCosthHist("all");
83
84 for (int i = 0; i < ttree->GetEntries(); ++i) {
85
86 ttree->GetEvent(i);
87
88 //if track is a junk
89 if (dedx <= 0 || charge == 0) continue;
90
91 //if track is in CDC accpetance (though it is inbuilt in collector module)
92 if (costh < TMath::Cos(150 * TMath::DegToRad()) || costh > TMath::Cos(17 * TMath::DegToRad())) continue;
93
94 int bin = int((costh - m_cosMin) / binW);
95 if (bin < 0 || bin >= static_cast<int>(m_cosBin)) continue;
96
97 if (isMethodSep) {
98 if (charge < 0) {
99 hCosth_neg->Fill(costh);
100 hDedxCos_neg[bin]->Fill(dedx);
101 } else if (charge > 0) {
102 hCosth_pos->Fill(costh);
103 hDedxCos_pos[bin]->Fill(dedx);
104 }
105 } else {
106 hCosth_all->Fill(costh);
107 hDedxCos_all[bin]->Fill(dedx);
108 }
109 }
110
111 // fit histograms to get gains in bins of cos(theta)
112 std::vector<double> cosine;
113
114 std::vector<std::vector<double>> dedxAll(4);
115 std::vector<std::vector<double>> dedxNeg(4);
116 std::vector<std::vector<double>> dedxPos(4);
117
118 for (unsigned int i = 0; i < m_cosBin; ++i) {
119
120 double meanDedx = 1.0; //This is what we need for calibration
121 double meanDedxErr = 0.0;
122
123 if (!isMethodSep) {
124 FitValues fitAll = fitHistogram(hDedxCos_all[i]);
125
126 meanDedx = fitAll.mean;
127
128 dedxAll[0].push_back(fitAll.mean);
129 dedxAll[1].push_back(fitAll.meanErr);
130 dedxAll[2].push_back(fitAll.sigma);
131 dedxAll[3].push_back(fitAll.sigmaErr);
132
133 } else {
134
135 //Fit electron dE/dx in cos bins
136 FitValues fitNeg = fitHistogram(hDedxCos_neg[i]);
137
138 //Fit positron dE/dx in cos bins
139 FitValues fitPos = fitHistogram(hDedxCos_pos[i]);
140
141 if (fitPos.status != "FitOK" && fitNeg.status == "FitOK") {
142 fitPos.mean = fitNeg.mean;
143 hDedxCos_pos[i]->SetTitle(Form("%s, mean (manual) = elec left", hDedxCos_pos[i]->GetTitle()));
144 } else if (fitNeg.status != "FitOK" && fitPos.status == "FitOK") {
145 fitNeg.mean = fitPos.mean;
146 hDedxCos_neg[i]->SetTitle(Form("%s, mean (manual) = posi right", hDedxCos_neg[i]->GetTitle()));
147 } else if (fitNeg.status != "FitOK" && fitPos.status != "FitOK") {
148 fitNeg.mean = 1.0;
149 fitPos.mean = 1.0;
150 }
151
152 dedxNeg[0].push_back(fitNeg.mean);
153 dedxNeg[1].push_back(fitNeg.meanErr);
154 dedxNeg[2].push_back(fitNeg.sigma);
155 dedxNeg[3].push_back(fitNeg.sigmaErr);
156
157 dedxPos[0].push_back(fitPos.mean);
158 dedxPos[1].push_back(fitPos.meanErr);
159 dedxPos[2].push_back(fitPos.sigma);
160 dedxPos[3].push_back(fitPos.sigmaErr);
161
162 meanDedx = 0.5 * (fitNeg.mean + fitPos.mean);
163 if (meanDedx <= 0.0) meanDedx = 1.0;
164
165 meanDedxErr = 0.5 * TMath::Sqrt(fitNeg.meanErr * fitNeg.meanErr +
166 fitPos.meanErr * fitPos.meanErr);
167
168 dedxAll[0].push_back(meanDedx);
169 dedxAll[1].push_back(meanDedxErr);
170
171 }
172
173 cosine.push_back(meanDedx);
174 }
175
176 createPayload(cosine);
177
178
179 if (isMakePlots) {
180
181 //1. dE/dx dist. for cosine bins
182 plotdedxHist(hDedxCos_all, hDedxCos_neg, hDedxCos_pos);
183
184 //4. costh distribution
185 plotCosThetaDist(hCosth_all, hCosth_pos, hCosth_neg);
186
187 plotFitResults(dedxAll, dedxNeg, dedxPos);
188
189 //7. plot statistics related plots here
191
192 //6. draw the final constants
194 }
195
196 m_suffix.clear();
197
198 return c_OK;
199}
FitValues fitHistogram(TH1D *&hist)
Fit histogram with Gaussian and return mean, error, and width.
void getExpRunInfo()
function to extract calibration run/exp
TH1D * defineCosthHist(const std::string &tag)
function to define cosine histograms
void plotCosThetaDist(TH1D *hCosth_all, TH1D *hCosth_pos, TH1D *hCosth_neg)
Plot cos(theta) distributions for all, positive, and negative tracks.
DBObjPtr< CDCDedxCosineCor > m_DBCosineCor
Electron saturation correction DB object.
void plotConstants()
function to draw the old/new final constants
void plotEventStats()
function to draw the stats plots
void plotFitResults(const std::vector< std::vector< double > > &dedxAll, const std::vector< std::vector< double > > &dedxNeg, const std::vector< std::vector< double > > &dedxPos)
Plot dE/dx fit results for all, negative, and positive tracks.
void plotdedxHist(std::vector< TH1D * > &hDedxCos_all, std::vector< TH1D * > &hDedxCos_neg, std::vector< TH1D * > &hDedxCos_pos)
function to draw the dE/dx histogram in costh bins
void createPayload(std::vector< double > cosine)
function to store new payload after full calibration
void defineHisto(std::vector< TH1D * > &hdedx, const std::string &tag, const std::string &chargeLabel)
function to define dE/dx histograms
@ c_OK
Finished successfully =0 in Python.
@ c_NotEnoughData
Needs more data =2 in Python.
std::shared_ptr< T > getObjectPtr(const std::string &name, const std::vector< Calibration::ExpRun > &requestedRuns)
Get calibration data object by name and list of runs, the Merge function will be called to generate t...
Container for Gaussian fit results of a histogram.

◆ checkPyExpRun()

bool checkPyExpRun ( PyObject * pyObj)
staticinherited

Checks that a PyObject can be successfully converted to an ExpRun type.

Checks if the PyObject can be converted to ExpRun.

Definition at line 28 of file CalibrationAlgorithm.cc.

29{
30 // Is it a sequence?
31 if (PySequence_Check(pyObj)) {
32 Py_ssize_t nObj = PySequence_Length(pyObj);
33 // Does it have 2 objects in it?
34 if (nObj != 2) {
35 B2DEBUG(29, "ExpRun was a Python sequence which didn't have exactly 2 entries!");
36 return false;
37 }
38 PyObject* item1, *item2;
39 item1 = PySequence_GetItem(pyObj, 0);
40 item2 = PySequence_GetItem(pyObj, 1);
41 // Did the GetItem work?
42 if ((item1 == NULL) || (item2 == NULL)) {
43 B2DEBUG(29, "A PyObject pointer was NULL in the sequence");
44 return false;
45 }
46 // Are they longs?
47 if (PyLong_Check(item1) && PyLong_Check(item2)) {
48 long value1, value2;
49 value1 = PyLong_AsLong(item1);
50 value2 = PyLong_AsLong(item2);
51 if (((value1 == -1) || (value2 == -1)) && PyErr_Occurred()) {
52 B2DEBUG(29, "An error occurred while converting the PyLong to long");
53 return false;
54 }
55 } else {
56 B2DEBUG(29, "One or more of the PyObjects in the ExpRun wasn't a long");
57 return false;
58 }
59 // Make sure to kill off the reference GetItem gave us responsibility for
60 Py_DECREF(item1);
61 Py_DECREF(item2);
62 } else {
63 B2DEBUG(29, "ExpRun was not a Python sequence.");
64 return false;
65 }
66 return true;
67}

◆ clearCalibrationData()

void clearCalibrationData ( )
inlineprotectedinherited

Clear calibration data.

Definition at line 324 of file CalibrationAlgorithm.h.

324{m_data.clearCalibrationData();}

◆ commit() [1/2]

bool commit ( )
inherited

Submit constants from last calibration into database.

Definition at line 302 of file CalibrationAlgorithm.cc.

303{
304 if (getPayloads().empty())
305 return false;
306 list<Database::DBImportQuery> payloads = getPayloads();
307 B2INFO("Committing " << payloads.size() << " payloads to database.");
308 return Database::Instance().storeData(payloads);
309}
std::list< Database::DBImportQuery > & getPayloads()
Get constants (in TObjects) for database update from last execution.
static Database & Instance()
Instance of a singleton Database.
Definition Database.cc:41
bool storeData(const std::string &name, TObject *object, const IntervalOfValidity &iov)
Store an object in the database.
Definition Database.cc:140

◆ commit() [2/2]

bool commit ( std::list< Database::DBImportQuery > payloads)
inherited

Submit constants from a (potentially previous) set of payloads.

Definition at line 312 of file CalibrationAlgorithm.cc.

313{
314 if (payloads.empty())
315 return false;
316 return Database::Instance().storeData(payloads);
317}

◆ convertPyExpRun()

ExpRun convertPyExpRun ( PyObject * pyObj)
staticinherited

Performs the conversion of PyObject to ExpRun.

Converts the PyObject to an ExpRun. We've preoviously checked the object so this assumes a lot about the PyObject.

Definition at line 70 of file CalibrationAlgorithm.cc.

71{
72 ExpRun expRun;
73 PyObject* itemExp, *itemRun;
74 itemExp = PySequence_GetItem(pyObj, 0);
75 itemRun = PySequence_GetItem(pyObj, 1);
76 expRun.first = PyLong_AsLong(itemExp);
77 Py_DECREF(itemExp);
78 expRun.second = PyLong_AsLong(itemRun);
79 Py_DECREF(itemRun);
80 return expRun;
81}

◆ createPayload()

void createPayload ( std::vector< double > cosine)

function to store new payload after full calibration

Definition at line 315 of file CDCDedxCosineAlgorithm.cc.

316{
317 m_coscors.resize(m_kNGroups);
318
319 for (unsigned int il = 0; il < m_kNGroups; il++) {
320
321 unsigned int nbins = m_DBCosineCor->getSize(getRepresentativeLayer(il));
322
323 if (nbins != m_cosBin)
324 B2ERROR("merging failed because of unmatch bins (old "
325 << nbins << " new " << m_cosBin << ")");
326
327 m_coscors[il].reserve(nbins);
328
329 for (unsigned int ibin = 0; ibin < nbins; ibin++) {
330
331 double value = cosine[ibin];
332
333 if (isMergePayload) {
334 double prev = m_DBCosineCor->getMean(getRepresentativeLayer(il), ibin);
335
336 value *= prev;
337
338 B2INFO("Cosine Corr for " << m_label[il]
339 << " Bin # " << ibin
340 << ", Previous = " << prev
341 << ", Relative = " << cosine[ibin]
342 << ", Merged = " << value);
343 }
344
345 m_coscors[il].push_back(value);
346 }
347 }
348
349 //Saving constants
350 B2INFO("dE/dx calibration done for CDC dE/dx electron saturation");
351
352 std::vector<unsigned int> layerToGroup(56);
353
354 for (unsigned int layer = 0; layer < 56; layer++) {
355 if (layer < 8) layerToGroup[layer] = 0; // SL0
356 else if (layer < 14) layerToGroup[layer] = 1; // SL1
357 else layerToGroup[layer] = 2; // SL2-8
358 }
359
360 CDCDedxCosineCor* gain = new CDCDedxCosineCor(m_coscors, layerToGroup);
361 saveCalibration(gain, "CDCDedxCosineCor");
362}
static constexpr int m_kNGroups
SL grouping: inner (SL0), middle (SL1), outer (SL2–8)
unsigned int getRepresentativeLayer(unsigned int igroup) const
Representative CDC layer for each SL group (used to access group-wise constants): SL0 => 1,...
const std::array< std::string, m_kNGroups > m_label
add inner/outer superlayer label
std::vector< std::vector< double > > m_coscors
final vectors of calibration
void saveCalibration(TClonesArray *data, const std::string &name)
Store DBArray payload with given name with default IOV.

◆ defineCosthHist()

TH1D * defineCosthHist ( const std::string & tag)

function to define cosine histograms

Definition at line 246 of file CDCDedxCosineAlgorithm.cc.

247{
248
249 TH1D* hist = new TH1D(Form("hCosth_%s_%s", tag.c_str(), m_suffix.data()), " ", m_cosBin, m_cosMin, m_cosMax);
250 hist->SetTitle("cos(#theta) dist (e- and e+); cos(#theta); Entries");
251
252 return hist;
253}

◆ defineHisto()

void defineHisto ( std::vector< TH1D * > & hdedx,
const std::string & tag,
const std::string & chargeLabel )

function to define dE/dx histograms

Definition at line 225 of file CDCDedxCosineAlgorithm.cc.

227{
228
229 const double binW = (m_cosMax - m_cosMin) / m_cosBin;
230
231 hdedx.reserve(m_cosBin);
232
233 for (unsigned int i = 0; i < m_cosBin; ++i) {
234 double coslow = i * binW + m_cosMin;
235 double coshigh = coslow + binW;
236
237 hdedx.push_back(new TH1D(Form("hDedxCos_%s_bin%d_%s", tag.c_str(), i, m_suffix.data()), "", m_dedxBin, m_dedxMin, m_dedxMax));
238
239 hdedx[i]->SetTitle(Form("dE/dx dist (%s) in costh (%0.02f, %0.02f);dE/dx (no had sat, for %s);Entries", chargeLabel.c_str(), coslow,
240 coshigh, chargeLabel.c_str()));
241
242 }
243}

◆ dumpOutputJson()

const std::string dumpOutputJson ( ) const
inlineinherited

Dump the JSON string of the output JSON object.

Definition at line 223 of file CalibrationAlgorithm.h.

223{return m_jsonExecutionOutput.dump();}

◆ execute() [1/2]

CalibrationAlgorithm::EResult execute ( PyObject * runs,
int iteration = 0,
IntervalOfValidity iov = IntervalOfValidity() )
inherited

Runs calibration over Python list of runs. Converts to C++ and then calls the other execute() function.

Definition at line 83 of file CalibrationAlgorithm.cc.

84{
85 B2DEBUG(29, "Running execute() using Python Object as input argument");
86 // Reset the execution specific data in case the algorithm was previously called
87 m_data.reset();
88 m_data.setIteration(iteration);
89 vector<ExpRun> vecRuns;
90 // Is it a list?
91 if (PySequence_Check(runs)) {
92 boost::python::handle<> handle(boost::python::borrowed(runs));
93 boost::python::list listRuns(handle);
94
95 int nList = boost::python::len(listRuns);
96 for (int iList = 0; iList < nList; ++iList) {
97 boost::python::object pyExpRun(listRuns[iList]);
98 if (!checkPyExpRun(pyExpRun.ptr())) {
99 B2ERROR("Received Python ExpRuns couldn't be converted to C++");
100 m_data.setResult(c_Failure);
101 return c_Failure;
102 } else {
103 vecRuns.push_back(convertPyExpRun(pyExpRun.ptr()));
104 }
105 }
106 } else {
107 B2ERROR("Tried to set the input runs but we didn't receive a Python sequence object (list,tuple).");
108 m_data.setResult(c_Failure);
109 return c_Failure;
110 }
111 return execute(vecRuns, iteration, iov);
112}
static bool checkPyExpRun(PyObject *pyObj)
Checks that a PyObject can be successfully converted to an ExpRun type.
EResult execute(std::vector< Calibration::ExpRun > runs={}, int iteration=0, IntervalOfValidity iov=IntervalOfValidity())
Runs calibration over vector of runs for a given iteration.
static Calibration::ExpRun convertPyExpRun(PyObject *pyObj)
Performs the conversion of PyObject to ExpRun.
ExecutionData m_data
Data specific to a SINGLE execution of the algorithm. Gets reset at the beginning of execution.

◆ execute() [2/2]

CalibrationAlgorithm::EResult execute ( std::vector< Calibration::ExpRun > runs = {},
int iteration = 0,
IntervalOfValidity iov = IntervalOfValidity() )
inherited

Runs calibration over vector of runs for a given iteration.

You can also specify the IoV to save the database payload as. By default the Algorithm will create an IoV from your requested ExpRuns, or from the overall ExpRuns of the input data if you haven't specified ExpRuns in this function.

No checks are performed to make sure that a IoV you specify matches the data you ran over, it simply labels the IoV to commit to the database later.

Definition at line 114 of file CalibrationAlgorithm.cc.

115{
116 // Check if we are calling this function directly and need to reset, or through Python where it was already done.
117 if (m_data.getResult() != c_Undefined) {
118 m_data.reset();
119 m_data.setIteration(iteration);
120 }
121
122 if (m_inputFileNames.empty()) {
123 B2ERROR("There aren't any input files set. Please use CalibrationAlgorithm::setInputFiles()");
124 m_data.setResult(c_Failure);
125 return c_Failure;
126 }
127
128 // Did we receive runs to execute over explicitly?
129 if (!(runs.empty())) {
130 for (auto expRun : runs) {
131 B2DEBUG(29, "ExpRun requested = (" << expRun.first << ", " << expRun.second << ")");
132 }
133 // We've asked explicitly for certain runs, but we should check if the data granularity is 'run'
134 if (strcmp(getGranularity().c_str(), "all") == 0) {
135 B2ERROR(("The data is collected with granularity=all (exp=-1,run=-1), but you seem to request calibration for specific runs."
136 " We'll continue but using ALL the input data given instead of the specific runs requested."));
137 }
138 } else {
139 // If no runs are provided, infer the runs from all collected data
140 runs = getRunListFromAllData();
141 // Let's check that we have some now
142 if (runs.empty()) {
143 B2ERROR("No collected data in input files.");
144 m_data.setResult(c_Failure);
145 return c_Failure;
146 }
147 for (auto expRun : runs) {
148 B2DEBUG(29, "ExpRun requested = (" << expRun.first << ", " << expRun.second << ")");
149 }
150 }
151
152 m_data.setRequestedRuns(runs);
153 if (iov.empty()) {
154 // If no user specified IoV we use the IoV from the executed run list
155 iov = IntervalOfValidity(runs[0].first, runs[0].second, runs[runs.size() - 1].first, runs[runs.size() - 1].second);
156 }
157 m_data.setRequestedIov(iov);
158 // After here, the getObject<...>(...) helpers start to work
159
161 m_data.setResult(result);
162 return result;
163}
std::vector< Calibration::ExpRun > getRunListFromAllData() const
Get the complete list of runs from inspection of collected data.
std::vector< std::string > m_inputFileNames
List of input files to the Algorithm, will initially be user defined but then gets the wildcards expa...
EResult
The result of calibration.
@ c_Undefined
Not yet known (before execution) =4 in Python.
const std::string & getGranularity() const
Get the granularity of collected data.
virtual EResult calibrate()=0
Run algo on data - pure virtual: needs to be implemented.

◆ fillRunToInputFilesMap()

void fillRunToInputFilesMap ( )
inherited

Fill the mapping of ExpRun -> Files.

Definition at line 331 of file CalibrationAlgorithm.cc.

332{
333 m_runsToInputFiles.clear();
334 // Save TDirectory to change back at the end
335 TDirectory* dir = gDirectory;
336 RunRange* runRange;
337 // Construct the TDirectory name where we expect our objects to be
338 string runRangeObjName(getPrefix() + "/" + RUN_RANGE_OBJ_NAME);
339 for (const auto& fileName : m_inputFileNames) {
340 //Open TFile to get the objects
341 unique_ptr<TFile> f;
342 f.reset(TFile::Open(fileName.c_str(), "READ"));
343 runRange = dynamic_cast<RunRange*>(f->Get(runRangeObjName.c_str()));
344 if (runRange) {
345 // Insert or extend the run -> file mapping for this ExpRun
346 auto expRuns = runRange->getExpRunSet();
347 for (const auto& expRun : expRuns) {
348 auto runFiles = m_runsToInputFiles.find(expRun);
349 if (runFiles != m_runsToInputFiles.end()) {
350 (runFiles->second).push_back(fileName);
351 } else {
352 m_runsToInputFiles.insert(std::make_pair(expRun, std::vector<std::string> {fileName}));
353 }
354 }
355 } else {
356 B2WARNING("Missing a RunRange object for file: " << fileName);
357 }
358 }
359 dir->cd();
360}
const std::string & getPrefix() const
Get the prefix used for getting calibration data.
std::map< Calibration::ExpRun, std::vector< std::string > > m_runsToInputFiles
Map of Runs to input files. Gets filled when you call getRunRangeFromAllData, gets cleared when setti...
const std::set< Calibration::ExpRun > & getExpRunSet()
Get access to the stored set.
Definition RunRange.h:64

◆ findPayloadBoundaries()

const std::vector< ExpRun > findPayloadBoundaries ( std::vector< Calibration::ExpRun > runs,
int iteration = 0 )
inherited

Used to discover the ExpRun boundaries that you want the Python CAF to execute on. This is optional and only used in some.

Definition at line 521 of file CalibrationAlgorithm.cc.

522{
523 m_boundaries.clear();
524 if (m_inputFileNames.empty()) {
525 B2ERROR("There aren't any input files set. Please use CalibrationAlgorithm::setInputFiles()");
526 return m_boundaries;
527 }
528 // Reset the internal execution data just in case something is hanging around
529 m_data.reset();
530 if (runs.empty()) {
531 // Want to loop over all runs we could possibly know about
532 runs = getRunListFromAllData();
533 }
534 // Let's check that we have some now
535 if (runs.empty()) {
536 B2ERROR("No collected data in input files.");
537 return m_boundaries;
538 }
539 // In order to find run boundaries we must have collected with data granularity == 'run'
540 if (strcmp(getGranularity().c_str(), "all") == 0) {
541 B2ERROR("The data is collected with granularity='all' (exp=-1,run=-1), and we can't use that to find run boundaries.");
542 return m_boundaries;
543 }
544 m_data.setIteration(iteration);
545 // User defined setup function
546 boundaryFindingSetup(runs, iteration);
547 std::vector<ExpRun> runList;
548 // Loop over run list and call derived class "isBoundaryRequired" member function
549 for (auto currentRun : runs) {
550 runList.push_back(currentRun);
551 m_data.setRequestedRuns(runList);
552 // After here, the getObject<...>(...) helpers start to work
553 if (isBoundaryRequired(currentRun)) {
554 m_boundaries.push_back(currentRun);
555 }
556 // Only want run-by-run
557 runList.clear();
558 // Don't want memory hanging around
559 m_data.clearCalibrationData();
560 }
561 m_data.reset();
563 return m_boundaries;
564}
std::vector< Calibration::ExpRun > m_boundaries
When using the boundaries functionality from isBoundaryRequired, this is used to store the boundaries...
virtual void boundaryFindingTearDown()
Put your algorithm back into a state ready for normal execution if you need to.
virtual void boundaryFindingSetup(std::vector< Calibration::ExpRun >, int)
If you need to make some changes to your algorithm class before 'findPayloadBoundaries' is run,...
virtual bool isBoundaryRequired(const Calibration::ExpRun &)
Given the current collector data, make a decision about whether or not this run should be the start o...

◆ fitGaussianWithRange()

void fitGaussianWithRange ( TH1D *& temphist,
TString & status )

function to fit histogram in each cosine bin

Definition at line 283 of file CDCDedxCosineAlgorithm.cc.

284{
285 if (temphist->Integral() < 2000) { //atleast 1k bhabha events
286 B2INFO(Form("\tThis hist (%s) have insufficient entries to perform fit (%0.03f)", temphist->GetName(), temphist->Integral()));
287 status = "LowStats";
288 return;
289 } else {
290 temphist->GetXaxis()->SetRange(temphist->FindFirstBinAbove(0, 1), temphist->FindLastBinAbove(0, 1));
291 int fs = temphist->Fit("gaus", "QR");
292 if (fs != 0) {
293 B2INFO(Form("\tFit (round 1) for hist (%s) failed (status = %d)", temphist->GetName(), fs));
294 status = "FitFailed";
295 return;
296 } else {
297 double meanDedx = temphist->GetFunction("gaus")->GetParameter(1);
298 double width = temphist->GetFunction("gaus")->GetParameter(2);
299 temphist->GetXaxis()->SetRangeUser(meanDedx - 5.0 * width, meanDedx + 5.0 * width);
300 fs = temphist->Fit("gaus", "QR", "", meanDedx - m_sigLim * width, meanDedx + m_sigLim * width);
301 if (fs != 0) {
302 B2INFO(Form("\tFit (round 2) for hist (%s) failed (status = %d)", temphist->GetName(), fs));
303 status = "FitFailed";
304 return;
305 } else {
306 temphist->GetXaxis()->SetRangeUser(meanDedx - 5.0 * width, meanDedx + 5.0 * width);
307 B2INFO(Form("\tFit for hist (%s) sucessfull (status = %d)", temphist->GetName(), fs));
308 status = "FitOK";
309 }
310 }
311 }
312}

◆ fitHistogram()

CDCDedxCosineAlgorithm::FitValues fitHistogram ( TH1D *& hist)
private

Fit histogram with Gaussian and return mean, error, and width.

Definition at line 256 of file CDCDedxCosineAlgorithm.cc.

257{
258 FitValues fitValues;
259
260 fitGaussianWithRange(hist, fitValues.status);
261
262 hist->SetFillColorAlpha(kAzure + 1, 0.30);
263
264 if (fitValues.status == "FitOK") {
265 TF1* fitFunc = hist->GetFunction("gaus");
266 if (fitFunc) {
267 fitValues.mean = fitFunc->GetParameter(1);
268 fitValues.meanErr = fitFunc->GetParError(1);
269 fitValues.sigma = fitFunc->GetParameter(2);
270 fitValues.sigmaErr = fitFunc->GetParError(2);
271
272 std::string fitSummary = Form("#mu_{fit}: %0.03f #pm %0.03f, #sigma_{fit}: %0.03f",
273 fitValues.mean, fitValues.meanErr, fitValues.sigma);
274
275 hist->SetTitle(Form("%s, %s", hist->GetTitle(), fitSummary.data()));
276 }
277 }
278
279 return fitValues;
280}
void fitGaussianWithRange(TH1D *&temphist, TString &status)
function to fit histogram in each cosine bin

◆ getAllGranularityExpRun()

static Calibration::ExpRun getAllGranularityExpRun ( )
inlinestaticprotectedinherited

Returns the Exp,Run pair that means 'Everything'. Currently unused.

Definition at line 327 of file CalibrationAlgorithm.h.

327{return m_allExpRun;}

◆ getCollectorName()

const std::string & getCollectorName ( ) const
inlineinherited

Alias for prefix.

For convenience and less writing, we say developers to set this to default collector module name in constructor of base class. One can however use the dublets of collector+algorithm multiple times with different settings. To bind these together correctly, the prefix has to be set the same for algo and collector. So we call the setter setPrefix rather than setModuleName or whatever. This getter will work out of the box for default cases -> return the name of module you have to add to your path to collect data for this algorithm.

Definition at line 164 of file CalibrationAlgorithm.h.

164{return getPrefix();}

◆ getDescription()

const std::string & getDescription ( ) const
inlineinherited

Get the description of the algorithm (set by developers in constructor)

Definition at line 216 of file CalibrationAlgorithm.h.

216{return m_description;}

◆ getExpRunInfo()

void getExpRunInfo ( )

function to extract calibration run/exp

Definition at line 202 of file CDCDedxCosineAlgorithm.cc.

203{
204
205 int cruns = 0;
206 for (auto expRun : getRunList()) {
207 if (cruns == 0) B2INFO("CDCDedxCosineCor: start exp " << expRun.first << " and run " << expRun.second << "");
208 cruns++;
209 }
210
211 const auto erStart = getRunList()[0];
212 int estart = erStart.first;
213 int rstart = erStart.second;
214
215 const auto erEnd = getRunList()[cruns - 1];
216 int rend = erEnd.second;
217
218 updateDBObjPtrs(1, rstart, estart);
219
220 if (m_suffix.length() > 0) m_suffix = Form("%s_e%d_r%dr%d", m_suffix.data(), estart, rstart, rend);
221 else m_suffix = Form("e%d_r%dr%d", estart, rstart, rend);
222}
static void updateDBObjPtrs(const unsigned int event, const int run, const int experiment)
Updates any DBObjPtrs by calling update(event) for DBStore.
const std::vector< Calibration::ExpRun > & getRunList() const
Get the list of runs for which calibration is called.

◆ getExpRunString()

string getExpRunString ( Calibration::ExpRun & expRun) const
privateinherited

Gets the "exp.run" string repr. of (exp,run)

Definition at line 254 of file CalibrationAlgorithm.cc.

255{
256 string expRunString;
257 expRunString += to_string(expRun.first);
258 expRunString += ".";
259 expRunString += to_string(expRun.second);
260 return expRunString;
261}

◆ getFullObjectPath()

string getFullObjectPath ( const std::string & name,
Calibration::ExpRun expRun ) const
privateinherited

constructs the full TDirectory + Key name of an object in a TFile based on its name and exprun

Definition at line 263 of file CalibrationAlgorithm.cc.

264{
265 string dirName = getPrefix() + "/" + name;
266 string objName = name + "_" + getExpRunString(expRun);
267 return dirName + "/" + objName;
268}
std::string getExpRunString(Calibration::ExpRun &expRun) const
Gets the "exp.run" string repr. of (exp,run)

◆ getGranularity()

const std::string & getGranularity ( ) const
inlineinherited

Get the granularity of collected data.

Definition at line 188 of file CalibrationAlgorithm.h.

188{return m_granularityOfData;};

◆ getGranularityFromData()

string getGranularityFromData ( ) const
protectedinherited

Get the granularity of collected data.

Definition at line 384 of file CalibrationAlgorithm.cc.

385{
386 // Save TDirectory to change back at the end
387 TDirectory* dir = gDirectory;
388 const RunRange* runRange;
389 string runRangeObjName(getPrefix() + "/" + RUN_RANGE_OBJ_NAME);
390 // We only check the first file
391 string fileName = m_inputFileNames[0];
392 unique_ptr<TFile> f;
393 f.reset(TFile::Open(fileName.c_str(), "READ"));
394 runRange = dynamic_cast<RunRange*>(f->Get(runRangeObjName.c_str()));
395 if (!runRange) {
396 B2FATAL("The input file " << fileName << " does not contain a RunRange object at "
397 << runRangeObjName << ". Please set your input files to exclude it.");
398 return "";
399 }
400 string granularity = runRange->getGranularity();
401 dir->cd();
402 return granularity;
403}
const std::string & getGranularity() const
Gets the m_granularity.
Definition RunRange.h:110

◆ getInputFileNames()

PyObject * getInputFileNames ( )
inherited

Get the input file names used for this algorithm and pass them out as a Python list of unicode strings.

Definition at line 245 of file CalibrationAlgorithm.cc.

246{
247 PyObject* objInputFileNames = PyList_New(m_inputFileNames.size());
248 for (size_t i = 0; i < m_inputFileNames.size(); ++i) {
249 PyList_SetItem(objInputFileNames, i, Py_BuildValue("s", m_inputFileNames[i].c_str()));
250 }
251 return objInputFileNames;
252}

◆ getInputJsonObject()

const nlohmann::json & getInputJsonObject ( ) const
inlineprotectedinherited

Get the entire top level JSON object. We explicitly say this must be of object type so that we might pick.

Definition at line 357 of file CalibrationAlgorithm.h.

357{return m_jsonExecutionInput;}

◆ getInputJsonValue()

template<class T>
const T getInputJsonValue ( const std::string & key) const
inlineprotectedinherited

Get an input JSON value using a key. The normal exceptions are raised when the key doesn't exist.

Definition at line 350 of file CalibrationAlgorithm.h.

351 {
352 return m_jsonExecutionInput.at(key);
353 }

◆ getIovFromAllData()

IntervalOfValidity getIovFromAllData ( ) const
inherited

Get the complete IoV from inspection of collected data.

Definition at line 326 of file CalibrationAlgorithm.cc.

327{
329}
RunRange getRunRangeFromAllData() const
Get the complete RunRange from inspection of collected data.
IntervalOfValidity getIntervalOfValidity()
Make IntervalOfValidity from the set, spanning all runs. Works because sets are sorted by default.
Definition RunRange.h:70

◆ getIteration()

int getIteration ( ) const
inlineprotectedinherited

Get current iteration.

Definition at line 269 of file CalibrationAlgorithm.h.

269{ return m_data.getIteration(); }

◆ getObjectPtr()

template<class T>
std::shared_ptr< T > getObjectPtr ( std::string name)
inlineprotectedinherited

Get calibration data object (for all runs the calibration is requested for) This function will only work during or after execute() has been called once.

Definition at line 285 of file CalibrationAlgorithm.h.

286 {
287 if (m_runsToInputFiles.size() == 0)
288 fillRunToInputFilesMap();
289 return getObjectPtr<T>(name, m_data.getRequestedRuns());
290 }

◆ getOutputJsonValue()

template<class T>
const T getOutputJsonValue ( const std::string & key) const
inlineprotectedinherited

Get a value using a key from the JSON output object, not sure why you would want to do this.

Definition at line 342 of file CalibrationAlgorithm.h.

343 {
344 return m_jsonExecutionOutput.at(key);
345 }

◆ getPayloads()

std::list< Database::DBImportQuery > & getPayloads ( )
inlineinherited

Get constants (in TObjects) for database update from last execution.

Definition at line 204 of file CalibrationAlgorithm.h.

204{return m_data.getPayloads();}

◆ getPayloadValues()

const std::list< Database::DBImportQuery > & getPayloadValues ( ) const
inlineinherited

Get constants (in TObjects) for database update from last execution.

Definition at line 207 of file CalibrationAlgorithm.h.

207{return m_data.getPayloadValues();}

◆ getPrefix()

const std::string & getPrefix ( ) const
inlineinherited

Get the prefix used for getting calibration data.

Definition at line 146 of file CalibrationAlgorithm.h.

146{return m_prefix;}

◆ getRepresentativeLayer()

unsigned int getRepresentativeLayer ( unsigned int igroup) const
inline

Representative CDC layer for each SL group (used to access group-wise constants): SL0 => 1, SL1 => 9, SL2-8 => 17.

Definition at line 161 of file CDCDedxCosineAlgorithm.h.

162 {
163 static const std::array<unsigned int, m_kNGroups> repLayer = {1, 9, 17};
164 return repLayer.at(igroup);
165 }

◆ getRunList()

const std::vector< Calibration::ExpRun > & getRunList ( ) const
inlineprotectedinherited

Get the list of runs for which calibration is called.

Definition at line 266 of file CalibrationAlgorithm.h.

266{return m_data.getRequestedRuns();}

◆ getRunListFromAllData()

vector< ExpRun > getRunListFromAllData ( ) const
inherited

Get the complete list of runs from inspection of collected data.

Definition at line 319 of file CalibrationAlgorithm.cc.

320{
321 RunRange runRange = getRunRangeFromAllData();
322 set<ExpRun> expRunSet = runRange.getExpRunSet();
323 return vector<ExpRun>(expRunSet.begin(), expRunSet.end());
324}

◆ getRunRangeFromAllData()

RunRange getRunRangeFromAllData ( ) const
inherited

Get the complete RunRange from inspection of collected data.

Definition at line 362 of file CalibrationAlgorithm.cc.

363{
364 // Save TDirectory to change back at the end
365 TDirectory* dir = gDirectory;
366 RunRange runRange;
367 // Construct the TDirectory name where we expect our objects to be
368 string runRangeObjName(getPrefix() + "/" + RUN_RANGE_OBJ_NAME);
369 for (const auto& fileName : m_inputFileNames) {
370 //Open TFile to get the objects
371 unique_ptr<TFile> f;
372 f.reset(TFile::Open(fileName.c_str(), "READ"));
373 const RunRange* runRangeOther = dynamic_cast<RunRange*>(f->Get(runRangeObjName.c_str()));
374 if (runRangeOther) {
375 runRange.merge(runRangeOther);
376 } else {
377 B2WARNING("Missing a RunRange object for file: " << fileName);
378 }
379 }
380 dir->cd();
381 return runRange;
382}
virtual void merge(const RunRange *other)
Implementation of merging - other is added to the set (union)
Definition RunRange.h:52

◆ getVecInputFileNames()

const std::vector< std::string > & getVecInputFileNames ( ) const
inlineprotectedinherited

Get the input file names used for this algorithm as a STL vector.

Definition at line 275 of file CalibrationAlgorithm.h.

275{return m_inputFileNames;}

◆ inputJsonKeyExists()

bool inputJsonKeyExists ( const std::string & key) const
inlineprotectedinherited

Test for a key in the input JSON object.

Definition at line 360 of file CalibrationAlgorithm.h.

360{return m_jsonExecutionInput.count(key);}

◆ isBoundaryRequired()

virtual bool isBoundaryRequired ( const Calibration::ExpRun & )
inlineprotectedvirtualinherited

Given the current collector data, make a decision about whether or not this run should be the start of a payload boundary.

Reimplemented in PXDAnalyticGainCalibrationAlgorithm, PXDValidationAlgorithm, SVD3SampleCoGTimeCalibrationAlgorithm, SVD3SampleELSTimeCalibrationAlgorithm, SVDCoGTimeCalibrationAlgorithm, TestBoundarySettingAlgorithm, and TestCalibrationAlgorithm.

Definition at line 243 of file CalibrationAlgorithm.h.

244 {
245 B2ERROR("You didn't implement a isBoundaryRequired() member function in your CalibrationAlgorithm but you are calling it!");
246 return false;
247 }

◆ loadInputJson()

bool loadInputJson ( const std::string & jsonString)
inherited

Load the m_inputJson variable from a string (useful from Python interface). The return bool indicates success or failure.

Definition at line 503 of file CalibrationAlgorithm.cc.

504{
505 try {
506 auto jsonInput = nlohmann::json::parse(jsonString);
507 // Input string has an object (dict) as the top level object?
508 if (jsonInput.is_object()) {
509 m_jsonExecutionInput = jsonInput;
510 return true;
511 } else {
512 B2ERROR("JSON input string isn't an object type i.e. not a '{}' at the top level.");
513 return false;
514 }
515 } catch (nlohmann::json::parse_error&) {
516 B2ERROR("Parsing of JSON input string failed");
517 return false;
518 }
519}
nlohmann::json m_jsonExecutionInput
Optional input JSON object used to make decisions about how to execute the algorithm code.

◆ plotConstants()

void plotConstants ( )

function to draw the old/new final constants

Definition at line 555 of file CDCDedxCosineAlgorithm.cc.

556{
557
558 for (int il = 0; il < m_kNGroups; il++) {
559
560 unsigned int nbins = m_DBCosineCor->getSize(getRepresentativeLayer(il));
561
562 // --- Create histograms ---
563 TH1D* hnew = new TH1D(Form("hnew_%s", m_label[il].data()), Form("Final const: %s;cos(#theta);dedx #mu_{fit}", m_label[il].data()),
565 m_cosMax);
566
567 TH1D* hold = new TH1D(Form("hold_%s", m_label[il].data()), Form("Final const: %s;cos(#theta);dedx #mu_{fit}", m_label[il].data()),
569 m_cosMax);
570
571 for (unsigned int iea = 0; iea < nbins; iea++) {
572 double oldv = m_DBCosineCor->getMean(getRepresentativeLayer(il), iea);
573 double newv = m_coscors[il][iea];
574
575 hold->SetBinContent(iea + 1, oldv);
576 hnew->SetBinContent(iea + 1, newv);
577 }
578
579 // --- Ratio ---
580 TH1D* hratio = (TH1D*)hnew->Clone(Form("hratio_%s", m_label[il].data()));
581 hratio->Divide(hold);
582
583 TCanvas c(Form("c_%s", m_label[il].data()), Form("Final constants %s", m_label[il].data()), 1000, 500);
584 c.Divide(2, 1);
585 c.cd(1);
586 gPad->SetGridy(1);
587 gPad->SetGridx(1);
588
589 hnew->SetLineColor(kBlack);
590 hnew->SetStats(0);
591 hold->SetLineColor(kRed);
592 hold->SetStats(0);
593
594 double min = std::min(hnew->GetMinimum(), hold->GetMinimum());
595 double max = std::max(hnew->GetMaximum(), hold->GetMaximum());
596 hnew->GetYaxis()->SetRangeUser(min * 0.95, max * 1.05);
597
598 hnew->Draw("hist");
599 hold->Draw("hist same");
600
601 auto leg = new TLegend(0.6, 0.75, 0.85, 0.88);
602 leg->SetBorderSize(0);
603 leg->SetFillStyle(0);
604 leg->AddEntry(hnew, "New", "l");
605 leg->AddEntry(hold, "Old", "l");
606 leg->Draw();
607
608 c.cd(2);
609 gPad->SetGridy(1);
610 hratio->SetLineColor(kBlue);
611 hratio->SetStats(0);
612 hratio->SetTitle(Form("Ratio: new/old, %s;cos(#theta); New / Old", m_label[il].data()));
613 hratio->GetYaxis()->SetRangeUser(0.8, 1.2);
614 hratio->Draw("hist");
615
616 TLine* line = new TLine(m_cosMin, 1.0, m_cosMax, 1.0);
617 line->SetLineStyle(2);
618 line->Draw();
619
620 c.SaveAs(Form("cdcdedx_coscorr_fconsts_%s_%s.pdf", m_label[il].data(), m_suffix.data()));
621 c.SaveAs(Form("cdcdedx_coscorr_fconsts_%s_%s.root", m_label[il].data(), m_suffix.data()));
622
623 // cleanup
624 delete hnew;
625 delete hold;
626 delete hratio;
627 delete line;
628 }
629}

◆ plotCosThetaDist()

void plotCosThetaDist ( TH1D * hCosth_all,
TH1D * hCosth_pos,
TH1D * hCosth_neg )

Plot cos(theta) distributions for all, positive, and negative tracks.

Definition at line 421 of file CDCDedxCosineAlgorithm.cc.

422{
423
424 TCanvas ceadist("ceadist", "Cosine distributions", 800, 600);
425 ceadist.cd();
426
427
428 // If method separation, overlay pos/neg
429 if (isMethodSep) {
430 TLegend* leg = new TLegend(0.6, 0.7, 0.8, 0.9);
431
432 if (hCosth_neg) {
433 hCosth_neg->SetLineColor(kRed);
434 hCosth_neg->SetFillColorAlpha(kYellow, 0.55);
435 hCosth_neg->SetStats(0);
436 hCosth_neg->Draw("hist");
437 leg->AddEntry(hCosth_neg, "neg", "f");
438 }
439 if (hCosth_pos) {
440 hCosth_pos->SetLineColor(kBlue);
441 hCosth_pos->SetFillColorAlpha(kGray, 0.35);
442 hCosth_pos->SetStats(0);
443 hCosth_pos->Draw("hist same");
444 leg->AddEntry(hCosth_pos, "pos", "f");
445 }
446 leg->Draw();
447
448 } else {
449 // Always draw ALL first
450 if (hCosth_all) {
451 hCosth_all->SetFillColorAlpha(kGray, 0.25);
452 hCosth_all->SetLineColor(kGray);
453 hCosth_all->SetStats(0);
454 hCosth_all->Draw("hist");
455 }
456 }
457
458 ceadist.SaveAs(Form("cdcdedx_coscorr_cosine_%s.pdf", m_suffix.data()));
459 ceadist.SaveAs(Form("cdcdedx_coscorr_cosine_%s.root", m_suffix.data()));
460}

◆ plotdedxHist()

void plotdedxHist ( std::vector< TH1D * > & hDedxCos_all,
std::vector< TH1D * > & hDedxCos_neg,
std::vector< TH1D * > & hDedxCos_pos )

function to draw the dE/dx histogram in costh bins

Definition at line 365 of file CDCDedxCosineAlgorithm.cc.

368{
369
370 TCanvas ctmp("tmp", "tmp", 1200, 1200);
371 int nx = isMethodSep ? 2 : 2;
372 int ny = isMethodSep ? 1 : 2;
373 unsigned int nPads = nx * ny;
374 if (isMethodSep) ctmp.SetCanvasSize(1200, 600);
375 ctmp.Divide(nx, ny);
376 std::stringstream psname;
377
378 psname << Form("cdcdedx_coscorr_dedx_%s.pdf[", m_suffix.data());
379 ctmp.Print(psname.str().c_str());
380 psname.str("");
381 psname << Form("cdcdedx_coscorr_dedx_%s.pdf", m_suffix.data());
382
383 for (unsigned int ic = 0; ic < m_cosBin; ic++) {
384 if (!isMethodSep) {
385 ctmp.cd(ic % nPads + 1);
386 hDedxCos_all[ic]->SetStats(0);
387 hDedxCos_all[ic]->SetFillColorAlpha(kYellow, 0.25);
388 hDedxCos_all[ic]->DrawCopy();
389
390 if (ic % nPads == nPads - 1 || ic == m_cosBin - 1) {
391 ctmp.Print(psname.str().c_str());
392 ctmp.Clear();
393 ctmp.Divide(nx, ny);
394 }
395 } else {
396
397 // left: electron
398 ctmp.cd(1);
399 hDedxCos_neg[ic]->SetFillColorAlpha(kRed, 0.25);
400 hDedxCos_neg[ic]->DrawCopy();
401
402
403 // right: positron
404 ctmp.cd(2);
405 hDedxCos_pos[ic]->SetFillColorAlpha(kBlue, 0.25);
406 hDedxCos_pos[ic]->DrawCopy();
407
408 ctmp.Print(psname.str().c_str());
409 ctmp.Clear();
410 ctmp.Divide(nx, ny);
411
412 }
413
414 }
415 psname.str("");
416 psname << Form("cdcdedx_coscorr_dedx_%s.pdf]", m_suffix.data());
417 ctmp.Print(psname.str().c_str());
418}

◆ plotEventStats()

void plotEventStats ( )

function to draw the stats plots

Definition at line 632 of file CDCDedxCosineAlgorithm.cc.

633{
634
635 TCanvas cstats("cstats", "cstats", 1000, 500);
636 cstats.SetBatch(kTRUE);
637 cstats.Divide(2, 1);
638
639 cstats.cd(1);
640 auto hestats = getObjectPtr<TH1I>("hestats");
641 if (hestats) {
642 hestats->SetName(Form("hestats_%s", m_suffix.data()));
643 hestats->SetStats(0);
644 hestats->DrawCopy("");
645 }
646
647 cstats.cd(2);
648 auto htstats = getObjectPtr<TH1I>("htstats");
649 if (htstats) {
650 htstats->SetName(Form("htstats_%s", m_suffix.data()));
651 htstats->SetStats(0);
652 htstats->DrawCopy("");
653 }
654 cstats.Print(Form("cdcdedx_coscorr_stats_%s.pdf", m_suffix.data()));
655}

◆ plotFitResults()

void plotFitResults ( const std::vector< std::vector< double > > & dedxAll,
const std::vector< std::vector< double > > & dedxNeg,
const std::vector< std::vector< double > > & dedxPos )

Plot dE/dx fit results for all, negative, and positive tracks.

Definition at line 464 of file CDCDedxCosineAlgorithm.cc.

467{
468 // Fill histograms
469
470 TH1D* hMean_all = new TH1D("hMean_all", "mean vs cos#theta;cos#theta;mean", m_cosBin, m_cosMin, m_cosMax);
471
472 TH1D* hMean_el = new TH1D("hMean_el", "mean (e-);cos#theta;mean", m_cosBin, m_cosMin, m_cosMax);
473
474 TH1D* hMean_po = new TH1D("hMean_po", "mean (e+);cos#theta;mean", m_cosBin, m_cosMin, m_cosMax);
475
476
477 TH1D* hSig_all = new TH1D("hSig_all", "sigma vs cos#theta;cos#theta;#sigma", m_cosBin, m_cosMin, m_cosMax);
478
479 TH1D* hSig_el = new TH1D("hSig_el", "sigma (e-);cos#theta;#sigma", m_cosBin, m_cosMin, m_cosMax);
480
481 TH1D* hSig_po = new TH1D("hSig_po", "sigma (e+);cos#theta;#sigma", m_cosBin, m_cosMin, m_cosMax);
482
483
484 for (unsigned int i = 0; i < m_cosBin; i++) {
485 hMean_all->SetBinContent(i + 1, dedxAll[0][i]);
486 hMean_all->SetBinError(i + 1, dedxAll[1][i]);
487
488 if (isMethodSep) {
489 hMean_el->SetBinContent(i + 1, dedxNeg[0][i]);
490 hMean_el->SetBinError(i + 1, dedxNeg[1][i]);
491 hSig_el->SetBinContent(i + 1, dedxNeg[2][i]);
492 hSig_el->SetBinError(i + 1, dedxNeg[3][i]);
493
494 hMean_po->SetBinContent(i + 1, dedxPos[0][i]);
495 hMean_po->SetBinError(i + 1, dedxPos[1][i]);
496 hSig_po->SetBinContent(i + 1, dedxPos[2][i]);
497 hSig_po->SetBinError(i + 1, dedxPos[3][i]);
498 } else {
499 hSig_all->SetBinContent(i + 1, dedxAll[2][i]);
500 hSig_all->SetBinError(i + 1, dedxAll[3][i]);
501 }
502
503 }
504
505 TCanvas* ctmp = new TCanvas("c_fit", "Mean & Sigma", 1000, 500);
506 ctmp->Divide(2, 1);
507 ctmp->cd(1);
508 gPad->SetGridy(1);
509
510 setHist(hMean_all, kBlack, "dedx rel(#mu_{fit}) for e- and e+ combined", 0.97, 1.04);
511
512 if (isMethodSep) {
513
514 setHist(hMean_el, kRed, "comparison of dedx #mu_{fit}^{rel}", 0.96, 1.04);
515 setHist(hMean_po, kBlue, "", 0.96, 1.04);
516
517 hMean_el->Draw("E1");
518 hMean_po->Draw("E1 same");
519 hMean_all->Draw("E1 same");
520
521 } else {
522 hMean_all->Draw("E1");
523 }
524
525 ctmp->cd(2);
526 gPad->SetGridy(1);
527
528 setHist(hSig_all, kBlack, "dedx rel(#sigma_{fit}) for e- and e+ combined", 0.05, 0.23);
529
530 if (isMethodSep) {
531
532 setHist(hSig_el, kRed, "comparison of dedx #sigma_{fit}^{rel}", 0.05, 0.23, 24);
533 setHist(hSig_po, kBlue, "", 0.05, 0.23, 25);
534
535 hSig_el->Draw("E1");
536 hSig_po->Draw("E1 same");
537
538 } else {
539 hSig_all->Draw("E1");
540 }
541 B2INFO("Plotting finished ");
542
543
544 ctmp->SaveAs(Form("cdcdedx_coscorr_fit_%s.pdf", m_suffix.data()));
545 delete hMean_all;
546 delete hMean_el;
547 delete hMean_po;
548 delete hSig_all;
549 delete hSig_el;
550 delete hSig_po;
551 delete ctmp;
552}
void setHist(TH1D *h, int color, const char *title, double ymin, double ymax, int marker=20)
Set basic style (color, marker, title, y-range) for a TH1D histogram.

◆ resetInputJson()

void resetInputJson ( )
inlineprotectedinherited

Clears the m_inputJson member variable.

Definition at line 330 of file CalibrationAlgorithm.h.

330{m_jsonExecutionInput.clear();}

◆ resetOutputJson()

void resetOutputJson ( )
inlineprotectedinherited

Clears the m_outputJson member variable.

Definition at line 333 of file CalibrationAlgorithm.h.

333{m_jsonExecutionOutput.clear();}

◆ saveCalibration() [1/6]

void saveCalibration ( TClonesArray * data,
const std::string & name )
protectedinherited

Store DBArray payload with given name with default IOV.

Definition at line 297 of file CalibrationAlgorithm.cc.

298{
299 saveCalibration(data, name, m_data.getRequestedIov());
300}

◆ saveCalibration() [2/6]

void saveCalibration ( TClonesArray * data,
const std::string & name,
const IntervalOfValidity & iov )
protectedinherited

Store DBArray with given name and custom IOV.

Definition at line 276 of file CalibrationAlgorithm.cc.

277{
278 B2DEBUG(29, "Saving calibration TClonesArray '" << name << "' to payloads list.");
279 getPayloads().emplace_back(name, data, iov);
280}

◆ saveCalibration() [3/6]

void saveCalibration ( TObject * data)
protectedinherited

Store DB payload with default name and default IOV.

Definition at line 287 of file CalibrationAlgorithm.cc.

288{
289 saveCalibration(data, DataStore::objectName(data->IsA(), ""));
290}
static std::string objectName(const TClass *t, const std::string &name)
Return the storage name for an object of the given TClass and name.
Definition DataStore.cc:150

◆ saveCalibration() [4/6]

void saveCalibration ( TObject * data,
const IntervalOfValidity & iov )
protectedinherited

Store DB payload with default name and custom IOV.

Definition at line 282 of file CalibrationAlgorithm.cc.

283{
284 saveCalibration(data, DataStore::objectName(data->IsA(), ""), iov);
285}

◆ saveCalibration() [5/6]

void saveCalibration ( TObject * data,
const std::string & name )
protectedinherited

Store DB payload with given name with default IOV.

Definition at line 292 of file CalibrationAlgorithm.cc.

293{
294 saveCalibration(data, name, m_data.getRequestedIov());
295}

◆ saveCalibration() [6/6]

void saveCalibration ( TObject * data,
const std::string & name,
const IntervalOfValidity & iov )
protectedinherited

Store DB payload with given name and custom IOV.

Definition at line 270 of file CalibrationAlgorithm.cc.

271{
272 B2DEBUG(29, "Saving calibration TObject = '" << name << "' to payloads list.");
273 getPayloads().emplace_back(name, data, iov);
274}

◆ setCosineBins()

void setCosineBins ( unsigned int value = 100)
inline

function to set number of cosine bins for calibration

Definition at line 65 of file CDCDedxCosineAlgorithm.h.

65{m_cosBin = value;}

◆ setCosineRange()

void setCosineRange ( double min = -1.0,
double max = 1.0 )
inline

function to set min/max range of cosine for calibration

Definition at line 70 of file CDCDedxCosineAlgorithm.h.

70{m_cosMin = min; m_cosMax = max;}

◆ setDescription()

void setDescription ( const std::string & description)
inlineprotectedinherited

Set algorithm description (in constructor)

Definition at line 321 of file CalibrationAlgorithm.h.

321{m_description = description;}

◆ setFitWidth()

void setFitWidth ( double value = 2.5)
inline

set sigma to restrict fit range around mean

Definition at line 60 of file CDCDedxCosineAlgorithm.h.

60{m_sigLim = value;}

◆ setHist()

void setHist ( TH1D * h,
int color,
const char * title,
double ymin,
double ymax,
int marker = 20 )
inline

Set basic style (color, marker, title, y-range) for a TH1D histogram.

Definition at line 120 of file CDCDedxCosineAlgorithm.h.

122 {
123 h->SetLineColor(color);
124 h->SetLineWidth(2);
125 h->SetMarkerColor(color);
126 h->SetMarkerStyle(marker);
127 h->SetMarkerSize(0.7);
128 h->SetStats(0);
129
130 if (strlen(title) > 0)
131 h->SetTitle(title);
132
133 h->GetYaxis()->SetRangeUser(ymin, ymax);
134 }

◆ setHistBins()

void setHistBins ( int value = 250)
inline

function to set nbins of dedx dist for calibration

Definition at line 75 of file CDCDedxCosineAlgorithm.h.

75{m_dedxBin = value;}

◆ setHistRange()

void setHistRange ( double min = 0.0,
double max = 5.0 )
inline

function to set min/max range of dedx dist for calibration

Definition at line 80 of file CDCDedxCosineAlgorithm.h.

80{m_dedxMin = min; m_dedxMax = max;}

◆ setInputFileNames() [1/2]

void setInputFileNames ( const std::vector< std::string > & inputFileNames)
protectedinherited

Set the input file names used for this algorithm.

Set the input file names used for this algorithm and resolve the wildcards.

Definition at line 194 of file CalibrationAlgorithm.cc.

195{
196 // A lot of code below is tweaked from RootInputModule::initialize,
197 // since we're basically copying the functionality anyway.
198 if (inputFileNames.empty()) {
199 B2WARNING("You have called setInputFileNames() with an empty list. Did you mean to do that?");
200 return;
201 }
202 auto tmpInputFileNames = RootIOUtilities::expandWordExpansions(inputFileNames);
203
204 // We'll use a set to enforce sorted unique file paths as we check them
205 set<string> setInputFileNames;
206 // Check that files exist and convert to absolute paths
207 for (auto path : tmpInputFileNames) {
208 string fullPath = fs::absolute(path).string();
209 if (fs::exists(fullPath)) {
210 setInputFileNames.insert(fs::canonical(fullPath).string());
211 } else {
212 B2WARNING("Couldn't find the file " << path);
213 }
214 }
215
216 if (setInputFileNames.empty()) {
217 B2WARNING("No valid files specified!");
218 return;
219 } else {
220 // Reset the run -> files map as our files are likely different
221 m_runsToInputFiles.clear();
222 }
223
224 // Open TFile to check they can be accessed by ROOT
225 TDirectory* dir = gDirectory;
226 for (const string& fileName : setInputFileNames) {
227 unique_ptr<TFile> f;
228 try {
229 f.reset(TFile::Open(fileName.c_str(), "READ"));
230 } catch (logic_error&) {
231 //this might happen for ~invaliduser/foo.root
232 //actually undefined behaviour per standard, reported as ROOT-8490 in JIRA
233 }
234 if (!f || !f->IsOpen()) {
235 B2FATAL("Couldn't open input file " + fileName);
236 }
237 }
238 dir->cd();
239
240 // Copy the entries of the set to a vector
241 m_inputFileNames = vector<string>(setInputFileNames.begin(), setInputFileNames.end());
243}
std::string m_granularityOfData
Granularity of input data. This only changes when the input files change so it isn't specific to an e...
void setInputFileNames(PyObject *inputFileNames)
Set the input file names used for this algorithm from a Python list.
std::string getGranularityFromData() const
Get the granularity of collected data.
std::vector< std::string > expandWordExpansions(const std::vector< std::string > &filenames)
Performs wildcard expansion using wordexp(), returns matches.

◆ setInputFileNames() [2/2]

void setInputFileNames ( PyObject * inputFileNames)
inherited

Set the input file names used for this algorithm from a Python list.

Set the input file names used for this algorithm and resolve the wildcards.

Definition at line 166 of file CalibrationAlgorithm.cc.

167{
168 // The reasoning for this very 'manual' approach to extending the Python interface
169 // (instead of using boost::python) is down to my fear of putting off final users with
170 // complexity on their side.
171 //
172 // I didn't want users that inherit from this class to be forced to use boost and
173 // to have to define a new python module just to use the CAF. A derived class from
174 // from a boost exposed class would need to have its own boost python module definition
175 // to allow access from a steering file and to the base class functions (I think).
176 // I also couldn't be bothered to write a full framework to get around the issue in a similar
177 // way to Module()...maybe there's an easy way.
178 //
179 // But this way we can allow people to continue using their ROOT implemented classes and inherit
180 // easily from this one. But add in a few helper functions that work with Python objects
181 // created in their steering file i.e. instead of being forced to use STL objects as input
182 // to the algorithm.
183 if (PyList_Check(inputFileNames)) {
184 boost::python::handle<> handle(boost::python::borrowed(inputFileNames));
185 boost::python::list listInputFileNames(handle);
186 auto vecInputFileNames = PyObjConvUtils::convertPythonObject(listInputFileNames, vector<string>());
187 setInputFileNames(vecInputFileNames);
188 } else {
189 B2ERROR("Tried to set the input files but we didn't receive a Python list.");
190 }
191}
Scalar convertPythonObject(const boost::python::object &pyObject, Scalar)
Convert from Python to given type.

◆ setMergePayload()

void setMergePayload ( bool value = true)
inline

function to decide merge vs relative gains

Definition at line 55 of file CDCDedxCosineAlgorithm.h.

55{isMergePayload = value;}

◆ setMethodSep()

void setMethodSep ( bool value = true)
inline

function to make flag active for method of sep

Definition at line 45 of file CDCDedxCosineAlgorithm.h.

45{isMethodSep = value;}

◆ setMonitoringPlots()

void setMonitoringPlots ( bool value = false)
inline

function to make flag active for plotting

Definition at line 50 of file CDCDedxCosineAlgorithm.h.

50{isMakePlots = value;}

◆ setOutputJsonValue()

template<class T>
void setOutputJsonValue ( const std::string & key,
const T & value )
inlineprotectedinherited

Set a key:value pair for the outputJson object, expected to used internally during calibrate()

Definition at line 337 of file CalibrationAlgorithm.h.

337{m_jsonExecutionOutput[key] = value;}

◆ setPrefix()

void setPrefix ( const std::string & prefix)
inlineinherited

Set the prefix used to identify datastore objects.

Definition at line 167 of file CalibrationAlgorithm.h.

167{m_prefix = prefix;}

◆ setSuffix()

void setSuffix ( const std::string & value)
inline

adding suffix to control plots

Definition at line 85 of file CDCDedxCosineAlgorithm.h.

85{m_suffix = value;}

◆ updateDBObjPtrs()

void updateDBObjPtrs ( const unsigned int event,
const int run,
const int experiment )
staticprotectedinherited

Updates any DBObjPtrs by calling update(event) for DBStore.

Definition at line 405 of file CalibrationAlgorithm.cc.

406{
407 // Construct an EventMetaData object but NOT in the Datastore
408 EventMetaData emd(event, run, experiment);
409 // Explicitly update while avoiding registering a Datastore object
411 // Also update the intra-run objects to the event at the same time (maybe unnecessary...)
413}
static DBStore & Instance()
Instance of a singleton DBStore.
Definition DBStore.cc:26
void updateEvent()
Updates all intra-run dependent objects.
Definition DBStore.cc:140
void update()
Updates all objects that are outside their interval of validity.
Definition DBStore.cc:77

Member Data Documentation

◆ isMakePlots

bool isMakePlots
private

produce plots for status

Definition at line 197 of file CDCDedxCosineAlgorithm.h.

◆ isMergePayload

bool isMergePayload
private

merge payload at the time of calibration

Definition at line 198 of file CDCDedxCosineAlgorithm.h.

◆ isMethodSep

bool isMethodSep
private

if e+ e- need to be consider sep

Definition at line 196 of file CDCDedxCosineAlgorithm.h.

◆ m_allExpRun

const ExpRun m_allExpRun = make_pair(-1, -1)
staticprivateinherited

allExpRun

Definition at line 364 of file CalibrationAlgorithm.h.

◆ m_boundaries

std::vector<Calibration::ExpRun> m_boundaries
protectedinherited

When using the boundaries functionality from isBoundaryRequired, this is used to store the boundaries. It is cleared when.

Definition at line 261 of file CalibrationAlgorithm.h.

◆ m_cosBin

unsigned int m_cosBin
private

number of bins across cosine range

Definition at line 200 of file CDCDedxCosineAlgorithm.h.

◆ m_coscors

std::vector<std::vector<double> > m_coscors
private

final vectors of calibration

Definition at line 210 of file CDCDedxCosineAlgorithm.h.

◆ m_cosMax

double m_cosMax
private

max cosine angle for cal

Definition at line 202 of file CDCDedxCosineAlgorithm.h.

◆ m_cosMin

double m_cosMin
private

min cosine angle for cal

Definition at line 201 of file CDCDedxCosineAlgorithm.h.

◆ m_data

ExecutionData m_data
privateinherited

Data specific to a SINGLE execution of the algorithm. Gets reset at the beginning of execution.

Definition at line 382 of file CalibrationAlgorithm.h.

◆ m_DBCosineCor

DBObjPtr<CDCDedxCosineCor> m_DBCosineCor
private

Electron saturation correction DB object.

Definition at line 214 of file CDCDedxCosineAlgorithm.h.

◆ m_dedxBin

int m_dedxBin
private

number of bins for dedx histogram

Definition at line 204 of file CDCDedxCosineAlgorithm.h.

◆ m_dedxMax

double m_dedxMax
private

max dedx range for gain cal

Definition at line 206 of file CDCDedxCosineAlgorithm.h.

◆ m_dedxMin

double m_dedxMin
private

min dedx range for gain cal

Definition at line 205 of file CDCDedxCosineAlgorithm.h.

◆ m_description

std::string m_description {""}
privateinherited

Description of the algorithm.

Definition at line 385 of file CalibrationAlgorithm.h.

385{""};

◆ m_granularityOfData

std::string m_granularityOfData
privateinherited

Granularity of input data. This only changes when the input files change so it isn't specific to an execution.

Definition at line 379 of file CalibrationAlgorithm.h.

◆ m_inputFileNames

std::vector<std::string> m_inputFileNames
privateinherited

List of input files to the Algorithm, will initially be user defined but then gets the wildcards expanded during execute()

Definition at line 373 of file CalibrationAlgorithm.h.

◆ m_jsonExecutionInput

nlohmann::json m_jsonExecutionInput = nlohmann::json::object()
privateinherited

Optional input JSON object used to make decisions about how to execute the algorithm code.

Definition at line 397 of file CalibrationAlgorithm.h.

◆ m_jsonExecutionOutput

nlohmann::json m_jsonExecutionOutput = nlohmann::json::object()
privateinherited

Optional output JSON object that can be set during the execution by the underlying algorithm code.

Definition at line 403 of file CalibrationAlgorithm.h.

◆ m_kNGroups

int m_kNGroups = 3
staticconstexpr

SL grouping: inner (SL0), middle (SL1), outer (SL2–8)

Definition at line 30 of file CDCDedxCosineAlgorithm.h.

◆ m_label

const std::array<std::string, m_kNGroups> m_label = {"SL0", "SL1", "SL2-8"}
private

add inner/outer superlayer label

Definition at line 212 of file CDCDedxCosineAlgorithm.h.

212{"SL0", "SL1", "SL2-8"};

◆ m_prefix

std::string m_prefix {""}
privateinherited

The name of the TDirectory the collector objects are contained within.

Definition at line 388 of file CalibrationAlgorithm.h.

388{""};

◆ m_runsToInputFiles

std::map<Calibration::ExpRun, std::vector<std::string> > m_runsToInputFiles
privateinherited

Map of Runs to input files. Gets filled when you call getRunRangeFromAllData, gets cleared when setting input files again.

Definition at line 376 of file CalibrationAlgorithm.h.

◆ m_sigLim

double m_sigLim
private

gaussian fit sigma limit

Definition at line 199 of file CDCDedxCosineAlgorithm.h.

◆ m_suffix

std::string m_suffix
private

add suffix to all plot name

Definition at line 208 of file CDCDedxCosineAlgorithm.h.


The documentation for this class was generated from the following files: