Belle II Software release-09-00-00
CDCDedx1DCellAlgorithm Class Reference

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

#include <CDCDedx1DCellAlgorithm.h>

Inheritance diagram for CDCDedx1DCellAlgorithm:
Collaboration diagram for CDCDedx1DCellAlgorithm:

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)
 funtion 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 algoithm (set by developers in constructor)
 
bool loadInputJson (const std::string &jsonString)
 Load the m_inputJson variable from a string (useful from Python interface). The rturn 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 interally 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 enta angle
 
double m_eaMax
 upper edge of enta angle
 
double m_eaBW
 binwdith of enta angle bin
 
int m_eaBin
 
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 39 of file CDCDedx1DCellAlgorithm.h.

Member Enumeration Documentation

◆ EResult

enum EResult
inherited

The result of calibration.

Enumerator
c_OK 

Finished successfuly =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,
44 c_Failure,
46 };
@ c_OK
Finished successfuly =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.

Constructor & Destructor Documentation

◆ CDCDedx1DCellAlgorithm()

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

Definition at line 17 of file CDCDedx1DCellAlgorithm.cc.

17 :
18 CalibrationAlgorithm("CDCDedxElectronCollector"),
19 m_eaMin(-TMath::Pi() / 2),
20 m_eaMax(+TMath::Pi() / 2),
21 m_eaBin(316),
22 m_dedxMin(0.0),
23 m_dedxMax(5.0),
24 m_dedxBin(250),
25 m_ptMax(8.0),
26 m_cosMax(1.0),
27 m_truncMin(0.05),
28 m_truncMax(0.75),
29 m_binSplit(3),
30 m_chargeType(0),
31 m_adjustFac(1.00),
32 isFixTrunc(false),
33 isVarBins(true),
34 isRotSymm(false),
35 isMakePlots(true),
36 isPrintLog(false),
37 isMerge(true),
38 m_suffix("")
39{
40 // Set module properties
41 setDescription("A calibration algorithm for the CDC dE/dx entrance angle cleanup correction");
42}
double m_eaMax
upper edge of enta 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
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 enta angle
Base class for calibration algorithms.
void setDescription(const std::string &description)
Set algorithm description (in constructor)

◆ ~CDCDedx1DCellAlgorithm()

virtual ~CDCDedx1DCellAlgorithm ( )
inlinevirtual

Destructor.

Definition at line 51 of file CDCDedx1DCellAlgorithm.h.

51{}

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 TestBoundarySettingAlgorithm, TestCalibrationAlgorithm, PXDAnalyticGainCalibrationAlgorithm, PXDValidationAlgorithm, SVD3SampleCoGTimeCalibrationAlgorithm, SVD3SampleELSTimeCalibrationAlgorithm, and SVDCoGTimeCalibrationAlgorithm.

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 47 of file CDCDedx1DCellAlgorithm.cc.

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

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

void clearCalibrationData()
Clear calibration data.
ExecutionData m_data
Data specific to a SINGLE execution of the algorithm. Gets reset at the beginning of execution.

◆ 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:42
bool storeData(const std::string &name, TObject *object, const IntervalOfValidity &iov)
Store an object in the database.
Definition: Database.cc:141

◆ 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}
Struct containing exp number and run number.
Definition: Splitter.h:51

◆ CreateBinMapping()

void CreateBinMapping ( )

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

Definition at line 242 of file CDCDedx1DCellAlgorithm.cc.

243{
244
245 std::map<int, std::vector<double>> bounds;
246 std::map<int, std::vector<int>> steps;
247
248 const std::array<int, 2> nDev{8, 4};
249 bounds[0] = {0, 108, 123, 133, 158, 183, 193, 208, 316}; //il boundries
250 steps[0] = {9, 3, 2, 1, 1, 2, 3, 9}; //il steps
251 bounds[1] = {0, 38, 158, 278, 316}; //OL boundries
252 steps[1] = {2, 1, 1, 2}; //OL steps
253
254 for (int il = 0; il < 2; il++) {
255
256 for (int ibin = 0; ibin <= nDev[il]; ibin++) bounds[il][ibin] = bounds[il][ibin] * m_binSplit;
257
258 int ieaprime = -1, temp = -99, ibin = 0;
259
260 double pastbin = m_eaMin;
261 m_binValue[il].push_back(pastbin);
262
263 for (int iea = 0; iea < m_eaBin; iea++) {
264
265 if (isVarBins) {
266 if (iea % int(bounds[il][ibin + 1]) == 0 && iea > 0) ibin++;
267 int diff = iea - int(bounds[il][ibin]);
268 if (diff % steps[il][ibin] == 0) ieaprime++;
269 } else ieaprime = iea;
270
271 m_binIndex[il].push_back(ieaprime);
272
273 if (ieaprime != temp) {
274 double binwidth = m_eaBW;
275 if (isVarBins) binwidth = m_eaBW * steps[il][ibin];
276 double binvalue = pastbin + binwidth;
277 pastbin = binvalue;
278 if (std::abs(binvalue) < 1e-5)binvalue = 0;
279 m_binValue[il].push_back(binvalue);
280 }
281 temp = ieaprime;
282 }
283 m_eaBinLocal.push_back(int(m_binValue[il].size()) - 1) ;
284 }
285 if (isMakePlots) plotMergeFactor(bounds, nDev, steps);
286}
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
std::array< std::vector< double >, 2 > m_binValue
enta Var bin values

◆ createPayload()

void createPayload ( )

function to generate final constants

Definition at line 370 of file CDCDedx1DCellAlgorithm.cc.

371{
372
373 B2INFO("dE/dx one cell calibration: Generating payloads");
374
375 for (unsigned int il = 0; il < 2; il++) {
376 if (isMerge) {
377 unsigned int nbins = m_DBOneDCell->getNBins(il);
378
379 if (int(nbins) != m_eaBin)
380 B2ERROR("merging failed because of unmatch bins (old " << m_eaBin << " new " << nbins << ")");
381
382 for (unsigned int iea = 0; iea < nbins; iea++) {
383 double prev = m_DBOneDCell->getMean(8 * il + 1, iea);
384 m_onedcors[il][iea] *= prev;
385 // m_onedcors[il][iea] /= 0.98;
386 }
387 }
388
389 if (m_chargeType > 0)
390 for (int ie = 0; ie < m_eaBin / 2; ie++) m_onedcors[il][ie] *= m_adjustFac;
391 if (m_chargeType < 0)
392 for (int ie = m_eaBin / 2; ie < m_eaBin; ie++) m_onedcors[il][ie] *= m_adjustFac;
393
394 }
395 //Saving constants
396 B2INFO("dE/dx Calibration done for CDCDedx1DCell");
397 CDCDedx1DCell* gain = new CDCDedx1DCell(0, m_onedcors);
398 saveCalibration(gain, "CDCDedx1DCell");
399}
dE/dx wire gain calibration constants
Definition: CDCDedx1DCell.h:26
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 289 of file CDCDedx1DCellAlgorithm.cc.

290{
291 for (int il = 0; il < 2; il++) {
292
293 std::string title = Form("dedxhit dist (%s): %s ; dedxhit;entries", m_label[il].data(), m_runExp.data());
294 hdedxlay[il] = new TH1D(Form("hdedxlay%s", m_label[il].data()), "", m_dedxBin, m_dedxMin, m_dedxMax);
295 hdedxlay[il]->SetTitle(Form("%s", title.data()));
296
297 Double_t* nvarBins;
298 nvarBins = &m_binValue[il][0];
299
300 if (isVarBins) title = Form("entaRS dist (variable bins): %s: (%s); entaRS (#alpha);entries", m_label[il].data(), m_runExp.data());
301 else title = Form("entaRS dist (sym. bins): %s: (%s); entaRS (#alpha);entries", m_label[il].data(), m_runExp.data());
302
303 hentalay[il] = new TH1D(Form("hentalay%s", m_label[il].data()), "", m_eaBinLocal[il], nvarBins);
304 hentalay[il]->SetTitle(Form("%s", title.data()));
305
306 for (int iea = 0; iea < m_eaBinLocal[il]; iea++) {
307
308 double min = m_binValue[il].at(iea);
309 double max = m_binValue[il].at(iea + 1);
310 double width = max - min;
311
312 if (isPrintLog) B2INFO("bin: " << iea << " ], min:" << min << " , max: " << max << " , width: " << width);
313
314 title = Form("%s: entaRS = (%0.03f to %0.03f)", m_label[il].data(), min, max);
315 hdedxhit[il].push_back(new TH1D(Form("hdedxhit_%s_bin%d", m_label[il].data(), iea), "", m_dedxBin, m_dedxMin, m_dedxMax));
316 hdedxhit[il][iea]->SetTitle(Form("%s", title.data()));
317 }
318 }
319}
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();}
nlohmann::json m_jsonExecutionOutput
Optional output JSON object that can be set during the execution by the underlying algorithm code.

◆ enableExtraPlots()

void enableExtraPlots ( bool  value = false)
inline

funtion to set flag active for plotting

Definition at line 95 of file CDCDedx1DCellAlgorithm.h.

95{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++");
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).");
109 return c_Failure;
110 }
111 return execute(vecRuns, iteration, iov);
112}
void setResult(EResult result)
Setter for current iteration.
void setIteration(int iteration)
Setter for current iteration.
void reset()
Resets this class back to what is needed at the beginning of an execution.
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.

◆ 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()");
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.");
145 return c_Failure;
146 }
147 for (auto expRun : runs) {
148 B2DEBUG(29, "ExpRun requested = (" << expRun.first << ", " << expRun.second << ")");
149 }
150 }
151
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 }
158 // After here, the getObject<...>(...) helpers start to work
159
161 m_data.setResult(result);
162 return result;
163}
void setRequestedIov(const IntervalOfValidity &iov=IntervalOfValidity(0, 0, -1, -1))
Sets the requested IoV for this execution, based on the.
void setRequestedRuns(const std::vector< Calibration::ExpRun > &requestedRuns)
Sets the vector of ExpRuns.
EResult getResult() const
Getter for current result.
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.
virtual EResult calibrate()=0
Run algo on data - pure virtual: needs to be implemented.
std::string getGranularity() const
Get the granularity of collected data.
A class that describes the interval of experiments/runs for which an object in the database is valid.

◆ 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...
Mergeable object holding (unique) set of (exp,run) pairs.
Definition: RunRange.h:25
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
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;}
static const Calibration::ExpRun m_allExpRun
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 algorihtm.

Definition at line 164 of file CalibrationAlgorithm.h.

164{return getPrefix();}

◆ getDescription()

const std::string & getDescription ( ) const
inlineinherited

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

Definition at line 216 of file CalibrationAlgorithm.h.

216{return m_description;}
std::string m_description
Description of the algorithm.

◆ getExpRunInfo()

void getExpRunInfo ( )

function to get extract calibration run/exp

Definition at line 217 of file CDCDedx1DCellAlgorithm.cc.

218{
219
220 int cruns = 0;
221 for (auto expRun : getRunList()) {
222 if (cruns == 0) B2INFO("CDCDedxBadWires: start exp " << expRun.first << " and run " << expRun.second << "");
223 cruns++;
224 }
225
226 const auto erStart = getRunList()[0];
227 int estart = erStart.first;
228 int rstart = erStart.second;
229
230 const auto erEnd = getRunList()[cruns - 1];
231 int eend = erEnd.first;
232 int rend = erEnd.second;
233
234 updateDBObjPtrs(1, rstart, estart);
235
236 m_runExp = Form("Range (%d:%d,%d:%d)", estart, rstart, eend, rend);
237 if (m_suffix.length() > 0) m_suffix = Form("%s_e%d_r%dr%d", m_suffix.data(), estart, rstart, rend);
238 else m_suffix = Form("e%d_r%dr%d", estart, rstart, rend);
239}
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;};
std::string m_granularityOfData
Granularity of input data. This only changes when the input files change so it isn't specific to an e...

◆ 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;}
nlohmann::json m_jsonExecutionInput
Optional input JSON object used to make decisions about how to execute the algorithm code.

◆ getInputJsonValue()

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(); }
int getIteration() const
Getter for current iteration.

◆ getObjectPtr()

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)
289 return getObjectPtr<T>(name, m_data.getRequestedRuns());
290 }
const std::vector< Calibration::ExpRun > & getRequestedRuns() const
Returns the vector of ExpRuns.
void fillRunToInputFilesMap()
Fill the mapping of ExpRun -> Files.

◆ getOutputJsonValue()

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();}
std::list< Database::DBImportQuery > & getPayloads()
Get constants (in TObjects) for database update from last calibration.

◆ 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();}
std::list< Database::DBImportQuery > getPayloadValues()
Get constants (in TObjects) for database update from last calibration but passed by VALUE.

◆ 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;}
std::string m_prefix
The name of the TDirectory the collector objects are contained within.

◆ 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 322 of file CDCDedx1DCellAlgorithm.cc.

323{
324
325 //calculating truncation average
326 double sum = hist->Integral();
327 if (sum <= 0 || hist->GetNbinsX() <= 0) {
328 binlow = 1; binhigh = 1;
329 return ;
330 }
331
332 binlow = 1.0; binhigh = 1.0;
333 double sumPer5 = 0.0, sumPer75 = 0.0;
334 for (int ibin = 1; ibin <= hist->GetNbinsX(); ibin++) {
335 double bcdedx = hist->GetBinContent(ibin);
336 if (sumPer5 <= m_truncMin * sum) {
337 sumPer5 += bcdedx;
338 binlow = ibin;
339 }
340 if (sumPer75 <= m_truncMax * sum) {
341 sumPer75 += bcdedx;
342 binhigh = ibin;
343 }
344 }
345 return;
346}

◆ getTruncationMean()

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

function to get truncated mean

Definition at line 349 of file CDCDedx1DCellAlgorithm.cc.

350{
351
352 //calculating truncation average
353 if (hist->Integral() < 100) return 1.0;
354
355 if (binlow <= 0 || binhigh > hist->GetNbinsX())return 1.0;
356
357 double binweights = 0., sumofbc = 0.;
358 for (int ibin = binlow; ibin <= binhigh; ibin++) {
359 double bcdedx = hist->GetBinContent(ibin);
360 if (bcdedx > 0) {
361 binweights += (bcdedx * hist->GetBinCenter(ibin));
362 sumofbc += bcdedx;
363 }
364 }
365 if (sumofbc > 0) return binweights / sumofbc;
366 else return 1.0;
367}

◆ 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 TestBoundarySettingAlgorithm, PXDAnalyticGainCalibrationAlgorithm, PXDValidationAlgorithm, TestCalibrationAlgorithm, SVD3SampleCoGTimeCalibrationAlgorithm, SVD3SampleELSTimeCalibrationAlgorithm, and SVDCoGTimeCalibrationAlgorithm.

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

◆ plotConstants()

void plotConstants ( )

function to draw the old/new final constants

Definition at line 575 of file CDCDedx1DCellAlgorithm.cc.

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

◆ plotdedxHist()

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

function to draw the dE/dx histogram in enta bins

Definition at line 429 of file CDCDedx1DCellAlgorithm.cc.

430{
431
432 TCanvas ctmp("tmp", "tmp", 1200, 1200);
433 ctmp.Divide(4, 4);
434 std::stringstream psname;
435
436 psname << Form("cdcdedx_1dcell_dedxhit%s.pdf[", m_suffix.data());
437 ctmp.Print(psname.str().c_str());
438 psname.str("");
439 psname << Form("cdcdedx_1dcell_dedxhit%s.pdf", m_suffix.data());
440
441 for (int il = 0; il < 2; il++) {
442
443 for (int jea = 0; jea < m_eaBinLocal[il]; jea++) {
444
445 int minbin = std::stoi(hdedxhit[il][jea]->GetXaxis()->GetTitle());
446 int maxbin = std::stoi(hdedxhit[il][jea]->GetYaxis()->GetTitle());
447
448 ctmp.cd(jea % 16 + 1);
449 hdedxhit[il][jea]->SetFillColor(4 + il);
450
451 hdedxhit[il][jea]->SetTitle(Form("%s;dedxhit;entries", hdedxhit[il][jea]->GetTitle()));
452 hdedxhit[il][jea]->DrawClone("hist");
453 TH1D* htempC = (TH1D*)hdedxhit[il][jea]->Clone(Form("%sc2", hdedxhit[il][jea]->GetName()));
454 htempC->GetXaxis()->SetRange(minbin, maxbin);
455 htempC->SetFillColor(kGray);
456 htempC->DrawClone("same hist");
457
458 if (jea % 16 == 15 || (jea == m_eaBinLocal[il] - 1)) {
459 ctmp.Print(psname.str().c_str());
460 gPad->Clear("D");
461 ctmp.Clear("D");
462 }
463 delete htempC;
464 }
465 }
466 psname.str("");
467 psname << Form("cdcdedx_1dcell_dedxhit%s.pdf]", m_suffix.data());
468 ctmp.Print(psname.str().c_str());
469}

◆ plotEventStats()

void plotEventStats ( )

function to draw the stats plots

Definition at line 634 of file CDCDedx1DCellAlgorithm.cc.

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

◆ plotLayerDist()

void plotLayerDist ( TH1D *  hdedxL[2])

function to draw dedx dist.

for Inner/outer layer

Definition at line 472 of file CDCDedx1DCellAlgorithm.cc.

473{
474
475 TCanvas cdedxlayer("layerdedxhit", "Inner and Outer Layer dedxhit dist", 900, 400);
476 cdedxlayer.Divide(2, 1);
477
478 for (int il = 0; il < 2; il++) {
479 int minlay = 0, maxlay = 0;
480 if (isFixTrunc) {
481 minlay = std::stoi(hdedxlay[il]->GetXaxis()->GetTitle());
482 maxlay = std::stoi(hdedxlay[il]->GetYaxis()->GetTitle());
483 double lowedge = hdedxlay[il]->GetXaxis()->GetBinLowEdge(minlay);
484 double upedge = hdedxlay[il]->GetXaxis()->GetBinUpEdge(maxlay);
485 hdedxlay[il]->SetTitle(Form("%s, trunc #rightarrow: %0.02f - %0.02f;dedxhit;entries", hdedxlay[il]->GetTitle(), lowedge, upedge));
486 }
487
488 cdedxlayer.cd(il + 1);
489 hdedxlay[il]->SetFillColor(kYellow);
490 hdedxlay[il]->Draw("histo");
491
492 if (isFixTrunc) {
493 TH1D* hdedxlayC = (TH1D*)hdedxlay[il]->Clone(Form("hdedxlayC%d", il));
494 hdedxlayC->GetXaxis()->SetRange(minlay, maxlay);
495 hdedxlayC->SetFillColor(kAzure + 1);
496 hdedxlayC->Draw("same histo");
497 }
498 }
499
500 cdedxlayer.SaveAs(Form("cdcdedx_1dcell_dedxlay%s.pdf", m_suffix.data()));
501 cdedxlayer.SaveAs(Form("cdcdedx_1dcell_dedxlay%s.root", m_suffix.data()));
502}

◆ 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 402 of file CDCDedx1DCellAlgorithm.cc.

404{
405
406 TCanvas cmfactor("cmfactor", "Merging factors", 800, 400);
407 cmfactor.Divide(2, 1);
408
409 for (int il = 0; il < 2; il++) {
410 Double_t* nvarBins;
411 nvarBins = &bounds[il][0];
412
413 TH1I* hist = new TH1I(Form("hist_%s", m_label[il].data()), "", nDev[il], nvarBins);
414 hist->SetTitle(Form("Merging factor for %s bins;binindex;merge-factors", m_label[il].data()));
415
416 for (int ibin = 0; ibin < nDev[il]; ibin++) hist->SetBinContent(ibin + 1, steps[il][ibin]);
417
418 cmfactor.cd(il + 1);
419 hist->SetFillColor(kYellow);
420 hist->Draw("hist");
421 delete hist;
422 }
423
424 cmfactor.SaveAs(Form("cdcdedx_1dcell_mergefactor%s.pdf", m_suffix.data()));
425 cmfactor.SaveAs(Form("cdcdedx_1dcell_mergefactor%s.root", m_suffix.data()));
426}

◆ 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 505 of file CDCDedx1DCellAlgorithm.cc.

506{
507
508 TCanvas ceadist("ceadist", "Enta distributions", 800, 400);
509 ceadist.Divide(2, 1);
510
511 for (int il = 0; il < 2; il++) {
512
513 ceadist.cd(il + 1);
514 gPad->SetLogy();
515 hentalay[il]->SetFillColor(kYellow);
516 hentalay[il]->Draw("hist");
517 }
518
519 TCanvas cptcos("cptcos", "pt vs costh dist.", 400, 400);
520 cptcos.cd();
521 hptcosth->Draw("colz");
522
523 cptcos.SaveAs(Form("cdcdedx_ptcosth_%s.pdf", m_suffix.data()));
524 ceadist.SaveAs(Form("cdcdedx_1dcell_enta%s.pdf", m_suffix.data()));
525 ceadist.SaveAs(Form("cdcdedx_1dcell_enta%s.root", m_suffix.data()));
526}

◆ plotRelConst()

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

function to draw symm/Var layer constant

Definition at line 529 of file CDCDedx1DCellAlgorithm.cc.

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

◆ 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 125 of file CDCDedx1DCellAlgorithm.h.

126 {
127 if (nbin % 4 != 0)return ibin;
128 int jbin = ibin;
129 if (ibin < nbin / 4) jbin = ibin + nbin / 2 ;
130 else if (ibin >= 3 * nbin / 4) jbin = ibin - nbin / 2 ;
131 return jbin;
132 }

◆ 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{
300}
const IntervalOfValidity & getRequestedIov() const
Getter for requested 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:151

◆ 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{
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 111 of file CDCDedx1DCellAlgorithm.h.

112 {
113
114 m_adjustFac = factor;
115 if (charge < 0)m_chargeType = -1.0;
116 else if (charge > 0)m_chargeType = 1.0;
117 else if (charge == 0)m_chargeType = 0.0;
118 else
119 B2FATAL("Choose charge value either +/-1 or 0");
120 }

◆ setCosLimit()

void setCosLimit ( double  value)
inline

function to set cos $\theta$ limit

Definition at line 105 of file CDCDedx1DCellAlgorithm.h.

105{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 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 66 of file CDCDedx1DCellAlgorithm.h.

66{isFixTrunc = value;}

◆ setMergePayload()

void setMergePayload ( bool  value)
inline

set false if generating absolute (not relative) payload

Definition at line 72 of file CDCDedx1DCellAlgorithm.h.

72{ isMerge = value;}

◆ setOutputJsonValue()

void setOutputJsonValue ( const std::string &  key,
const T &  value 
)
inlineprotectedinherited

Set a key:value pair for the outputJson object, expected to used interally 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 100 of file CDCDedx1DCellAlgorithm.h.

100{m_ptMax = value;}

◆ setRotSymmetry()

void setRotSymmetry ( bool  value)
inline

set rotation sys to copy constants from one region to other

Definition at line 82 of file CDCDedx1DCellAlgorithm.h.

82{isRotSymm = value;}

◆ setSplitFactor()

void setSplitFactor ( int  value)
inline

set bin split factor for all range

Definition at line 77 of file CDCDedx1DCellAlgorithm.h.

77{m_binSplit = value;}

◆ setSuffix()

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

adding suffix to control plots

Definition at line 56 of file CDCDedx1DCellAlgorithm.h.

56{m_suffix = value;}

◆ setTrucationBins()

void setTrucationBins ( double  lowedge,
double  upedge 
)
inline

function to set bins of truncation from histogram

Definition at line 87 of file CDCDedx1DCellAlgorithm.h.

88 {
89 m_truncMin = lowedge; m_truncMax = upedge ;
90 }

◆ setVariableBins()

void setVariableBins ( bool  value)
inline

Set Var bins flag to on or off.

Definition at line 61 of file CDCDedx1DCellAlgorithm.h.

61{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 unnessary...)
412}
Store event, run, and experiment numbers.
Definition: EventMetaData.h:33
static DBStore & Instance()
Instance of a singleton DBStore.
Definition: DBStore.cc:28
void updateEvent()
Updates all intra-run dependent objects.
Definition: DBStore.cc:142
void update()
Updates all objects that are outside their interval of validity.
Definition: DBStore.cc:79

Member Data Documentation

◆ isFixTrunc

bool isFixTrunc
private

true = fix window for all out/inner layers

Definition at line 229 of file CDCDedx1DCellAlgorithm.h.

◆ isMakePlots

bool isMakePlots
private

produce plots for status

Definition at line 232 of file CDCDedx1DCellAlgorithm.h.

◆ isMerge

bool isMerge
private

print more debug information

Definition at line 234 of file CDCDedx1DCellAlgorithm.h.

◆ isPrintLog

bool isPrintLog
private

print more debug information

Definition at line 233 of file CDCDedx1DCellAlgorithm.h.

◆ isRotSymm

bool isRotSymm
private

if rotation symmetry requested

Definition at line 231 of file CDCDedx1DCellAlgorithm.h.

◆ isVarBins

bool isVarBins
private

true: if variable bin size is requested

Definition at line 230 of file CDCDedx1DCellAlgorithm.h.

◆ m_adjustFac

double m_adjustFac
private

factor with that one what to adjust baseline

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

◆ m_binSplit

int m_binSplit
private

multiply nbins by this factor in full range

Definition at line 224 of file CDCDedx1DCellAlgorithm.h.

◆ m_binValue

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

enta Var bin values

Definition at line 242 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 226 of file CDCDedx1DCellAlgorithm.h.

◆ m_cosMax

double m_cosMax
private

a limit on cos theta

Definition at line 219 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 246 of file CDCDedx1DCellAlgorithm.h.

◆ m_dedxBin

int m_dedxBin
private

of bins for dedxhit range

Definition at line 216 of file CDCDedx1DCellAlgorithm.h.

◆ m_dedxMax

double m_dedxMax
private

upper edge of dedxhit

Definition at line 215 of file CDCDedx1DCellAlgorithm.h.

◆ m_dedxMin

double m_dedxMin
private

lower edge of dedxhit

Definition at line 214 of file CDCDedx1DCellAlgorithm.h.

◆ m_description

std::string m_description {""}
privateinherited

Description of the algorithm.

Definition at line 385 of file CalibrationAlgorithm.h.

◆ m_eaBin

int m_eaBin
private

of bins for enta angle

Definition at line 212 of file CDCDedx1DCellAlgorithm.h.

◆ m_eaBinLocal

std::vector<int> m_eaBinLocal
private

of var bins for enta angle

Definition at line 240 of file CDCDedx1DCellAlgorithm.h.

◆ m_eaBW

double m_eaBW
private

binwdith of enta angle bin

Definition at line 211 of file CDCDedx1DCellAlgorithm.h.

◆ m_eaMax

double m_eaMax
private

upper edge of enta angle

Definition at line 210 of file CDCDedx1DCellAlgorithm.h.

◆ m_eaMin

double m_eaMin
private

lower edge of enta angle

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

◆ m_onedcors

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

final vectors of calibration

Definition at line 244 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.

◆ m_ptMax

double m_ptMax
private

a limit on transverse momentum

Definition at line 218 of file CDCDedx1DCellAlgorithm.h.

◆ m_runExp

std::string m_runExp
private

add suffix to all plot name

Definition at line 237 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 236 of file CDCDedx1DCellAlgorithm.h.

◆ m_truncMax

double m_truncMax
private

upper threshold on truncation

Definition at line 222 of file CDCDedx1DCellAlgorithm.h.

◆ m_truncMin

double m_truncMin
private

lower threshold on truncation

Definition at line 221 of file CDCDedx1DCellAlgorithm.h.


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