Belle II Software development
T0CalibrationAlgorithm Class Reference

Class for T0 Correction . More...

#include <T0CalibrationAlgorithm.h>

Inheritance diagram for T0CalibrationAlgorithm:
CalibrationAlgorithm

Public Types

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

Public Member Functions

 T0CalibrationAlgorithm ()
 Constructor.
 
 ~T0CalibrationAlgorithm ()
 Destructor.
 
void storeHisto (bool storeHist=false)
 store Hisotgram or not.
 
void setMinimumNDF (double minndf)
 minimum ndf require for track.
 
void setMinimumPval (double minPval)
 minimum pvalue requirement.
 
void setMaxRMSDt (double maxRMSDt)
 Maximum RMS of dt of all channels distribution, condition to stop iterating.
 
void setMaxMeanDt (double maxMeanDt)
 Maximum mean of dt of all channels distribution, condition to stop iterating.
 
void setOffsetMeanDt (double offsetMeanDt)
 Maximum mean of dt of all channels distribution, condition to stop iterating.
 
void setMaxBadChannel (double max_bad_channel)
 Maximum channel in which T0 is still need to be calibrated.
 
void setCommonT0 (double commonT0)
 set common T0
 
void enableTextOutput (bool output=true)
 Enable text output of calibration result.
 
void setOutputFileName (std::string outputname)
 output xt T0 file name (for text mode)
 
void setHistFileName (const std::string &name)
 Set name for histogram output.
 
std::string getPrefix () const
 Get the prefix used for getting calibration data.
 
bool checkPyExpRun (PyObject *pyObj)
 Checks that a PyObject can be successfully converted to an ExpRun type.
 
Calibration::ExpRun convertPyExpRun (PyObject *pyObj)
 Performs the conversion of PyObject to ExpRun.
 
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.
 
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.
 
std::list< Database::DBImportQuerygetPayloadValues ()
 Get constants (in TObjects) for database update from last execution but passed by VALUE.
 
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>.
 

Protected Member Functions

EResult calibrate () override
 Run algo on data.
 
void createHisto ()
 create histo for each channel
 
int write ()
 write output or store db
 
double getMeanT0 (TH1F *h1)
 calculate mean of the T0 distribution
 
void setInputFileNames (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.
 
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 updateDBObjPtrs (const unsigned int event, const int run, const int experiment)
 Updates any DBObjPtrs by calling update(event) for DBStore.
 
void setDescription (const std::string &description)
 Set algorithm description (in constructor)
 
void clearCalibrationData ()
 Clear calibration data.
 
Calibration::ExpRun getAllGranularityExpRun () const
 Returns the Exp,Run pair that means 'Everything'. Currently unused.
 
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.
 

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

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

TH1F * m_hTotal
 1D histogram of delta T whole channel
 
TH1F * m_h1 [56][385]
 1D histogram for each channel
 
TH1F * m_hT0b [300]
 1D histogram for each board
 
double m_xmin = 0.07
 minimum drift length
 
double m_ndfmin = 5
 minimum ndf required
 
double m_Pvalmin = 0.
 minimum pvalue required
 
double m_maxMeanDt = 0.2
 Mean of dT distribution of all channels;.
 
double m_offsetMeanDt = -0.4
 offset dT distribution caused by event timing extraction;
 
double m_maxRMSDt = 0.22
 RMS of dT distribution of all channels.
 
double m_maxBadChannel = 50
 Number of channels which has DeltaT0 larger then 0.5.
 
double dt [56][385] = {{0.}}
 dt of each channel
 
double err_dt [56][385] = {{0.}}
 error of dt of each channel
 
double dtb [300] = {0.}
 dt of each board
 
double err_dtb [300] = {0.}
 error of dt of board
 
double m_commonT0 = 4825.
 A common T0 of all channels.
 
bool m_storeHisto = false
 store histo or not
 
bool m_textOutput = false
 output text file if true
 
std::string m_outputT0FileName = "t0_new.dat"
 output t0 file name for text file
 
std::string m_histName = "histT0.root"
 root file name
 
DBObjPtr< CDCGeometrym_cdcGeo
 Geometry of CDC.
 
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

Class for T0 Correction .

Definition at line 25 of file T0CalibrationAlgorithm.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

◆ T0CalibrationAlgorithm()

Constructor.

Definition at line 29 of file T0CalibrationAlgorithm.cc.

29 : CalibrationAlgorithm("CDCCalibrationCollector")
30{
31
33 " -------------------------- T0 Calibration Algorithm -------------------------\n"
34 );
35}
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(....

◆ ~T0CalibrationAlgorithm()

Destructor.

Definition at line 30 of file T0CalibrationAlgorithm.h.

30{}

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

Run algo on data.

Implements CalibrationAlgorithm.

Definition at line 117 of file T0CalibrationAlgorithm.cc.

118{
119 B2INFO("Start calibration");
120
121 gROOT->SetBatch(1);
122 gErrorIgnoreLevel = 3001;
123
124 // We are potentially using data from several runs at once during execution
125 // (which may have different DBObject values). So in general you would need to
126 // average them, or apply them to the correct collector data.
127
128 // However since this is the geometry lets assume it is fixed for now.
129 const auto exprun = getRunList()[0];
130 B2INFO("ExpRun used for DB Geometry : " << exprun.first << " " << exprun.second);
131 updateDBObjPtrs(1, exprun.second, exprun.first);
132
133 // CDCGeometryPar basically constructs a ton of objects and other DB objects.
134 // Normally we'd call updateDBObjPtrs to set the values of the requested DB objects.
135 // But in CDCGeometryPar the DB objects get used during the constructor so they must
136 // be set before/during the constructor.
137
138 // Since we are avoiding using the DataStore EventMetaData, we need to pass in
139 // an EventMetaData object to be used when constructing the DB objects.
140
141 B2INFO("Creating CDCGeometryPar object");
143
144 auto hEvtT0 = getObjectPtr<TH1F>("hEventT0");
145 double dEventT0 = hEvtT0->GetMean();
146 createHisto();
147 TH1F* hm_All = new TH1F("hm_All", "mean of #DeltaT distribution for all channels", 500, -10, 10);
148 TH1F* hs_All = new TH1F("hs_All", "#sigma of #DeltaT distribution for all channels", 100, 0, 10);
149 CDCGeometryPar& cdcgeo = CDCGeometryPar::Instance();
150
151 TF1* g1 = new TF1("g1", "gaus", -100, 100);
152 g1->SetParLimits(1, -20, 20);
153 vector<double> b, db, Sb, dSb;
154 vector<double> c[56];
155 vector<double> dc[56];
156 vector<double> s[56];
157 vector<double> ds[56];
158
159 B2INFO("Gaus fitting for whole channel");
160 double par[3];
161 m_hTotal->SetDirectory(0);
162 double mean = m_hTotal->GetMean();
163 m_hTotal->Fit("g1", "Q", "", mean - 15, mean + 15);
164 g1->GetParameters(par);
165
166 B2INFO("Gaus fitting for each board");
167 for (int ib = 1; ib < 300; ++ib) {
168 // Set Delta_T0=0 again to make sure there is no strange case
169 // in which T0 might be initialed with a strange value
170 dtb[ib] = 0;
171 err_dtb[ib] = 0;
172
173 if (m_hT0b[ib]->Integral(1, m_hT0b[ib]->GetNbinsX()) < 50) {
174 //set error to large number as a flag of bad value
175 err_dtb[ib] = 50; continue;
176 }
177 mean = m_hT0b[ib]->GetMean();
178 m_hT0b[ib]->SetDirectory(0);
179 m_hT0b[ib]->Fit("g1", "Q", "", mean - 15, mean + 15);
180 g1->GetParameters(par);
181 b.push_back(ib);
182 db.push_back(0.0);
183 Sb.push_back(par[1]);
184 dSb.push_back(g1->GetParError(1));
185 dtb[ib] = par[1] + dEventT0;// add dEvtT0 here
186 err_dtb[ib] = g1->GetParError(1);
187 }
188 B2INFO("Gaus fitting for each cell");
189 for (int ilay = 0; ilay < 56; ++ilay) {
190 const unsigned int nW = cdcgeo.nWiresInLayer(ilay);
191 for (unsigned int iwire = 0; iwire < nW; ++iwire) {
192
193 const int n = m_h1[ilay][iwire]->Integral(1, m_h1[ilay][iwire]->GetNbinsX()) ;
194 B2DEBUG(21, "layer " << ilay << " wire " << iwire << " entries " << n);
195 // Set Delta_T0=0 again to make sure there is no strange case
196 // in which T0 might be initialed with a strange value
197 dt[ilay][iwire] = 0;
198 err_dt[ilay][iwire] = 0;
199
200 if (n < 30) {
201 //set error to large number as a flag of bad value
202 err_dt[ilay][iwire] = 50; continue;
203 }
204
205 mean = m_h1[ilay][iwire]->GetMean();
206 m_h1[ilay][iwire]->SetDirectory(0);
207 m_h1[ilay][iwire]->Fit("g1", "Q", "", mean - 15, mean + 15);
208 g1->GetParameters(par);
209 c[ilay].push_back(iwire);
210 dc[ilay].push_back(0.0);
211 s[ilay].push_back(par[1]);
212 ds[ilay].push_back(g1->GetParError(1));
213
214 dt[ilay][iwire] = par[1] + dEventT0; // add dEvtT0 here;
215 err_dt[ilay][iwire] = g1->GetParError(1);
216 hm_All->Fill(par[1]);// mean of gauss fitting.
217 hs_All->Fill(par[2]); // sigma of gauss fitting.
218 }
219 }
220
221 if (m_storeHisto) {
222 B2INFO("Storing histograms");
223 auto hNDF = getObjectPtr<TH1F>("hNDF");
224 auto hPval = getObjectPtr<TH1F>("hPval");
225 TFile* fout = new TFile(m_histName.c_str(), "RECREATE");
226 fout->cd();
227 TGraphErrors* gr[56];
228 TDirectory* top = gDirectory;
229
230 //store NDF, P-val. EventT0 histogram for monitoring during calibration
231 if (hNDF && hPval && hEvtT0) {
232 hEvtT0->Write();
233 hPval->Write();
234 hNDF->Write();
235 }
236 m_hTotal->Write();
237 hm_All->Write();
238 hs_All->Write();
239 TDirectory* subDir[56];
240 for (int ilay = 0; ilay < 56; ++ilay) {
241 subDir[ilay] = top ->mkdir(Form("lay_%d", ilay));
242 subDir[ilay]->cd();
243 const unsigned int nW = cdcgeo.nWiresInLayer(ilay);
244 for (unsigned int iwire = 0; iwire < nW; ++iwire) {
245 m_h1[ilay][iwire]->Write();
246 }
247 }
248
249 top->cd();
250 TDirectory* corrT0 = top->mkdir("DeltaT0");
251 corrT0->cd();
252
253 if (b.size() > 2) {
254 TGraphErrors* grb = new TGraphErrors(b.size(), &b.at(0), &Sb.at(0), &db.at(0), &dSb.at(0));
255 grb->SetMarkerColor(2);
256 grb->SetMarkerSize(1.0);
257 grb->SetTitle("#DeltaT0;BoardID;#DeltaT0[ns]");
258 grb->SetMaximum(10);
259 grb->SetMinimum(-10);
260 grb->SetName("Board");
261 grb->Write();
262 }
263 for (int sl = 0; sl < 56; ++sl) {
264 if (c[sl].size() < 2) continue;
265 gr[sl] = new TGraphErrors(c[sl].size(), &c[sl].at(0), &s[sl].at(0), &dc[sl].at(0), &ds[sl].at(0));
266 gr[sl]->SetMarkerColor(2);
267 gr[sl]->SetMarkerSize(1.0);
268 gr[sl]->SetTitle(Form("Layer_%d;IWire;#LT t_{mea}-t_{fit} #GT [ns]", sl));
269 gr[sl]->SetMaximum(10);
270 gr[sl]->SetMinimum(-10);
271 gr[sl]->SetName(Form("lay%d", sl));
272 gr[sl]->Write();
273 }
274 fout->Close();
275 }
276 B2INFO("Writing constants...");
277 int Ngood_T0 = write();
278 B2INFO("Checking conversion conditions...");
279 double rms_dT = hm_All->GetRMS();
280 double n_below = hm_All->Integral(0, hm_All->GetXaxis()->FindBin(m_offsetMeanDt - 5 * rms_dT));
281 double n_upper = hm_All->Integral(hm_All->GetXaxis()->FindBin(m_offsetMeanDt + 5 * rms_dT), hm_All->GetXaxis()->GetNbins() - 1);
282 int N_remaining = n_below + n_upper - (14112 - Ngood_T0);
283 if (N_remaining < 0) N_remaining = 0;
284 B2INFO("+ Number of channel which are properly calibrated : " << Ngood_T0);
285 B2INFO("+ Number of channel which still need to be calibrated are: " << N_remaining << "(requirement <" << m_maxBadChannel << ")");
286 B2INFO("+ Median of Delta_T - offset:" << hm_All->GetMean() - m_offsetMeanDt << "(requirement: <" << m_maxMeanDt << ")");
287 B2INFO("+ RMS of Delta_T dist. :" << rms_dT << " (Requirement: <" << m_maxRMSDt << ")");
288
289 if (fabs(hm_All->GetMean() - m_offsetMeanDt) < m_maxMeanDt
290 && fabs(hm_All->GetRMS()) < m_maxRMSDt
291 && N_remaining < m_maxBadChannel) {
292 B2INFO("T0 Calibration Finished:");
293 return c_OK;
294 } else {
295 B2INFO("Need more iteration ...");
296 return c_Iterate;
297 }
298}
unsigned nWiresInLayer(int layerId) const
Returns wire numbers in a layer.
static CDCGeometryPar & Instance(const CDCGeometry *=nullptr)
Static method to get a reference to the CDCGeometryPar instance.
double m_offsetMeanDt
offset dT distribution caused by event timing extraction;
TH1F * m_hTotal
1D histogram of delta T whole channel
double dt[56][385]
dt of each channel
void createHisto()
create histo for each channel
double m_maxRMSDt
RMS of dT distribution of all channels.
DBObjPtr< CDCGeometry > m_cdcGeo
Geometry of CDC.
double m_maxMeanDt
Mean of dT distribution of all channels;.
TH1F * m_h1[56][385]
1D histogram for each channel
double err_dt[56][385]
error of dt of each channel
TH1F * m_hT0b[300]
1D histogram for each board
double err_dtb[300]
error of dt of board
double m_maxBadChannel
Number of channels which has DeltaT0 larger then 0.5.
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.
@ c_OK
Finished successfully =0 in Python.
@ c_Iterate
Needs iteration =1 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...

◆ checkPyExpRun()

bool checkPyExpRun ( PyObject * pyObj)
inherited

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 311 of file CalibrationAlgorithm.cc.

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

◆ convertPyExpRun()

ExpRun convertPyExpRun ( PyObject * pyObj)
inherited

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}

◆ createHisto()

void createHisto ( )
protected

create histo for each channel

Definition at line 37 of file T0CalibrationAlgorithm.cc.

38{
39
40 B2INFO("Creating histograms");
41 Float_t x;
42 Float_t t_mea;
43 Float_t t_fit;
44 Float_t ndf;
45 Float_t Pval;
46 UShort_t IWire;
47 UChar_t lay;
48
49 auto tree = getObjectPtr<TTree>("tree");
50 tree->SetBranchAddress("lay", &lay);
51 tree->SetBranchAddress("IWire", &IWire);
52 tree->SetBranchAddress("x_u", &x);
53 tree->SetBranchAddress("t", &t_mea);
54 tree->SetBranchAddress("t_fit", &t_fit);
55 tree->SetBranchAddress("ndf", &ndf);
56 tree->SetBranchAddress("Pval", &Pval);
57
58
59 /* Disable unused branch */
60 std::vector<TString> list_vars = {"lay", "IWire", "x_u", "t", "t_fit", "Pval", "ndf"};
61 tree->SetBranchStatus("*", 0);
62
63 for (TString brname : list_vars) {
64 tree->SetBranchStatus(brname, 1);
65 }
66
67
68 double halfCSize[56];
69
70 CDCGeometryPar& cdcgeo = CDCGeometryPar::Instance();
71
72 for (int i = 0; i < 56; ++i) {
73 double R = cdcgeo.senseWireR(i);
74 double nW = cdcgeo.nWiresInLayer(i);
75 halfCSize[i] = M_PI * R / nW;
76 }
77
78 m_hTotal = new TH1F("hTotal", "hTotal", 30, -15, 15);
79
80 //for each channel
81 for (int il = 0; il < 56; il++) {
82 const int nW = cdcgeo.nWiresInLayer(il);
83 for (int ic = 0; ic < nW; ++ic) {
84 m_h1[il][ic] = new TH1F(Form("hdT_L%d_W%d", il, ic), Form("L%d_cell%d", il, ic), 30, -15, 15);
85 }
86 }
87
88 //for each board
89 for (int ib = 0; ib < 300; ++ib) {
90 m_hT0b[ib] = new TH1F(Form("hdT_b%d", ib), Form("boardID_%d", ib), 100, -20, 20);
91 }
92
93 //read data
94 const Long64_t nEntries = tree->GetEntries();
95 B2INFO("Number of entries: " << nEntries);
96 TStopwatch timer;
97 timer.Start();
98 for (Long64_t i = 0; i < nEntries; ++i) {
99 tree->GetEntry(i);
100 double xmax = halfCSize[lay] - 0.1;
101 if ((fabs(x) < m_xmin) || (fabs(x) > xmax)
102 || (ndf < m_ndfmin)
103 || (Pval < m_Pvalmin)) continue; /*select good region*/
104 //each channel
105 m_hTotal->Fill(t_mea - t_fit);
106 m_h1[lay][IWire]->Fill(t_mea - t_fit);
107 //each board
108 int boardID = cdcgeo.getBoardID(WireID(lay, IWire));
109 m_hT0b[boardID]->Fill(t_mea - t_fit);
110 }
111 timer.Stop();
112 B2INFO("Finish making histogram for all channels");
113 B2INFO("Time to fill histograms: " << timer.RealTime() << "s");
114
115}
double R
typedef autogenerated by FFTW
unsigned short getBoardID(const WireID &wID) const
Returns frontend board id. corresponding to the wire id.
double senseWireR(int layerId) const
Returns radius of sense wire in each layer.
double m_Pvalmin
minimum pvalue required

◆ 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();}

◆ enableTextOutput()

void enableTextOutput ( bool output = true)
inline

Enable text output of calibration result.

Definition at line 50 of file T0CalibrationAlgorithm.h.

50{m_textOutput = output;}

◆ 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}
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.
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.
virtual EResult calibrate()=0
Run algo on data - pure virtual: needs to be implemented.
std::string getGranularity() const
Get the granularity of collected data.

◆ fillRunToInputFilesMap()

void fillRunToInputFilesMap ( )
inherited

Fill the mapping of ExpRun -> Files.

Definition at line 330 of file CalibrationAlgorithm.cc.

331{
332 m_runsToInputFiles.clear();
333 // Save TDirectory to change back at the end
334 TDirectory* dir = gDirectory;
335 RunRange* runRange;
336 // Construct the TDirectory name where we expect our objects to be
337 string runRangeObjName(getPrefix() + "/" + RUN_RANGE_OBJ_NAME);
338 for (const auto& fileName : m_inputFileNames) {
339 //Open TFile to get the objects
340 unique_ptr<TFile> f;
341 f.reset(TFile::Open(fileName.c_str(), "READ"));
342 runRange = dynamic_cast<RunRange*>(f->Get(runRangeObjName.c_str()));
343 if (runRange) {
344 // Insert or extend the run -> file mapping for this ExpRun
345 auto expRuns = runRange->getExpRunSet();
346 for (const auto& expRun : expRuns) {
347 auto runFiles = m_runsToInputFiles.find(expRun);
348 if (runFiles != m_runsToInputFiles.end()) {
349 (runFiles->second).push_back(fileName);
350 } else {
351 m_runsToInputFiles.insert(std::make_pair(expRun, std::vector<std::string> {fileName}));
352 }
353 }
354 } else {
355 B2WARNING("Missing a RunRange object for file: " << fileName);
356 }
357 }
358 dir->cd();
359}
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 520 of file CalibrationAlgorithm.cc.

521{
522 m_boundaries.clear();
523 if (m_inputFileNames.empty()) {
524 B2ERROR("There aren't any input files set. Please use CalibrationAlgorithm::setInputFiles()");
525 return m_boundaries;
526 }
527 // Reset the internal execution data just in case something is hanging around
528 m_data.reset();
529 if (runs.empty()) {
530 // Want to loop over all runs we could possibly know about
531 runs = getRunListFromAllData();
532 }
533 // Let's check that we have some now
534 if (runs.empty()) {
535 B2ERROR("No collected data in input files.");
536 return m_boundaries;
537 }
538 // In order to find run boundaries we must have collected with data granularity == 'run'
539 if (strcmp(getGranularity().c_str(), "all") == 0) {
540 B2ERROR("The data is collected with granularity='all' (exp=-1,run=-1), and we can't use that to find run boundaries.");
541 return m_boundaries;
542 }
543 m_data.setIteration(iteration);
544 // User defined setup function
545 boundaryFindingSetup(runs, iteration);
546 std::vector<ExpRun> runList;
547 // Loop over run list and call derived class "isBoundaryRequired" member function
548 for (auto currentRun : runs) {
549 runList.push_back(currentRun);
550 m_data.setRequestedRuns(runList);
551 // After here, the getObject<...>(...) helpers start to work
552 if (isBoundaryRequired(currentRun)) {
553 m_boundaries.push_back(currentRun);
554 }
555 // Only want run-by-run
556 runList.clear();
557 // Don't want memory hanging around
558 m_data.clearCalibrationData();
559 }
560 m_data.reset();
562 return m_boundaries;
563}
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...

◆ getAllGranularityExpRun()

Calibration::ExpRun getAllGranularityExpRun ( ) const
inlineprotectedinherited

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

Definition at line 327 of file CalibrationAlgorithm.h.

327{return m_allExpRun;}

◆ getCollectorName()

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;}

◆ 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()

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 383 of file CalibrationAlgorithm.cc.

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

326{
328}
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(); }

◆ getMeanT0()

double getMeanT0 ( TH1F * h1)
protected

calculate mean of the T0 distribution

Definition at line 381 of file T0CalibrationAlgorithm.cc.

382{
383 double mean1 = h1->GetMean();
384 h1->GetXaxis()->SetRangeUser(mean1 - 50, 8000);
385 double mean2 = h1->GetMean();
386 while (fabs(mean1 - mean2) > 0.5) {
387 mean1 = mean2;
388 h1->GetXaxis()->SetRangeUser(mean1 - 50, 8000);
389 mean2 = h1->GetMean();
390 }
391 return mean2;
392
393}

◆ 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()

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

Get constants (in TObjects) for database update from last execution but passed by VALUE.

Definition at line 207 of file CalibrationAlgorithm.h.

207{return m_data.getPayloadValues();}

◆ getPrefix()

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;}

◆ 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 318 of file CalibrationAlgorithm.cc.

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

◆ getRunRangeFromAllData()

RunRange getRunRangeFromAllData ( ) const
inherited

Get the complete RunRange from inspection of collected data.

Definition at line 361 of file CalibrationAlgorithm.cc.

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

◆ getVecInputFileNames()

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 502 of file CalibrationAlgorithm.cc.

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

◆ 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}
void saveCalibration(TClonesArray *data, const std::string &name)
Store DBArray payload with given name with default IOV.

◆ 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}

◆ setCommonT0()

void setCommonT0 ( double commonT0)
inline

set common T0

Definition at line 47 of file T0CalibrationAlgorithm.h.

47{m_commonT0 = commonT0;}

◆ 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;}

◆ setHistFileName()

void setHistFileName ( const std::string & name)
inline

Set name for histogram output.

Definition at line 56 of file T0CalibrationAlgorithm.h.

56{m_histName = "histT0_" + name + ".root";}

◆ setInputFileNames() [1/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}
void setInputFileNames(PyObject *inputFileNames)
Set the input file names used for this algorithm from a Python list.
Scalar convertPythonObject(const boost::python::object &pyObject, Scalar)
Convert from Python to given type.

◆ setInputFileNames() [2/2]

void setInputFileNames ( 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...
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.

◆ setMaxBadChannel()

void setMaxBadChannel ( double max_bad_channel)
inline

Maximum channel in which T0 is still need to be calibrated.

Definition at line 44 of file T0CalibrationAlgorithm.h.

44{m_maxBadChannel = max_bad_channel;}

◆ setMaxMeanDt()

void setMaxMeanDt ( double maxMeanDt)
inline

Maximum mean of dt of all channels distribution, condition to stop iterating.

Definition at line 40 of file T0CalibrationAlgorithm.h.

40{m_maxMeanDt = maxMeanDt;}

◆ setMaxRMSDt()

void setMaxRMSDt ( double maxRMSDt)
inline

Maximum RMS of dt of all channels distribution, condition to stop iterating.

Definition at line 38 of file T0CalibrationAlgorithm.h.

38{m_maxRMSDt = maxRMSDt;}

◆ setMinimumNDF()

void setMinimumNDF ( double minndf)
inline

minimum ndf require for track.

Definition at line 34 of file T0CalibrationAlgorithm.h.

34{m_ndfmin = minndf;}

◆ setMinimumPval()

void setMinimumPval ( double minPval)
inline

minimum pvalue requirement.

Definition at line 36 of file T0CalibrationAlgorithm.h.

36{m_Pvalmin = minPval;}

◆ setOffsetMeanDt()

void setOffsetMeanDt ( double offsetMeanDt)
inline

Maximum mean of dt of all channels distribution, condition to stop iterating.

Definition at line 42 of file T0CalibrationAlgorithm.h.

42{m_offsetMeanDt = offsetMeanDt;}

◆ setOutputFileName()

void setOutputFileName ( std::string outputname)
inline

output xt T0 file name (for text mode)

Definition at line 53 of file T0CalibrationAlgorithm.h.

53{m_outputT0FileName.assign(outputname);}

◆ 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;}

◆ storeHisto()

void storeHisto ( bool storeHist = false)
inline

store Hisotgram or not.

Definition at line 32 of file T0CalibrationAlgorithm.h.

32{m_storeHisto = storeHist;}

◆ updateDBObjPtrs()

void updateDBObjPtrs ( const unsigned int event = 1,
const int run = 0,
const int experiment = 0 )
protectedinherited

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

Definition at line 404 of file CalibrationAlgorithm.cc.

405{
406 // Construct an EventMetaData object but NOT in the Datastore
407 EventMetaData emd(event, run, experiment);
408 // Explicitly update while avoiding registering a Datastore object
410 // Also update the intra-run objects to the event at the same time (maybe unnecessary...)
412}
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

◆ write()

int write ( )
protected

write output or store db

Definition at line 300 of file T0CalibrationAlgorithm.cc.

301{
302 CDCGeometryPar& cdcgeo = CDCGeometryPar::Instance();
303 CDCTimeZeros* tz = new CDCTimeZeros();
304
305 TH1F* hT0B[300];
306 for (int ib = 0; ib < 300; ++ib) {
307 hT0B[ib] = new TH1F(Form("hT0B%d", ib), Form("boardID_%d", ib), 9000, 0, 9000);
308 }
309
310 TH1F* hT0_all = new TH1F("hT0_all", "T0 distribution", 9000, 0, 9000);
311 double T0;
312 // get old T0 to calculate T0 mean of each board
313 for (int ilay = 0; ilay < 56; ++ilay) {
314 const unsigned int nW = cdcgeo.nWiresInLayer(ilay);
315 for (unsigned int iwire = 0; iwire < nW; ++iwire) {
316 WireID wireid(ilay, iwire);
317 T0 = cdcgeo.getT0(wireid);
318 hT0_all->Fill(T0);
319 hT0B[cdcgeo.getBoardID(wireid)]->Fill(T0);
320 }
321 }
322
323 //get Nominal T0
324 double T0_average = getMeanT0(hT0_all);
325 if (fabs(T0_average - m_commonT0) > 50) {B2WARNING("Large difference between common T0 (" << m_commonT0 << ") and aveage value" << T0_average);}
326 // get average T0 for each board and also apply T0 correction for T0 of that board
327 double T0B[300];
328 for (int i = 0; i < 300; ++i) {T0B[i] = m_commonT0;}
329
330
331 for (int ib = 1; ib < 300; ++ib) {
332 T0B[ib] = getMeanT0(hT0B[ib]);
333 if (fabs(T0B[ib] - T0_average) > 25) {
334 B2WARNING("T0 of Board " << ib << " (= " << T0B[ib] << ") is too different with common T0: " << T0_average <<
335 "\n It will be replaced by common T0");
336 T0B[ib] = T0_average;
337 continue;
338 }
339 //correct T0 board
340 if (abs(err_dtb[ib]) < 2 && abs(dtb[ib]) < 20) {
341 T0B[ib] -= dtb[ib];
342 }
343 }
344
345 //correct T0 and write
346 double dT;
347 int N_good = 0;
348 for (int ilay = 0; ilay < 56; ++ilay) {
349 const unsigned int nW = cdcgeo.nWiresInLayer(ilay);
350 for (unsigned int iwire = 0; iwire < nW; ++iwire) {
351 WireID wireid(ilay, iwire);
352 int bID = cdcgeo.getBoardID(wireid);
353
354 //get old T0, replace with common T0 of board or average over all channel.
355 T0 = cdcgeo.getT0(wireid);
356 if (fabs(T0 - T0B[bID]) > 25 || fabs(T0 - T0_average) > 25) {
357 B2WARNING("T0 of wireID L-W: " << ilay << "--" << iwire << " (= " << T0
358 << ") is too different with common T0 of board: " << bID << " = " << T0B[bID] <<
359 "\n It will be replaced by common T0 of the Board");
360 T0 = T0B[bID];
361 }
362
363 //select DeltaT
364 dT = 0;
365 if (abs(err_dt[ilay][iwire]) < 2 && abs(dt[ilay][iwire]) < 20) {
366 dT = dt[ilay][iwire];
367 N_good += 1;
368 }
369
370 //export
371 tz->setT0(wireid, T0 - dT);
372 }
373 }
374
375 if (m_textOutput == true) {
377 }
378 saveCalibration(tz, "CDCTimeZeros");
379 return N_good;
380}
void outputToFile(std::string fileName) const
Output the contents in text file format.
void setT0(unsigned short iCLayer, unsigned short iWire, float t0)
Set t0 in the list.
float getT0(const WireID &wireID) const
Returns t0 parameter of the specified sense wire.
std::string m_outputT0FileName
output t0 file name for text file
double getMeanT0(TH1F *h1)
calculate mean of the T0 distribution
double m_commonT0
A common T0 of all channels.
bool m_textOutput
output text file if true

Member Data Documentation

◆ dt

double dt[56][385] = {{0.}}
private

dt of each channel

Definition at line 79 of file T0CalibrationAlgorithm.h.

79{{0.}};

◆ dtb

double dtb[300] = {0.}
private

dt of each board

Definition at line 81 of file T0CalibrationAlgorithm.h.

81{0.};

◆ err_dt

double err_dt[56][385] = {{0.}}
private

error of dt of each channel

Definition at line 80 of file T0CalibrationAlgorithm.h.

80{{0.}};

◆ err_dtb

double err_dtb[300] = {0.}
private

error of dt of board

Definition at line 82 of file T0CalibrationAlgorithm.h.

82{0.};

◆ 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_cdcGeo

DBObjPtr<CDCGeometry> m_cdcGeo
private

Geometry of CDC.

Definition at line 89 of file T0CalibrationAlgorithm.h.

◆ m_commonT0

double m_commonT0 = 4825.
private

A common T0 of all channels.

Definition at line 83 of file T0CalibrationAlgorithm.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_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_h1

TH1F* m_h1[56][385]
private

1D histogram for each channel

Definition at line 69 of file T0CalibrationAlgorithm.h.

◆ m_histName

std::string m_histName = "histT0.root"
private

root file name

Definition at line 88 of file T0CalibrationAlgorithm.h.

◆ m_hT0b

TH1F* m_hT0b[300]
private

1D histogram for each board

Definition at line 70 of file T0CalibrationAlgorithm.h.

◆ m_hTotal

TH1F* m_hTotal
private

1D histogram of delta T whole channel

Definition at line 68 of file T0CalibrationAlgorithm.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_maxBadChannel

double m_maxBadChannel = 50
private

Number of channels which has DeltaT0 larger then 0.5.

Definition at line 78 of file T0CalibrationAlgorithm.h.

◆ m_maxMeanDt

double m_maxMeanDt = 0.2
private

Mean of dT distribution of all channels;.

Definition at line 75 of file T0CalibrationAlgorithm.h.

◆ m_maxRMSDt

double m_maxRMSDt = 0.22
private

RMS of dT distribution of all channels.

Definition at line 77 of file T0CalibrationAlgorithm.h.

◆ m_ndfmin

double m_ndfmin = 5
private

minimum ndf required

Definition at line 72 of file T0CalibrationAlgorithm.h.

◆ m_offsetMeanDt

double m_offsetMeanDt = -0.4
private

offset dT distribution caused by event timing extraction;

Definition at line 76 of file T0CalibrationAlgorithm.h.

◆ m_outputT0FileName

std::string m_outputT0FileName = "t0_new.dat"
private

output t0 file name for text file

Definition at line 87 of file T0CalibrationAlgorithm.h.

◆ 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_Pvalmin

double m_Pvalmin = 0.
private

minimum pvalue required

Definition at line 73 of file T0CalibrationAlgorithm.h.

◆ 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_storeHisto

bool m_storeHisto = false
private

store histo or not

Definition at line 85 of file T0CalibrationAlgorithm.h.

◆ m_textOutput

bool m_textOutput = false
private

output text file if true

Definition at line 86 of file T0CalibrationAlgorithm.h.

◆ m_xmin

double m_xmin = 0.07
private

minimum drift length

Definition at line 71 of file T0CalibrationAlgorithm.h.


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