Belle II Software development
CDCDedx1DCellAlgorithm Class Reference

A calibration algorithm for CDC dE/dx electron: 1D enta cleanup correction. More...

#include <CDCDedx1DCellAlgorithm.h>

Inheritance diagram for CDCDedx1DCellAlgorithm:
CalibrationAlgorithm

Public Types

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

Public Member Functions

 CDCDedx1DCellAlgorithm ()
 Constructor: Sets the description, the properties and the parameters of the algorithm.
 
virtual ~CDCDedx1DCellAlgorithm ()
 Destructor.
 
void setSuffix (const std::string &value)
 adding suffix to control plots
 
void setVariableBins (bool value)
 Set Var bins flag to on or off.
 
void setLayerTrunc (bool value=false)
 function to set truncation method (local vs global)
 
void setMergePayload (bool value)
 set false if generating absolute (not relative) payload
 
void setSplitFactor (int value)
 set bin split factor for all range
 
void setRotSymmetry (bool value)
 set rotation sys to copy constants from one region to other
 
void setTrucationBins (double lowedge, double upedge)
 function to set bins of truncation from histogram
 
void enableExtraPlots (bool value=false)
 function to set flag active for plotting
 
void setPtLimit (double value)
 function to set pt limit
 
void setCosLimit (double value)
 function to set cos $\theta$ limit
 
void setBaselineFactor (double charge, double factor)
 adjust baseline based on charge or global overall works for only single charge or both
 
int rotationalBin (int nbin, int ibin)
 class function to set rotation symmetry
 
void getExpRunInfo ()
 function to get extract calibration run/exp
 
void CreateBinMapping ()
 class function to create vectors for bin mapping (Var->symm)
 
void defineHisto (std::vector< TH1D * > hdedxhit[2], TH1D *hdedxlay[2], TH1D *hentalay[2])
 function to define histograms
 
void getTruncatedBins (TH1D *hist, int &binlow, int &binhigh)
 function to get bins of truncation from histogram
 
double getTruncationMean (TH1D *hist, int binlow, int binhigh)
 function to get truncated mean
 
void createPayload ()
 function to generate final constants
 
void plotMergeFactor (std::map< int, std::vector< double > > bounds, const std::array< int, 2 > nDev, std::map< int, std::vector< int > > steps)
 function to plot merging factor
 
void plotdedxHist (std::vector< TH1D * > hdedxhit[2])
 function to draw the dE/dx histogram in enta bins
 
void plotLayerDist (TH1D *hdedxL[2])
 function to draw dedx dist.
 
void plotQaPars (TH1D *hentalay[2], TH2D *hptcosth)
 function to draw pt vs costh and entrance angle distribution for Inner/Outer layer
 
void plotRelConst (std::vector< double >tempconst, std::vector< double >layerconst, int il)
 function to draw symm/Var layer constant
 
void plotConstants ()
 function to draw the old/new final constants
 
void plotEventStats ()
 function to draw the stats plots
 
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

virtual EResult calibrate () override
 1D cell algorithm
 
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

double m_eaMin
 lower edge of entrance angle
 
double m_eaMax
 upper edge of entrance angle
 
double m_eaBW
 binwdith of entrance angle bin
 
int m_eaBin
 
int m_eaB
 reset # of bins for entrance angle for each experiment
 
double m_dedxMin
 lower edge of dedxhit
 
double m_dedxMax
 upper edge of dedxhit
 
int m_dedxBin
 
double m_ptMax
 a limit on transverse momentum
 
double m_cosMax
 a limit on cos theta
 
double m_truncMin
 lower threshold on truncation
 
double m_truncMax
 upper threshold on truncation
 
int m_binSplit
 multiply nbins by this factor in full range
 
double m_chargeType
 charge type for baseline adj
 
double m_adjustFac
 factor with that one what to adjust baseline
 
bool isFixTrunc
 true = fix window for all out/inner layers
 
bool isVarBins
 true: if variable bin size is requested
 
bool isRotSymm
 if rotation symmetry requested
 
bool isMakePlots
 produce plots for status
 
bool isPrintLog
 print more debug information
 
bool isMerge
 print more debug information
 
std::string m_suffix
 add suffix to all plot name
 
std::string m_runExp
 add suffix to all plot name
 
std::string m_label [2] = {"IL", "OL"}
 add inner/outer layer label
 
std::vector< int > m_eaBinLocal
 
std::array< std::vector< int >, 2 > m_binIndex
 symm/Var bin numbers
 
std::array< std::vector< double >, 2 > m_binValue
 enta Var bin values
 
std::vector< std::vector< double > > m_onedcors
 final vectors of calibration
 
DBObjPtr< CDCDedx1DCellm_DBOneDCell
 One cell 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: 1D enta cleanup correction.

Definition at line 28 of file CDCDedx1DCellAlgorithm.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

◆ CDCDedx1DCellAlgorithm()

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

Definition at line 25 of file CDCDedx1DCellAlgorithm.cc.

25 :
26 CalibrationAlgorithm("CDCDedxElectronCollector"),
27 m_eaMin(-TMath::Pi() / 2),
28 m_eaMax(+TMath::Pi() / 2),
29 m_eaB(316),
30 m_dedxMin(0.0),
31 m_dedxMax(5.0),
32 m_dedxBin(250),
33 m_ptMax(8.0),
34 m_cosMax(1.0),
35 m_truncMin(0.05),
36 m_truncMax(0.75),
37 m_binSplit(3),
38 m_chargeType(0),
39 m_adjustFac(1.00),
40 isFixTrunc(false),
41 isVarBins(true),
42 isRotSymm(false),
43 isMakePlots(true),
44 isPrintLog(false),
45 isMerge(true),
46 m_suffix("")
47{
48 // Set module properties
49 setDescription("A calibration algorithm for the CDC dE/dx entrance angle cleanup correction");
50}
double m_eaMax
upper edge of entrance angle
double m_truncMax
upper threshold on truncation
int m_binSplit
multiply nbins by this factor in full range
double m_truncMin
lower threshold on truncation
double m_adjustFac
factor with that one what to adjust baseline
double m_chargeType
charge type for baseline adj
double m_cosMax
a limit on cos theta
bool isPrintLog
print more debug information
std::string m_suffix
add suffix to all plot name
int m_eaB
reset # of bins for entrance angle for each experiment
double m_ptMax
a limit on transverse momentum
bool isFixTrunc
true = fix window for all out/inner layers
bool isVarBins
true: if variable bin size is requested
bool isRotSymm
if rotation symmetry requested
double m_dedxMax
upper edge of dedxhit
bool isMakePlots
produce plots for status
bool isMerge
print more debug information
double m_dedxMin
lower edge of dedxhit
double m_eaMin
lower edge of entrance angle
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(....

◆ ~CDCDedx1DCellAlgorithm()

virtual ~CDCDedx1DCellAlgorithm ( )
inlinevirtual

Destructor.

Definition at line 40 of file CDCDedx1DCellAlgorithm.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

1D cell algorithm

Implements CalibrationAlgorithm.

Definition at line 55 of file CDCDedx1DCellAlgorithm.cc.

56{
57
59
60 if (!m_DBOneDCell.isValid())
61 B2FATAL("There is no valid previous payload for CDCDedx1DCell");
62
63 //reading radiative electron collector TREE
64 auto ttree = getObjectPtr<TTree>("tree");
65 if (!ttree) return c_NotEnoughData;
66
67 std::vector<double>* dedxhit = 0, *enta = 0;
68 std::vector<int>* layer = 0;
69 double pt = 0, costh = 0;
70
71 ttree->SetBranchAddress("dedxhit", &dedxhit);
72 ttree->SetBranchAddress("entaRS", &enta);
73 ttree->SetBranchAddress("layer", &layer);
74 ttree->SetBranchAddress("pt", &pt);
75 ttree->SetBranchAddress("costh", &costh);
76
77 //repair nbins if they are not divisible accordingly
80
81 //Settings of variables bins
83
84 if (isPrintLog) {
85 B2INFO("inner layers bins: " << m_eaBinLocal[0]);
86 B2INFO("outer layers bins: " << m_eaBinLocal[1]);
87 }
88
89 // dedxhit vector to store dE/dx values for each enta bin
90 std::vector<TH1D*> hdedxhit[2];
91 TH1D* hdedxlay[2];
92 TH1D* hentalay[2];
93
94 TH2D* hptcosth = new TH2D("hptcosth", "pt vs costh dist;pt;costh", 1000, -8.0, 8.0, 1000, -1.0, 1.0);
95
96 defineHisto(hdedxhit, hdedxlay, hentalay);
97
98 //Star filling histogram defined above
99 for (int i = 0; i < ttree->GetEntries(); ++i) {
100
101 ttree->GetEvent(i);
102
103 if (std::abs(costh) > m_cosMax) continue;
104
105 // remove wide angle bhabha tracks
106 // double mom = pt/sqrt(1-costh*costh);
107 // if(abs(pt)<2.4 && abs(mom)>3.6)continue;
108
109 if (std::abs(pt) > m_ptMax) continue;
110
111 //change to random 10%
112 int rand = gRandom->Integer(100);
113 if (rand < 10) hptcosth->Fill(pt, costh);
114
115 for (unsigned int j = 0; j < dedxhit->size(); ++j) {
116
117 if (dedxhit->at(j) == 0) continue;
118
119 double entaval = enta->at(j);
120 //Mapped bin corresponds to entaval
121 int ibin = std::floor((entaval - m_eaMin) / m_eaBW);
122 if (ibin < 0 || ibin > m_eaBin) continue;
123
124 int mL = -1;
125 if (layer->at(j) < 8)mL = 0;
126 else mL = 1;
127
128 hdedxlay[mL]->Fill(dedxhit->at(j));
129 if (rand < 10) hentalay[mL]->Fill(entaval);
130
131 int jbinea = ibin;
132 if (isVarBins) jbinea = m_binIndex[mL].at(ibin);
133 hdedxhit[mL][jbinea]->Fill(dedxhit->at(j));
134 }
135 }
136
137 for (int il = 0; il < 2; il++) {
138
139 int minlay = 0, maxlay = 0;
140
141 if (isFixTrunc) {
142 getTruncatedBins(hdedxlay[il], minlay, maxlay);
143 hdedxlay[il]->SetTitle(Form("%s;%d;%d", hdedxlay[il]->GetTitle(), minlay, maxlay));
144 }
145
146 std::vector<double>tempconst;
147 tempconst.reserve(m_eaBinLocal[il]);
148
149 for (int iea = 0; iea < m_eaBinLocal[il]; iea++) {
150
151 int jea = iea;
152
153 // rotation symmtery for 1<->3 and 4<->2 but only symmetric bin
154 if (!isVarBins && isRotSymm) jea = rotationalBin(m_eaBinLocal[il], jea);
155
156 TH1D* htemp = (TH1D*)hdedxhit[il][jea]->Clone(Form("h_%s_b%d_c", m_label[il].data(), jea));
157
158 int minbin = 1, maxbin = 1;
159 if (isFixTrunc) {
160 minbin = minlay;
161 maxbin = maxlay;
162 } else {
163 //extract truncation window per bin
164 getTruncatedBins(htemp, minbin, maxbin);
165 }
166
167 double dedxmean;
168 dedxmean = getTruncationMean(htemp, minbin, maxbin);
169 tempconst.push_back(dedxmean);
170
171 hdedxhit[il][iea]->SetTitle(Form("%s, #mu_{truc} = %0.5f;%d;%d", hdedxhit[il][iea]->GetTitle(), dedxmean, minbin, maxbin));
172 }
173
174 //Expending constants
175 std::vector<double>layerconst;
176 layerconst.reserve(m_eaBin);
177
178 for (int iea = 0; iea < m_eaBin; iea++) {
179 int jea = iea;
180 if (isVarBins) jea = m_binIndex[il].at(iea);
181 layerconst.push_back(tempconst.at(jea));
182 }
183
184 // plot the rel constants var/sym bins
185 if (isMakePlots) plotRelConst(tempconst, layerconst, il);
186 m_onedcors.push_back(layerconst);
187
188 layerconst.clear();
189 tempconst.clear();
190 }
191
192 //Saving final constants
194
195 if (isMakePlots) {
196
197 //1. dE/dx dist. for entrance angle bins
198 plotdedxHist(hdedxhit);
199
200 //3. Inner and Outer layer dE/dx distributions
201 plotLayerDist(hdedxlay);
202
203 //4. entrance angle distribution sym/var bins
204 plotQaPars(hentalay, hptcosth);
205
206 //6. draw the final constants
208
209 //7. plot statistics related plots here
211 }
212
213 for (int il = 0; il < 2; il++) {
214 delete hentalay[il];
215 delete hdedxlay[il];
216 for (int iea = 0; iea < m_eaBinLocal[il]; iea++)
217 delete hdedxhit[il][iea];
218 }
219
220 delete hptcosth;
221 m_eaBinLocal.clear();
222 for (int il = 0; il < 2; il++) {
223 m_binValue[il].clear();
224 m_binIndex[il].clear();
225 }
226 return c_OK;
227}
std::string m_label[2]
add inner/outer layer label
std::array< std::vector< int >, 2 > m_binIndex
symm/Var bin numbers
void getTruncatedBins(TH1D *hist, int &binlow, int &binhigh)
function to get bins of truncation from histogram
void CreateBinMapping()
class function to create vectors for bin mapping (Var->symm)
void getExpRunInfo()
function to get extract calibration run/exp
DBObjPtr< CDCDedx1DCell > m_DBOneDCell
One cell correction DB object.
std::array< std::vector< double >, 2 > m_binValue
enta Var bin values
double getTruncationMean(TH1D *hist, int binlow, int binhigh)
function to get truncated mean
void plotConstants()
function to draw the old/new final constants
void plotdedxHist(std::vector< TH1D * > hdedxhit[2])
function to draw the dE/dx histogram in enta bins
void defineHisto(std::vector< TH1D * > hdedxhit[2], TH1D *hdedxlay[2], TH1D *hentalay[2])
function to define histograms
double m_eaBW
binwdith of entrance angle bin
void plotEventStats()
function to draw the stats plots
int rotationalBin(int nbin, int ibin)
class function to set rotation symmetry
void plotQaPars(TH1D *hentalay[2], TH2D *hptcosth)
function to draw pt vs costh and entrance angle distribution for Inner/Outer layer
void createPayload()
function to generate final constants
void plotRelConst(std::vector< double >tempconst, std::vector< double >layerconst, int il)
function to draw symm/Var layer constant
std::vector< std::vector< double > > m_onedcors
final vectors of calibration
void plotLayerDist(TH1D *hdedxL[2])
function to draw dedx dist.
@ 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...

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

◆ CreateBinMapping()

void CreateBinMapping ( )

class function to create vectors for bin mapping (Var->symm)

Definition at line 255 of file CDCDedx1DCellAlgorithm.cc.

256{
257
258 std::map<int, std::vector<double>> bounds;
259 std::map<int, std::vector<int>> steps;
260
261 const std::array<int, 2> nDev{8, 4};
262 bounds[0] = {0, 108, 123, 133, 158, 183, 193, 208, 316}; //il boundaries
263 steps[0] = {9, 3, 2, 1, 1, 2, 3, 9}; //il steps
264 bounds[1] = {0, 38, 158, 278, 316}; //OL boundaries
265 steps[1] = {2, 1, 1, 2}; //OL steps
266
267 for (int il = 0; il < 2; il++) {
268
269 for (int ibin = 0; ibin <= nDev[il]; ibin++) bounds[il][ibin] = bounds[il][ibin] * m_binSplit;
270
271 int ieaprime = -1, temp = -99, ibin = 0;
272
273 double pastbin = m_eaMin;
274 m_binValue[il].push_back(pastbin);
275
276 for (int iea = 0; iea < m_eaBin; iea++) {
277
278 if (isVarBins) {
279 if (iea % int(bounds[il][ibin + 1]) == 0 && iea > 0) ibin++;
280 int diff = iea - int(bounds[il][ibin]);
281 if (diff % steps[il][ibin] == 0) ieaprime++;
282 } else ieaprime = iea;
283
284 m_binIndex[il].push_back(ieaprime);
285
286 if (ieaprime != temp) {
287 double binwidth = m_eaBW;
288 if (isVarBins) binwidth = m_eaBW * steps[il][ibin];
289 double binvalue = pastbin + binwidth;
290 pastbin = binvalue;
291 if (std::abs(binvalue) < 1e-5)binvalue = 0;
292 m_binValue[il].push_back(binvalue);
293 }
294 temp = ieaprime;
295 }
296 m_eaBinLocal.push_back(int(m_binValue[il].size()) - 1) ;
297 }
298 if (isMakePlots) plotMergeFactor(bounds, nDev, steps);
299}
void plotMergeFactor(std::map< int, std::vector< double > > bounds, const std::array< int, 2 > nDev, std::map< int, std::vector< int > > steps)
function to plot merging factor

◆ createPayload()

void createPayload ( )

function to generate final constants

Definition at line 383 of file CDCDedx1DCellAlgorithm.cc.

384{
385
386 B2INFO("dE/dx one cell calibration: Generating payloads");
387
388 for (unsigned int il = 0; il < 2; il++) {
389 if (isMerge) {
390 unsigned int nbins = m_DBOneDCell->getNBins(il);
391
392 if (int(nbins) != m_eaBin)
393 B2ERROR("merging failed because of unmatch bins (old " << m_eaBin << " new " << nbins << ")");
394
395 for (unsigned int iea = 0; iea < nbins; iea++) {
396 double prev = m_DBOneDCell->getMean(8 * il + 1, iea);
397 m_onedcors[il][iea] *= prev;
398 // m_onedcors[il][iea] /= 0.98;
399 }
400 }
401
402 if (m_chargeType > 0)
403 for (int ie = 0; ie < m_eaBin / 2; ie++) m_onedcors[il][ie] *= m_adjustFac;
404 if (m_chargeType < 0)
405 for (int ie = m_eaBin / 2; ie < m_eaBin; ie++) m_onedcors[il][ie] *= m_adjustFac;
406
407 }
408 //Saving constants
409 B2INFO("dE/dx Calibration done for CDCDedx1DCell");
410 CDCDedx1DCell* gain = new CDCDedx1DCell(0, m_onedcors);
411 saveCalibration(gain, "CDCDedx1DCell");
412}
void saveCalibration(TClonesArray *data, const std::string &name)
Store DBArray payload with given name with default IOV.

◆ defineHisto()

void defineHisto ( std::vector< TH1D * > hdedxhit[2],
TH1D * hdedxlay[2],
TH1D * hentalay[2] )

function to define histograms

Definition at line 302 of file CDCDedx1DCellAlgorithm.cc.

303{
304 for (int il = 0; il < 2; il++) {
305
306 std::string title = Form("dedxhit dist (%s): %s ; dedxhit;entries", m_label[il].data(), m_runExp.data());
307 hdedxlay[il] = new TH1D(Form("hdedxlay%s", m_label[il].data()), "", m_dedxBin, m_dedxMin, m_dedxMax);
308 hdedxlay[il]->SetTitle(Form("%s", title.data()));
309
310 Double_t* nvarBins;
311 nvarBins = &m_binValue[il][0];
312
313 if (isVarBins) title = Form("entaRS dist (variable bins): %s: (%s); entaRS (#alpha);entries", m_label[il].data(), m_runExp.data());
314 else title = Form("entaRS dist (sym. bins): %s: (%s); entaRS (#alpha);entries", m_label[il].data(), m_runExp.data());
315
316 hentalay[il] = new TH1D(Form("hentalay%s", m_label[il].data()), "", m_eaBinLocal[il], nvarBins);
317 hentalay[il]->SetTitle(Form("%s", title.data()));
318
319 for (int iea = 0; iea < m_eaBinLocal[il]; iea++) {
320
321 double min = m_binValue[il].at(iea);
322 double max = m_binValue[il].at(iea + 1);
323 double width = max - min;
324
325 if (isPrintLog) B2INFO("bin: " << iea << " ], min:" << min << " , max: " << max << " , width: " << width);
326
327 title = Form("%s: entaRS = (%0.03f to %0.03f)", m_label[il].data(), min, max);
328 hdedxhit[il].push_back(new TH1D(Form("hdedxhit_%s_bin%d", m_label[il].data(), iea), "", m_dedxBin, m_dedxMin, m_dedxMax));
329 hdedxhit[il][iea]->SetTitle(Form("%s", title.data()));
330 }
331 }
332}
std::string m_runExp
add suffix to all plot name

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

◆ enableExtraPlots()

void enableExtraPlots ( bool value = false)
inline

function to set flag active for plotting

Definition at line 84 of file CDCDedx1DCellAlgorithm.h.

84{isMakePlots = value;}

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

◆ getExpRunInfo()

void getExpRunInfo ( )

function to get extract calibration run/exp

Definition at line 230 of file CDCDedx1DCellAlgorithm.cc.

231{
232
233 int cruns = 0;
234 for (auto expRun : getRunList()) {
235 if (cruns == 0) B2INFO("CDCDedxBadWires: start exp " << expRun.first << " and run " << expRun.second << "");
236 cruns++;
237 }
238
239 const auto erStart = getRunList()[0];
240 int estart = erStart.first;
241 int rstart = erStart.second;
242
243 const auto erEnd = getRunList()[cruns - 1];
244 int eend = erEnd.first;
245 int rend = erEnd.second;
246
247 updateDBObjPtrs(1, rstart, estart);
248
249 m_runExp = Form("Range (%d:%d,%d:%d)", estart, rstart, eend, rend);
250 if (m_suffix.length() > 0) m_suffix = Form("%s_e%d_r%dr%d", m_suffix.data(), estart, rstart, rend);
251 else m_suffix = Form("e%d_r%dr%d", estart, rstart, rend);
252}
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()

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

◆ 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

◆ getTruncatedBins()

void getTruncatedBins ( TH1D * hist,
int & binlow,
int & binhigh )

function to get bins of truncation from histogram

Definition at line 335 of file CDCDedx1DCellAlgorithm.cc.

336{
337
338 //calculating truncation average
339 double sum = hist->Integral();
340 if (sum <= 0 || hist->GetNbinsX() <= 0) {
341 binlow = 1; binhigh = 1;
342 return ;
343 }
344
345 binlow = 1.0; binhigh = 1.0;
346 double sumPer5 = 0.0, sumPer75 = 0.0;
347 for (int ibin = 1; ibin <= hist->GetNbinsX(); ibin++) {
348 double bcdedx = hist->GetBinContent(ibin);
349 if (sumPer5 <= m_truncMin * sum) {
350 sumPer5 += bcdedx;
351 binlow = ibin;
352 }
353 if (sumPer75 <= m_truncMax * sum) {
354 sumPer75 += bcdedx;
355 binhigh = ibin;
356 }
357 }
358 return;
359}

◆ getTruncationMean()

double getTruncationMean ( TH1D * hist,
int binlow,
int binhigh )

function to get truncated mean

Definition at line 362 of file CDCDedx1DCellAlgorithm.cc.

363{
364
365 //calculating truncation average
366 if (hist->Integral() < 100) return 1.0;
367
368 if (binlow <= 0 || binhigh > hist->GetNbinsX())return 1.0;
369
370 double binweights = 0., sumofbc = 0.;
371 for (int ibin = binlow; ibin <= binhigh; ibin++) {
372 double bcdedx = hist->GetBinContent(ibin);
373 if (bcdedx > 0) {
374 binweights += (bcdedx * hist->GetBinCenter(ibin));
375 sumofbc += bcdedx;
376 }
377 }
378 if (sumofbc > 0) return binweights / sumofbc;
379 else return 1.0;
380}

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

◆ plotConstants()

void plotConstants ( )

function to draw the old/new final constants

Definition at line 588 of file CDCDedx1DCellAlgorithm.cc.

589{
590
591 //Draw New/Old final constants
592 TH1D* hnewconst[2], *holdconst[2];
593 double min[2], max[2];
594
595 for (unsigned int il = 0; il < 2; il++) {
596 unsigned int nbins = m_DBOneDCell->getNBins(il);
597
598 std::string title = Form("final calibration const dist (%s): %s; entaRS (#alpha); entries", m_label[il].data(), m_runExp.data());
599 hnewconst[il] = new TH1D(Form("hnewconst_%s", m_label[il].data()), "", m_eaBin, m_eaMin, m_eaMax);
600 hnewconst[il]->SetTitle(Form("%s", title.data()));
601
602 title = Form("old calibration const dist (%s): %s; entaRS (#alpha); entries", m_label[il].data(), m_runExp.data());
603 holdconst[il] = new TH1D(Form("holdconst_%s", m_label[il].data()), "", m_eaBin, m_eaMin, m_eaMax);
604 holdconst[il]->SetTitle(Form("%s", title.data()));
605
606 for (unsigned int iea = 0; iea < nbins; iea++) {
607 double prev = m_DBOneDCell->getMean(8 * il + 1, iea);
608 holdconst[il]->SetBinContent(iea + 1, prev);
609 hnewconst[il]->SetBinContent(iea + 1, m_onedcors[il][iea]);
610 }
611 min[il] = hnewconst[il]->GetMinimum();
612 max[il] = hnewconst[il]->GetMaximum();
613 }
614
615 //Plotting final constants
616 if (max[1] < max[0])max[1] = max[0];
617 if (min[1] > min[0])min[1] = min[0];
618
619 gStyle->SetOptStat("ne");
620 TCanvas cfconst("cfconst", "Final calirbation constants", 800, 400);
621 cfconst.Divide(2, 1);
622
623 for (int il = 0; il < 2; il++) {
624 cfconst.cd(il + 1);
625 hnewconst[il]->GetYaxis()->SetRangeUser(min[1] * 0.95, max[1] * 1.05);
626 hnewconst[il]->SetLineColor(kBlack);
627 hnewconst[il]->Draw("histo");
628 holdconst[il]->SetLineColor(kRed);
629 holdconst[il]->Draw("histo same");
630
631 auto legend = new TLegend(0.4, 0.75, 0.56, 0.85);
632 legend->AddEntry(holdconst[il], "Old", "lep");
633 legend->AddEntry(hnewconst[il], "New", "lep");
634 legend->Draw();
635 }
636
637 cfconst.SaveAs(Form("cdcdedx_1dcell_fconsts%s.pdf", m_suffix.data()));
638 cfconst.SaveAs(Form("cdcdedx_1dcell_fconsts%s.root", m_suffix.data()));
639
640 for (int il = 0; il < 2; il++) {
641 delete hnewconst[il];
642 delete holdconst[il];
643 }
644}

◆ plotdedxHist()

void plotdedxHist ( std::vector< TH1D * > hdedxhit[2])

function to draw the dE/dx histogram in enta bins

Definition at line 442 of file CDCDedx1DCellAlgorithm.cc.

443{
444
445 TCanvas ctmp("tmp", "tmp", 1200, 1200);
446 ctmp.Divide(4, 4);
447 std::stringstream psname;
448
449 psname << Form("cdcdedx_1dcell_dedxhit%s.pdf[", m_suffix.data());
450 ctmp.Print(psname.str().c_str());
451 psname.str("");
452 psname << Form("cdcdedx_1dcell_dedxhit%s.pdf", m_suffix.data());
453
454 for (int il = 0; il < 2; il++) {
455
456 for (int jea = 0; jea < m_eaBinLocal[il]; jea++) {
457
458 int minbin = std::stoi(hdedxhit[il][jea]->GetXaxis()->GetTitle());
459 int maxbin = std::stoi(hdedxhit[il][jea]->GetYaxis()->GetTitle());
460
461 ctmp.cd(jea % 16 + 1);
462 hdedxhit[il][jea]->SetFillColor(4 + il);
463
464 hdedxhit[il][jea]->SetTitle(Form("%s;dedxhit;entries", hdedxhit[il][jea]->GetTitle()));
465 hdedxhit[il][jea]->DrawClone("hist");
466 TH1D* htempC = (TH1D*)hdedxhit[il][jea]->Clone(Form("%sc2", hdedxhit[il][jea]->GetName()));
467 htempC->GetXaxis()->SetRange(minbin, maxbin);
468 htempC->SetFillColor(kGray);
469 htempC->DrawClone("same hist");
470
471 if (jea % 16 == 15 || (jea == m_eaBinLocal[il] - 1)) {
472 ctmp.Print(psname.str().c_str());
473 gPad->Clear("D");
474 ctmp.Clear("D");
475 }
476 delete htempC;
477 }
478 }
479 psname.str("");
480 psname << Form("cdcdedx_1dcell_dedxhit%s.pdf]", m_suffix.data());
481 ctmp.Print(psname.str().c_str());
482}

◆ plotEventStats()

void plotEventStats ( )

function to draw the stats plots

Definition at line 647 of file CDCDedx1DCellAlgorithm.cc.

648{
649
650 TCanvas cstats("cstats", "cstats", 1000, 500);
651 cstats.SetBatch(kTRUE);
652 cstats.Divide(2, 1);
653
654 cstats.cd(1);
655 auto hestats = getObjectPtr<TH1I>("hestats");
656 if (hestats) {
657 hestats->SetName(Form("hestats_%s", m_suffix.data()));
658 hestats->SetStats(0);
659 hestats->DrawCopy("");
660 }
661
662 cstats.cd(2);
663 auto htstats = getObjectPtr<TH1I>("htstats");
664 if (htstats) {
665 hestats->SetName(Form("htstats_%s", m_suffix.data()));
666 htstats->DrawCopy("");
667 hestats->SetStats(0);
668 }
669 cstats.Print(Form("cdcdedx_1dcell_stats_%s.pdf", m_suffix.data()));
670}

◆ plotLayerDist()

void plotLayerDist ( TH1D * hdedxL[2])

function to draw dedx dist.

for Inner/outer layer

Definition at line 485 of file CDCDedx1DCellAlgorithm.cc.

486{
487
488 TCanvas cdedxlayer("layerdedxhit", "Inner and Outer Layer dedxhit dist", 900, 400);
489 cdedxlayer.Divide(2, 1);
490
491 for (int il = 0; il < 2; il++) {
492 int minlay = 0, maxlay = 0;
493 if (isFixTrunc) {
494 minlay = std::stoi(hdedxlay[il]->GetXaxis()->GetTitle());
495 maxlay = std::stoi(hdedxlay[il]->GetYaxis()->GetTitle());
496 double lowedge = hdedxlay[il]->GetXaxis()->GetBinLowEdge(minlay);
497 double upedge = hdedxlay[il]->GetXaxis()->GetBinUpEdge(maxlay);
498 hdedxlay[il]->SetTitle(Form("%s, trunc #rightarrow: %0.02f - %0.02f;dedxhit;entries", hdedxlay[il]->GetTitle(), lowedge, upedge));
499 }
500
501 cdedxlayer.cd(il + 1);
502 hdedxlay[il]->SetFillColor(kYellow);
503 hdedxlay[il]->Draw("histo");
504
505 if (isFixTrunc) {
506 TH1D* hdedxlayC = (TH1D*)hdedxlay[il]->Clone(Form("hdedxlayC%d", il));
507 hdedxlayC->GetXaxis()->SetRange(minlay, maxlay);
508 hdedxlayC->SetFillColor(kAzure + 1);
509 hdedxlayC->Draw("same histo");
510 }
511 }
512
513 cdedxlayer.SaveAs(Form("cdcdedx_1dcell_dedxlay%s.pdf", m_suffix.data()));
514 cdedxlayer.SaveAs(Form("cdcdedx_1dcell_dedxlay%s.root", m_suffix.data()));
515}

◆ plotMergeFactor()

void plotMergeFactor ( std::map< int, std::vector< double > > bounds,
const std::array< int, 2 > nDev,
std::map< int, std::vector< int > > steps )

function to plot merging factor

Definition at line 415 of file CDCDedx1DCellAlgorithm.cc.

417{
418
419 TCanvas cmfactor("cmfactor", "Merging factors", 800, 400);
420 cmfactor.Divide(2, 1);
421
422 for (int il = 0; il < 2; il++) {
423 Double_t* nvarBins;
424 nvarBins = &bounds[il][0];
425
426 TH1I* hist = new TH1I(Form("hist_%s", m_label[il].data()), "", nDev[il], nvarBins);
427 hist->SetTitle(Form("Merging factor for %s bins;binindex;merge-factors", m_label[il].data()));
428
429 for (int ibin = 0; ibin < nDev[il]; ibin++) hist->SetBinContent(ibin + 1, steps[il][ibin]);
430
431 cmfactor.cd(il + 1);
432 hist->SetFillColor(kYellow);
433 hist->Draw("hist");
434 delete hist;
435 }
436
437 cmfactor.SaveAs(Form("cdcdedx_1dcell_mergefactor%s.pdf", m_suffix.data()));
438 cmfactor.SaveAs(Form("cdcdedx_1dcell_mergefactor%s.root", m_suffix.data()));
439}

◆ plotQaPars()

void plotQaPars ( TH1D * hentalay[2],
TH2D * hptcosth )

function to draw pt vs costh and entrance angle distribution for Inner/Outer layer

Definition at line 518 of file CDCDedx1DCellAlgorithm.cc.

519{
520
521 TCanvas ceadist("ceadist", "Enta distributions", 800, 400);
522 ceadist.Divide(2, 1);
523
524 for (int il = 0; il < 2; il++) {
525
526 ceadist.cd(il + 1);
527 gPad->SetLogy();
528 hentalay[il]->SetFillColor(kYellow);
529 hentalay[il]->Draw("hist");
530 }
531
532 TCanvas cptcos("cptcos", "pt vs costh dist.", 400, 400);
533 cptcos.cd();
534 hptcosth->Draw("colz");
535
536 cptcos.SaveAs(Form("cdcdedx_ptcosth_%s.pdf", m_suffix.data()));
537 ceadist.SaveAs(Form("cdcdedx_1dcell_enta%s.pdf", m_suffix.data()));
538 ceadist.SaveAs(Form("cdcdedx_1dcell_enta%s.root", m_suffix.data()));
539}

◆ plotRelConst()

void plotRelConst ( std::vector< double > tempconst,
std::vector< double > layerconst,
int il )

function to draw symm/Var layer constant

Definition at line 542 of file CDCDedx1DCellAlgorithm.cc.

543{
544
545 TH1D* hconst, *hconstvar;
546
547 Double_t* nvarBins;
548 nvarBins = &m_binValue[il][0];
549
550 hconst = new TH1D(Form("hconst%s", m_label[il].data()), "", m_eaBin, m_eaMin, m_eaMax);
551 std::string title = Form("calibration const dist: %s: (%s); entaRS (#alpha); entries", m_label[il].data(), m_runExp.data());
552 hconst->SetTitle(Form("%s", title.data()));
553
554 hconstvar = new TH1D(Form("hconstvar%s", m_label[il].data()), "", m_eaBinLocal[il], nvarBins);
555 title = Form("calibration const dist (var bins): %s: (%s); entaRS (#alpha);entries", m_label[il].data(), m_runExp.data());
556 hconstvar->SetTitle(Form("%s", title.data()));
557
558 if (isVarBins) {
559 for (int iea = 0; iea < m_eaBinLocal[il]; iea++)
560 hconstvar->SetBinContent(iea + 1, tempconst.at(iea));
561 }
562
563 for (int jea = 0; jea < m_eaBin; jea++) hconst->SetBinContent(jea + 1, layerconst.at(jea));
564
565 gStyle->SetOptStat("ne");
566 TCanvas cconst("cconst", "Calirbation Constants", 800, 400);
567 if (isVarBins) {
568 cconst.Divide(2, 1);
569 cconst.SetWindowSize(1000, 800);
570 }
571
572 cconst.cd(1);
573 hconst->SetFillColor(kYellow);
574 hconst->Draw("histo");
575 if (isVarBins) {
576 cconst.cd(2);
577 hconstvar->SetFillColor(kBlue);
578 hconstvar->Draw("hist");
579 }
580 cconst.SaveAs(Form("cdcdedx_1dcell_relconst%s_%s.pdf", m_label[il].data(), m_suffix.data()));
581 cconst.SaveAs(Form("cdcdedx_1dcell_relconst%s_%s.root", m_label[il].data(), m_suffix.data()));
582
583 delete hconst;
584 delete hconstvar;
585}

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

◆ rotationalBin()

int rotationalBin ( int nbin,
int ibin )
inline

class function to set rotation symmetry

Definition at line 114 of file CDCDedx1DCellAlgorithm.h.

115 {
116 if (nbin % 4 != 0)return ibin;
117 int jbin = ibin;
118 if (ibin < nbin / 4) jbin = ibin + nbin / 2 ;
119 else if (ibin >= 3 * nbin / 4) jbin = ibin - nbin / 2 ;
120 return jbin;
121 }

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

◆ setBaselineFactor()

void setBaselineFactor ( double charge,
double factor )
inline

adjust baseline based on charge or global overall works for only single charge or both

Definition at line 100 of file CDCDedx1DCellAlgorithm.h.

101 {
102
103 m_adjustFac = factor;
104 if (charge < 0)m_chargeType = -1.0;
105 else if (charge > 0)m_chargeType = 1.0;
106 else if (charge == 0)m_chargeType = 0.0;
107 else
108 B2FATAL("Choose charge value either +/-1 or 0");
109 }

◆ setCosLimit()

void setCosLimit ( double value)
inline

function to set cos $\theta$ limit

Definition at line 94 of file CDCDedx1DCellAlgorithm.h.

94{m_cosMax = value;}

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

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

◆ setLayerTrunc()

void setLayerTrunc ( bool value = false)
inline

function to set truncation method (local vs global)

Definition at line 55 of file CDCDedx1DCellAlgorithm.h.

55{isFixTrunc = value;}

◆ setMergePayload()

void setMergePayload ( bool value)
inline

set false if generating absolute (not relative) payload

Definition at line 61 of file CDCDedx1DCellAlgorithm.h.

61{ isMerge = 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;}

◆ setPtLimit()

void setPtLimit ( double value)
inline

function to set pt limit

Definition at line 89 of file CDCDedx1DCellAlgorithm.h.

89{m_ptMax = value;}

◆ setRotSymmetry()

void setRotSymmetry ( bool value)
inline

set rotation sys to copy constants from one region to other

Definition at line 71 of file CDCDedx1DCellAlgorithm.h.

71{isRotSymm = value;}

◆ setSplitFactor()

void setSplitFactor ( int value)
inline

set bin split factor for all range

Definition at line 66 of file CDCDedx1DCellAlgorithm.h.

66{m_binSplit = value;}

◆ setSuffix()

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

adding suffix to control plots

Definition at line 45 of file CDCDedx1DCellAlgorithm.h.

45{m_suffix = value;}

◆ setTrucationBins()

void setTrucationBins ( double lowedge,
double upedge )
inline

function to set bins of truncation from histogram

Definition at line 76 of file CDCDedx1DCellAlgorithm.h.

77 {
78 m_truncMin = lowedge; m_truncMax = upedge ;
79 }

◆ setVariableBins()

void setVariableBins ( bool value)
inline

Set Var bins flag to on or off.

Definition at line 50 of file CDCDedx1DCellAlgorithm.h.

50{isVarBins = value;}

◆ 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

Member Data Documentation

◆ isFixTrunc

bool isFixTrunc
private

true = fix window for all out/inner layers

Definition at line 219 of file CDCDedx1DCellAlgorithm.h.

◆ isMakePlots

bool isMakePlots
private

produce plots for status

Definition at line 222 of file CDCDedx1DCellAlgorithm.h.

◆ isMerge

bool isMerge
private

print more debug information

Definition at line 224 of file CDCDedx1DCellAlgorithm.h.

◆ isPrintLog

bool isPrintLog
private

print more debug information

Definition at line 223 of file CDCDedx1DCellAlgorithm.h.

◆ isRotSymm

bool isRotSymm
private

if rotation symmetry requested

Definition at line 221 of file CDCDedx1DCellAlgorithm.h.

◆ isVarBins

bool isVarBins
private

true: if variable bin size is requested

Definition at line 220 of file CDCDedx1DCellAlgorithm.h.

◆ m_adjustFac

double m_adjustFac
private

factor with that one what to adjust baseline

Definition at line 217 of file CDCDedx1DCellAlgorithm.h.

◆ m_allExpRun

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

allExpRun

Definition at line 364 of file CalibrationAlgorithm.h.

◆ m_binIndex

std::array<std::vector<int>, 2> m_binIndex
private

symm/Var bin numbers

Definition at line 231 of file CDCDedx1DCellAlgorithm.h.

◆ m_binSplit

int m_binSplit
private

multiply nbins by this factor in full range

Definition at line 214 of file CDCDedx1DCellAlgorithm.h.

◆ m_binValue

std::array<std::vector<double>, 2> m_binValue
private

enta Var bin values

Definition at line 232 of file CDCDedx1DCellAlgorithm.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_chargeType

double m_chargeType
private

charge type for baseline adj

Definition at line 216 of file CDCDedx1DCellAlgorithm.h.

◆ m_cosMax

double m_cosMax
private

a limit on cos theta

Definition at line 209 of file CDCDedx1DCellAlgorithm.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_DBOneDCell

DBObjPtr<CDCDedx1DCell> m_DBOneDCell
private

One cell correction DB object.

Definition at line 236 of file CDCDedx1DCellAlgorithm.h.

◆ m_dedxBin

int m_dedxBin
private

of bins for dedxhit range

Definition at line 206 of file CDCDedx1DCellAlgorithm.h.

◆ m_dedxMax

double m_dedxMax
private

upper edge of dedxhit

Definition at line 205 of file CDCDedx1DCellAlgorithm.h.

◆ m_dedxMin

double m_dedxMin
private

lower edge of dedxhit

Definition at line 204 of file CDCDedx1DCellAlgorithm.h.

◆ m_description

std::string m_description {""}
privateinherited

Description of the algorithm.

Definition at line 385 of file CalibrationAlgorithm.h.

385{""};

◆ m_eaB

int m_eaB
private

reset # of bins for entrance angle for each experiment

Definition at line 202 of file CDCDedx1DCellAlgorithm.h.

◆ m_eaBin

int m_eaBin
private

of bins for entrance angle

Definition at line 201 of file CDCDedx1DCellAlgorithm.h.

◆ m_eaBinLocal

std::vector<int> m_eaBinLocal
private

of var bins for enta angle

Definition at line 230 of file CDCDedx1DCellAlgorithm.h.

◆ m_eaBW

double m_eaBW
private

binwdith of entrance angle bin

Definition at line 200 of file CDCDedx1DCellAlgorithm.h.

◆ m_eaMax

double m_eaMax
private

upper edge of entrance angle

Definition at line 199 of file CDCDedx1DCellAlgorithm.h.

◆ m_eaMin

double m_eaMin
private

lower edge of entrance angle

Definition at line 198 of file CDCDedx1DCellAlgorithm.h.

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

std::string m_label[2] = {"IL", "OL"}
private

add inner/outer layer label

Definition at line 228 of file CDCDedx1DCellAlgorithm.h.

228{"IL", "OL"};

◆ m_onedcors

std::vector<std::vector<double> > m_onedcors
private

final vectors of calibration

Definition at line 234 of file CDCDedx1DCellAlgorithm.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_ptMax

double m_ptMax
private

a limit on transverse momentum

Definition at line 208 of file CDCDedx1DCellAlgorithm.h.

◆ m_runExp

std::string m_runExp
private

add suffix to all plot name

Definition at line 227 of file CDCDedx1DCellAlgorithm.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_suffix

std::string m_suffix
private

add suffix to all plot name

Definition at line 226 of file CDCDedx1DCellAlgorithm.h.

◆ m_truncMax

double m_truncMax
private

upper threshold on truncation

Definition at line 212 of file CDCDedx1DCellAlgorithm.h.

◆ m_truncMin

double m_truncMin
private

lower threshold on truncation

Definition at line 211 of file CDCDedx1DCellAlgorithm.h.


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