CDCDedxInjectTimeAlgorithm Class Reference

A calibration algorithm for CDC dE/dx injection time (HER/LER) More...

#include <CDCDedxInjectTimeAlgorithm.h>

Inheritance diagram for CDCDedxInjectTimeAlgorithm:

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

Public Member Functions
	CDCDedxInjectTimeAlgorithm ()
	Constructor: Sets the description, the properties and the parameters of the algorithm.
virtual	~CDCDedxInjectTimeAlgorithm () override
	Destructor.
void	setMergePayload (bool value=true)
	function to decide merged vs relative calibration
void	setMonitoringPlots (bool value=false)
	function to enable monitoring plots
void	setFitWidth (double value)
	function to set fit range (sigma)
void	setMinTracks (int value)
	function to set min # of tracks in time bins (0-40ms)
void	setDedxPars (int value, double min, double max)
	function to set dedx hist parameters
void	setChiPars (int value, double min, double max)
	function to set chi hist parameters
void	fitGaussianWRange (TH1D *&temphist, fstatus &status)
	function to perform gauss fit for input histogram
void	getExpRunInfo ()
	function to get exp/run information (payload object, plotting)
void	defineTimeBins ()
	function to set/reset time bins
void	defineHisto (std::array< std::vector< TH1D * >, 2 > &htemp, const std::string &var)
	function to define histograms for dedx and time dist.
void	defineTimeHisto (std::array< std::array< TH1D *, 3 >, numdedx::nrings > &htemp)
	function to define injection time bins histograms (monitoring only)
void	checkStatistics (std::array< std::vector< TH1D * >, numdedx::nrings > &hvar)
	check statistics for obtaining calibration const.
void	correctBinBias (std::map< int, std::vector< double > > &varcorr, const std::map< int, std::vector< double > > &var, const std::map< int, std::vector< double > > &time, TH1D *&htimes)
	function to correct dedx mean/reso and return corrected vector map
void	createPayload (std::array< double, numdedx::nrings > &scale, const std::map< int, std::vector< double > > &vmeans, std::map< int, std::vector< double > > &varscal, const std::string &svar)
	function to store payloads after full calibration
void	getMeanReso (std::array< std::vector< TH1D * >, numdedx::nrings > &hvar, std::map< int, std::vector< double > > &vmeans, std::map< int, std::vector< double > > &vresos)
	function to get mean and reso of histogram
void	plotEventStats ()
	function to draw event/track statistics plots
void	plotBinLevelDist (std::array< std::vector< TH1D * >, 2 > &hvar, const std::string &var)
	function to draw dedx, chi and time dist.
void	plotRelConstants (std::map< int, std::vector< double > > &vmeans, std::map< int, std::vector< double > > &vresos, std::map< int, std::vector< double > > &corr, const std::string &svar)
	function to relative constant from dedx fit mean and chi fit reso
void	plotTimeStat (std::array< std::vector< TH1D * >, numdedx::nrings > &htime)
	function to draw time stats
void	plotFinalConstants (std::map< int, std::vector< double > > &vmeans, std::map< int, std::vector< double > > &vresos, std::array< double, numdedx::nrings > &scale, std::array< double, numdedx::nrings > &scale_reso)
	function to final constant from merging or abs fits
void	plotInjectionTime (std::array< std::array< TH1D *, 3 >, numdedx::nrings > &hvar)
	function to injection time distributions (HER/LER in three bins)
std::string	getTimeBinLabel (const double &tedges, const int &it)
	function to return time label for histograms labeling
void	deleteHisto (const std::array< std::vector< TH1D * >, numdedx::nrings > &htemp)
	function to delete histograms for dedx and time dist.
double	getCorrection (unsigned int ring, unsigned int time, const std::map< int, std::vector< double > > &vmeans)
	function to get the correction factor of mean
const std::string &	getPrefix () const
	Get the prefix used for getting calibration data.
const std::string &	getCollectorName () const
	Alias for prefix.
void	setPrefix (const std::string &prefix)
	Set the prefix used to identify datastore objects.
void	setInputFileNames (PyObject *inputFileNames)
	Set the input file names used for this algorithm from a Python list.
PyObject *	getInputFileNames ()
	Get the input file names used for this algorithm and pass them out as a Python list of unicode strings.
std::vector< Calibration::ExpRun >	getRunListFromAllData () const
	Get the complete list of runs from inspection of collected data.
RunRange	getRunRangeFromAllData () const
	Get the complete RunRange from inspection of collected data.
IntervalOfValidity	getIovFromAllData () const
	Get the complete IoV from inspection of collected data.
void	fillRunToInputFilesMap ()
	Fill the mapping of ExpRun -> Files.
const std::string &	getGranularity () const
	Get the granularity of collected data.
EResult	execute (std::vector< Calibration::ExpRun > runs={}, int iteration=0, IntervalOfValidity iov=IntervalOfValidity())
	Runs calibration over vector of runs for a given iteration.
EResult	execute (PyObject *runs, int iteration=0, IntervalOfValidity iov=IntervalOfValidity())
	Runs calibration over Python list of runs. Converts to C++ and then calls the other execute() function.
std::list< Database::DBImportQuery > &	getPayloads ()
	Get constants (in TObjects) for database update from last execution.
std::list< Database::DBImportQuery >	getPayloadValues () const
	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>.

Static Public Member Functions
static void	setHistStyle (TH1D *&htemp, const int ic, const int is, const double min, const double max)
	function to set histogram cosmetics
static void	deleteTimeHisto (const std::array< std::array< TH1D *, 3 >, numdedx::nrings > &htemp)
	function to define injection time bins histograms (monitoring only)
static bool	checkPyExpRun (PyObject *pyObj)
	Checks that a PyObject can be successfully converted to an ExpRun type.
static Calibration::ExpRun	convertPyExpRun (PyObject *pyObj)
	Performs the conversion of PyObject to ExpRun.

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

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

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

Private Member Functions
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
std::array< std::string, numdedx::nrings >	m_sring {"ler", "her"}
	injection ring name
std::vector< double >	m_vtedges
	external time vector
std::vector< double >	m_vtlocaledges
	internal time vector
double *	m_tedges = nullptr
	internal time array (copy of vtlocaledges)
unsigned int	m_tbins = 0
	internal time bins
double	m_sigmaR
	fit dedx dist in sigma range
int	m_dedxBins
	bins for dedx histogram
double	m_dedxMin
	min range of dedx
double	m_dedxMax
	max range of dedx
int	m_chiBins
	bins for chi histogram
double	m_chiMin
	min range of chi
double	m_chiMax
	max range of chi
int	m_countR
	a hack for running functions once
int	m_thersE
	min tracks to start calibration
bool	m_isminStat
	flag to merge runs for statistics thershold
bool	m_ismakePlots
	produce plots for monitoring
bool	m_isMerge
	merge payload when rel constant
std::string	m_prefix
	string prefix for plot names
std::string	m_suffix
	string suffix for object names
std::vector< std::vector< double > >	m_vinjPayload
	vector to store payload values
DBObjPtr< CDCDedxInjectionTime >	m_DBInjectTime
	Injection time 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.
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 int	c_rings = numdedx::nrings
	injection ring constants
static const Calibration::ExpRun	m_allExpRun = make_pair(-1, -1)
	allExpRun

Detailed Description

A calibration algorithm for CDC dE/dx injection time (HER/LER)

Definition at line 36 of file CDCDedxInjectTimeAlgorithm.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.

                 {
      c_OK,           
      c_Iterate,      
      c_NotEnoughData,
      c_Failure,      
      c_Undefined     
    };

Constructor & Destructor Documentation

CDCDedxInjectTimeAlgorithm()

CDCDedxInjectTimeAlgorithm

(

)

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

Definition at line 25 of file CDCDedxInjectTimeAlgorithm.cc.

                                                       :
  CalibrationAlgorithm("CDCDedxElectronCollector"),
  m_sigmaR(2.0),
  m_dedxBins(250),
  m_dedxMin(0.0),
  m_dedxMax(2.5),
  m_chiBins(250),
  m_chiMin(-10.0),
  m_chiMax(10.0),
  m_countR(0),
  m_thersE(1000),
  m_isminStat(false),
  m_ismakePlots(true),
  m_isMerge(true),
  m_prefix("cdcdedx_injcal"),
  m_suffix("")
{
  // Set module properties
  setDescription("A calibration algorithm for CDC dE/dx injection time gain and reso");
}

~CDCDedxInjectTimeAlgorithm()

virtual ~CDCDedxInjectTimeAlgorithm ( )

inlineoverridevirtual

Destructor.

Definition at line 48 of file CDCDedxInjectTimeAlgorithm.h.

{}

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, SVDClusterAbsoluteTimeShifterAlgorithm, SVDCoGTimeCalibrationAlgorithm, TestBoundarySettingAlgorithm, and TestCalibrationAlgorithm.

Definition at line 252 of file CalibrationAlgorithm.h.

{};

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.

{};

calibrate()

CalibrationAlgorithm::EResult calibrate ( )

overrideprotectedvirtual

CDC dE/dx Injection time algorithm.

Implements CalibrationAlgorithm.

Definition at line 49 of file CDCDedxInjectTimeAlgorithm.cc.

{
 
  getExpRunInfo();
 
  //existing inject time payload for merging
  if (!m_DBInjectTime.isValid())
    B2FATAL("There is no valid payload for Injection time");
 
  // Get data objects
  auto ttree = getObjectPtr<TTree>("tree");
  if (!ttree) return c_NotEnoughData;
 
  double dedx = 0.0, injtime = 0.0, injring = 1.0, costh, mom;
  int nhits;
  ttree->SetBranchAddress("dedx", &dedx);
  ttree->SetBranchAddress("injtime", &injtime);
  ttree->SetBranchAddress("injring", &injring);
  ttree->SetBranchAddress("costh", &costh);
  ttree->SetBranchAddress("p", &mom);
  ttree->SetBranchAddress("nhits", &nhits);
 
  //way to define time bins/edges only once
  if (m_countR == 0) {
    defineTimeBins(); //returns m_vtlocaledges
    m_tbins = m_vtlocaledges.size() - 1;
    m_tedges = &m_vtlocaledges[0];
    m_countR++;
  }
 
  TH1D* htimes = new TH1D(Form("htimes_%s", m_suffix.data()), "", m_tbins, m_tedges);
 
  //time bins are changeable from out so vector is used
  std::array<std::vector<TH1D*>, numdedx::nrings> hdedx, htime, hchi, hdedx_corr;
  defineHisto(hdedx, "dedx");
  defineHisto(hdedx_corr, "dedx_corr");
  defineHisto(htime, "timeinj");
  defineHisto(hchi, "chi");
 
  const double tzedges[4] = {0, 2.0e3, 0.1e6, 20e6};
  std::array<std::array<TH1D*, 3>, numdedx::nrings> hztime;
  defineTimeHisto(hztime);
 
  //fill histograms
  for (int i = 0; i < ttree->GetEntries(); ++i) {
 
    ttree->GetEvent(i);
    if (dedx <= 0 || injtime < 0 || injring < 0) continue;
 
    //add larger times to the last bin
    if (injtime > m_tedges[m_tbins]) injtime = m_tedges[m_tbins] - 10.0;
 
    //injection ring
    int wr = 0;
    if (injring > 0.5) wr = 1;
 
    //injection time bin
    unsigned int tb = htimes->GetXaxis()->FindBin(injtime);
    if (tb > m_tbins)tb = m_tbins; //overflow
    tb = tb - 1;
 
    htimes->Fill(injtime);
    if (injtime < tzedges[1]) hztime[wr][0]->Fill(injtime);
    else if (injtime < tzedges[2]) hztime[wr][1]->Fill(injtime);
    else hztime[wr][2]->Fill(injtime);
 
    hdedx[wr][tb]->Fill(dedx);
    htime[wr][tb]->Fill(injtime);
  }
 
  //keep merging runs to achieve enough stats
  m_isminStat = false;
  checkStatistics(hdedx);
  if (m_isminStat) {
    deleteHisto(htime);
    deleteHisto(hdedx);
    deleteHisto(hdedx_corr);
    deleteHisto(hchi);
    deleteTimeHisto(hztime);
    delete htimes;
    return c_NotEnoughData;
  }
 
  //clear vector of existing constants
  std::map<int, std::vector<double>> vmeans, vresos, vtimes;
 
  // get time vector
  for (unsigned int ir = 0; ir < c_rings; ir++) {
    for (unsigned int it = 0; it < m_tbins; it++) {
      double avgtime = htime[ir][it]->GetMean();
      double avgtimeerr = htime[ir][it]->GetMeanError();
      vtimes[ir * 2].push_back(avgtime);
      vtimes[ir * 2 + 1].push_back(avgtimeerr);
    }
  }
 
  //Fit dedx to get mean and resolution
  getMeanReso(hdedx, vmeans, vresos);
 
  //Bin-bias correction to mean
  std::map<int, std::vector<double>> vmeanscorr;
  correctBinBias(vmeanscorr, vmeans, vtimes, htimes);
 
  //scale the mean and merge with old constants
  std::array<double, numdedx::nrings> scale;
  std::map<int, std::vector<double>> vmeanscal;
  createPayload(scale, vmeanscorr, vmeanscal, "mean");
 
  //................................................
  // Do the calibration for resolution
  //................................................
  CDCDedxMeanPred mbg;
  CDCDedxSigmaPred sbg;
  mbg.setParameters();
  sbg.setParameters();
 
  //fill histograms for the resolution
  for (int i = 0; i < ttree->GetEntries(); ++i) {
 
    ttree->GetEvent(i);
    if (dedx <= 0 || injtime < 0 || injring < 0) continue;
 
    double corrcetion = getCorrection(injring, injtime, vmeanscal);
    double old_cor = m_DBInjectTime->getCorrection("mean", injring, injtime);
 
    dedx = (dedx * old_cor) / corrcetion;
    //add larger times to the last bin
    if (injtime > m_tedges[m_tbins]) injtime = m_tedges[m_tbins] - 10.0;
 
    //injection ring
    int wr = 0;
    if (injring > 0.5) wr = 1;
 
    //injection time bin
    unsigned int tb = htimes->GetXaxis()->FindBin(injtime);
    if (tb > m_tbins)tb = m_tbins; //overflow
    tb = tb - 1;
 
    double predmean = mbg.getMean(mom / Const::electron.getMass());
    double predsigma = sbg.nhitPrediction(nhits) * sbg.ionzPrediction(dedx) * sbg.cosPrediction(costh);
 
    double chi = (dedx - predmean) / predsigma;
    hdedx_corr[wr][tb]->Fill(dedx);
    hchi[wr][tb]->Fill(chi);
  }
 
  // fit chi to get mean and resolution
  std::map<int, std::vector<double>> vmeans_chi, vresos_chi;
  getMeanReso(hchi, vmeans_chi, vresos_chi);
 
  //bin-bias correction to the resolution
  std::map<int, std::vector<double>> vresoscorr;
  correctBinBias(vresoscorr, vresos_chi, vtimes, htimes);
 
  // scale the resolution
  std::map<int, std::vector<double>> vresoscal;
  std::array<double, numdedx::nrings> scale_reso;
  createPayload(scale_reso, vresoscorr, vresoscal, "reso");
 
  //Fit the corrected mean to check for consistency
  std::map<int, std::vector<double>> vmeans_corr, vresos_corr;
  getMeanReso(hdedx_corr, vmeans_corr, vresos_corr);
 
  //................................................
  //preparing final payload
  //................................................
  m_vinjPayload.clear();
  m_vinjPayload.reserve(6);
  for (int ir = 0; ir < 2; ir++) {
    m_vinjPayload.push_back(m_vtlocaledges);
    m_vinjPayload.push_back(vmeanscal[ir * 2]);
    m_vinjPayload.push_back(vresoscal[ir * 2]);
  }
 
  if (m_ismakePlots) {
 
    //0 plot event track statistics
    plotEventStats();
 
    //1 plot injection time
    plotInjectionTime(hztime);
 
    //2. Draw dedxfits
    plotBinLevelDist(hdedx, "dedxfits");
 
    //3. Draw chifits
    plotBinLevelDist(hchi, "chifits");
 
    //4. Draw timedist
    plotBinLevelDist(htime, "timedist");
 
    //5. plot relative const., bias-bias corrected for dedx
    plotRelConstants(vmeans, vresos, vmeanscorr, "dedx");
 
    //6. plot relative const., bias-bias corrected for chi
    plotRelConstants(vmeans_chi, vresos_chi, vresoscorr, "chi");
 
    //7. plot mean and resolution of corrected dedx to check for consistency
    plotRelConstants(vmeans_corr, vresos_corr, vresoscorr, "dedx_corr");
 
    //8. plot time statistics dist
    plotTimeStat(htime);
 
    //9. plot final merged const. and comparison to old
    plotFinalConstants(vmeanscal, vresoscal, scale, scale_reso);
  }
 
  //saving payloads;
  CDCDedxInjectionTime* gains = new CDCDedxInjectionTime(m_vinjPayload);
  saveCalibration(gains, "CDCDedxInjectionTime");
  B2INFO("dE/dx Injection time calibration done");
 
  //delete all histograms
  deleteHisto(htime);
  deleteHisto(hdedx);
  deleteHisto(hdedx_corr);
  deleteHisto(hchi);
  deleteTimeHisto(hztime);
  delete htimes;
 
  B2INFO("Saving calibration for: " << m_suffix << "");
  return c_OK;
}

checkPyExpRun()

bool checkPyExpRun ( PyObject * pyObj )

staticinherited

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

Checks if the PyObject can be converted to ExpRun.

Definition at line 28 of file CalibrationAlgorithm.cc.

{
  // Is it a sequence?
  if (PySequence_Check(pyObj)) {
    Py_ssize_t nObj = PySequence_Length(pyObj);
    // Does it have 2 objects in it?
    if (nObj != 2) {
      B2DEBUG(29, "ExpRun was a Python sequence which didn't have exactly 2 entries!");
      return false;
    }
    PyObject* item1, *item2;
    item1 = PySequence_GetItem(pyObj, 0);
    item2 = PySequence_GetItem(pyObj, 1);
    // Did the GetItem work?
    if ((item1 == NULL) || (item2 == NULL)) {
      B2DEBUG(29, "A PyObject pointer was NULL in the sequence");
      return false;
    }
    // Are they longs?
    if (PyLong_Check(item1) && PyLong_Check(item2)) {
      long value1, value2;
      value1 = PyLong_AsLong(item1);
      value2 = PyLong_AsLong(item2);
      if (((value1 == -1) || (value2 == -1)) && PyErr_Occurred()) {
        B2DEBUG(29, "An error occurred while converting the PyLong to long");
        return false;
      }
    } else {
      B2DEBUG(29, "One or more of the PyObjects in the ExpRun wasn't a long");
      return false;
    }
    // Make sure to kill off the reference GetItem gave us responsibility for
    Py_DECREF(item1);
    Py_DECREF(item2);
  } else {
    B2DEBUG(29, "ExpRun was not a Python sequence.");
    return false;
  }
  return true;
}

checkStatistics()

void checkStatistics

(

std::array< std::vector< TH1D * >, numdedx::nrings > &

hvar

)

check statistics for obtaining calibration const.

Definition at line 422 of file CDCDedxInjectTimeAlgorithm.cc.

{
  for (unsigned int ir = 0; ir < c_rings; ir++) {
    for (unsigned int it = 5; it < m_tbins; it++) {
      //check statiscs from 1-40ms
      if (m_tedges[it] < 4e4 && hvar[ir][it]->Integral() < m_thersE) {
        m_isminStat = true;
        break;
      } else continue;
    }
  }
}

clearCalibrationData()

void clearCalibrationData ( )

inlineprotectedinherited

Clear calibration data.

Definition at line 324 of file CalibrationAlgorithm.h.

{m_data.clearCalibrationData();}

commit() [1/2]

bool commit ( )

inherited

Submit constants from last calibration into database.

Definition at line 302 of file CalibrationAlgorithm.cc.

{
  if (getPayloads().empty())
    return false;
  list<Database::DBImportQuery> payloads = getPayloads();
  B2INFO("Committing " << payloads.size()  << " payloads to database.");
  return Database::Instance().storeData(payloads);
}

commit() [2/2]

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

inherited

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

Definition at line 312 of file CalibrationAlgorithm.cc.

{
  if (payloads.empty())
    return false;
  return Database::Instance().storeData(payloads);
}

convertPyExpRun()

ExpRun convertPyExpRun ( PyObject * pyObj )

staticinherited

Performs the conversion of PyObject to ExpRun.

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

Definition at line 70 of file CalibrationAlgorithm.cc.

{
  ExpRun expRun;
  PyObject* itemExp, *itemRun;
  itemExp = PySequence_GetItem(pyObj, 0);
  itemRun = PySequence_GetItem(pyObj, 1);
  expRun.first = PyLong_AsLong(itemExp);
  Py_DECREF(itemExp);
  expRun.second = PyLong_AsLong(itemRun);
  Py_DECREF(itemRun);
  return expRun;
}

correctBinBias()

void correctBinBias	(	std::map< int, std::vector< double > > &	varcorr,
		const std::map< int, std::vector< double > > &	var,
		const std::map< int, std::vector< double > > &	time,
		TH1D *&	htimes )

function to correct dedx mean/reso and return corrected vector map

Definition at line 436 of file CDCDedxInjectTimeAlgorithm.cc.

{
  //Deep copy OK
  varcorr = var;
 
  for (int ir = 0; ir < 2; ir++) {
 
    for (int ix = varcorr[ir * 2].size(); ix -- > 0;) {
 
      double var_thisbin = 1.0;
      var_thisbin = var.at(ir * 2).at(ix);
 
      double atime_thisbin = time.at(ir * 2).at(ix);
      double ctime_thisbin = htimes->GetBinCenter(ix + 1);
 
      if (atime_thisbin > 0 && atime_thisbin < 4e4 * 0.99) {
 
        double var_nextbin = 1.0;
        var_nextbin = var.at(ir * 2).at(ix + 1);
        double var_diff = var_nextbin - var_thisbin;
 
        double atime_nextbin = time.at(ir * 2).at(ix + 1);
        double atime_diff = atime_nextbin - atime_thisbin;
 
        double slope = (atime_diff > 0) ? var_diff / atime_diff : -1.0;
 
        //extrapolation after veto only
        if (var_diff > 0 && slope > 0)varcorr[ir * 2].at(ix) = var_thisbin + (ctime_thisbin - atime_thisbin) * (slope);
        printf("\t %s ix = %d, center = %0.2f(%0.3f), var = %0.5f(%0.5f) \n", m_sring[ir].data(), ix, ctime_thisbin, atime_thisbin,
               var_thisbin, varcorr[ir * 2].at(ix));
      } else {
        printf("\t %s --> ix = %d, center = %0.2f(%0.3f), var = %0.5f(%0.5f) \n", m_sring[ir].data(), ix, ctime_thisbin, atime_thisbin,
               var_thisbin, varcorr[ir * 2].at(ix));
      }
    }
  }
}

createPayload()

void createPayload	(	std::array< double, numdedx::nrings > &	scale,
		const std::map< int, std::vector< double > > &	vmeans,
		std::map< int, std::vector< double > > &	varscal,
		const std::string &	svar )

function to store payloads after full calibration

Definition at line 477 of file CDCDedxInjectTimeAlgorithm.cc.

{
  varscal = var;
 
  B2INFO("CDCDedxInjectTimeAlgorithm: normalising constants with plateau");
  for (unsigned int ir = 0; ir < c_rings; ir++) {
    //scaling means with time >40ms
    unsigned int msize = varscal[ir * 2].size();
    int countsum = 0;
    scale[ir] = 0;
    for (unsigned int im = 0; im < msize; im++) {
      double time = m_vtlocaledges.at(im);
      double mean = varscal[ir * 2].at(im);
      if (time > 4e4 && mean > 0) {
        scale[ir]  += mean;
        countsum++;
      }
    }
    if (countsum > 0 && scale[ir] > 0) {
      scale[ir] /= countsum;
      for (unsigned int im = 0; im < msize; im++) {
        varscal[ir * 2].at(im) /= scale[ir];
      }
    }
  }
  if (m_isMerge && svar == "mean") {
    //merge only no change in payload structure
    bool incomp_bin = false;
    std::vector<std::vector<double>> oldvectors;
    if (m_DBInjectTime) oldvectors = m_DBInjectTime->getConstVector();
    int vsize = oldvectors.size();
    if (vsize != 6) incomp_bin = true;
    else {
      for (int iv = 0; iv < 2; iv++) {
        if (oldvectors[iv * 3 + 1].size() != varscal[iv * 2].size()) incomp_bin = true;
      }
    }
    if (!incomp_bin) {
      B2INFO("CDCDedxInjectTimeAlgorithm: started merging relative constants");
      for (int ir = 0; ir < 2; ir++) {//merging only means
        unsigned int msize = varscal[ir * 2].size();
        for (unsigned int im = 0; im < msize; im++) {
          double relvalue = varscal[ir * 2].at(im);
          double oldvalue = oldvectors[ir * 3 + 1].at(im);
          double merged = oldvalue * relvalue;
          printf("%s: rel %0.03f, old %0.03f, merged %0.03f\n", m_suffix.data(), relvalue, oldvalue, merged);
          varscal[ir * 2].at(im)  *= oldvectors[ir * 3 + 1].at(im) ;
        }
      }
    } else B2ERROR("CDCDedxInjectTimeAlgorithm: found incompatible bins for merging");
  } else B2INFO("CDCDedxInjectTimeAlgorithm: saving final (abs) calibration");
}

defineHisto()

void defineHisto	(	std::array< std::vector< TH1D * >, 2 > &	htemp,
		const std::string &	var )

function to define histograms for dedx and time dist.

(in time bins)

Definition at line 387 of file CDCDedxInjectTimeAlgorithm.cc.

{
  for (unsigned int ir = 0; ir < c_rings; ir++) {
    htemp[ir].resize(m_tbins);
    for (unsigned int it = 0; it < m_tbins; it++) {
      std::string label = getTimeBinLabel(m_tedges[it], it);
      std::string title = Form("%s(%s), time(%s)", m_suffix.data(), m_sring[ir].data(), label.data());
      std::string hname = Form("h%s_%s_%s_t%d", var.data(), m_sring[ir].data(), m_suffix.data(), it);
      if (var == "dedx" or var == "dedx_corr") htemp[ir][it] = new TH1D(hname.data(), "", m_dedxBins, m_dedxMin, m_dedxMax);
      else if (var == "chi") htemp[ir][it] = new TH1D(hname.data(), "", m_chiBins, m_chiMin, m_chiMax);
      else htemp[ir][it] = new TH1D(hname.data(), "", 50, m_tedges[it], m_tedges[it + 1]);
      htemp[ir][it]->SetTitle(Form("%s;%s;entries", title.data(), var.data()));
    }
  }
}

defineTimeBins()

void defineTimeBins

(

)

function to set/reset time bins

Definition at line 364 of file CDCDedxInjectTimeAlgorithm.cc.

{
  //empty local vector or find a way to execulate this function
  //only once
  if (!m_vtlocaledges.empty()) m_vtlocaledges.clear();
  if (m_vtedges.empty()) {
    double fixedges[69];
    for (int ib = 0; ib < 69; ib++) {
      fixedges[ib] = ib * 0.5 * 1e3;
      if (ib > 40 && ib <= 60) fixedges[ib] = fixedges[ib - 1] + 1.0 * 1e3;
      else if (ib > 60 && ib <= 64) fixedges[ib] = fixedges[ib - 1] + 10.0 * 1e3;
      else if (ib > 64 && ib <= 65) fixedges[ib] = fixedges[ib - 1] + 420.0 * 1e3;
      else if (ib > 65 && ib <= 66) fixedges[ib] = fixedges[ib - 1] + 500.0 * 1e3;
      else if (ib > 66) fixedges[ib] = fixedges[ib - 1] + 2e6;
      m_vtlocaledges.push_back(fixedges[ib]);
    }
  } else {
    for (unsigned int ib = 0; ib < m_vtedges.size(); ib++)
      m_vtlocaledges.push_back(m_vtedges.at(ib));
  }
}

defineTimeHisto()

void defineTimeHisto

(

std::array< std::array< TH1D *, 3 >, numdedx::nrings > &

htemp

)

function to define injection time bins histograms (monitoring only)

Definition at line 404 of file CDCDedxInjectTimeAlgorithm.cc.

{
  const int tzoom = 3;
  const int nt[tzoom] = {50, 500, 1000};
  double tzedges[tzoom + 1] = {0, 2.0e3, 0.1e6, 20e6};
  std::string stname[tzoom] = {"early", "mid", "later"};
  std::string stlabel[tzoom] = {"zoom <2ms", "early time <= 100ms", "later time >100ms"};
  for (unsigned int ir = 0; ir < c_rings; ir++) {
    for (int wt = 0; wt < tzoom; wt++) {
      std::string title = Form("inject time (%s), %s (%s)", stlabel[wt].data(), m_sring[ir].data(), m_suffix.data());
      std::string hname = Form("htimezoom_%s_%s_%s", m_sring[ir].data(), stname[wt].data(), m_suffix.data());
      htemp[ir][wt] = new TH1D(Form("%s", hname.data()), "", nt[wt], tzedges[wt], tzedges[wt + 1]);
      htemp[ir][wt]->SetTitle(Form("%s;injection time(#mu-sec);entries", title.data()));
    }
  }
}

deleteHisto()

void deleteHisto ( const std::array< std::vector< TH1D * >, numdedx::nrings > & htemp )

inline

function to delete histograms for dedx and time dist.

(in time bins)

Definition at line 200 of file CDCDedxInjectTimeAlgorithm.h.

    {
      for (unsigned int ir = 0; ir < c_rings; ir++) {
        for (unsigned int it = 0; it < m_tbins; it++) {
          delete htemp[ir][it];
        }
      }
    }

deleteTimeHisto()

static void deleteTimeHisto ( const std::array< std::array< TH1D *, 3 >, numdedx::nrings > & htemp )

inlinestatic

function to define injection time bins histograms (monitoring only)

Definition at line 212 of file CDCDedxInjectTimeAlgorithm.h.

    {
      const int tzoom = 3;
      for (unsigned int ir = 0; ir < c_rings; ir++) {
        for (int wt = 0; wt < tzoom; wt++) {
          delete htemp[ir][wt];
        }
      }
    }

dumpOutputJson()

const std::string dumpOutputJson ( ) const

inlineinherited

Dump the JSON string of the output JSON object.

Definition at line 223 of file CalibrationAlgorithm.h.

{return m_jsonExecutionOutput.dump();}

execute() [1/2]

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

inherited

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

Definition at line 83 of file CalibrationAlgorithm.cc.

{
  B2DEBUG(29, "Running execute() using Python Object as input argument");
  // Reset the execution specific data in case the algorithm was previously called
  m_data.reset();
  m_data.setIteration(iteration);
  vector<ExpRun> vecRuns;
  // Is it a list?
  if (PySequence_Check(runs)) {
    boost::python::handle<> handle(boost::python::borrowed(runs));
    boost::python::list listRuns(handle);
 
    int nList = boost::python::len(listRuns);
    for (int iList = 0; iList < nList; ++iList) {
      boost::python::object pyExpRun(listRuns[iList]);
      if (!checkPyExpRun(pyExpRun.ptr())) {
        B2ERROR("Received Python ExpRuns couldn't be converted to C++");
        m_data.setResult(c_Failure);
        return c_Failure;
      } else {
        vecRuns.push_back(convertPyExpRun(pyExpRun.ptr()));
      }
    }
  } else {
    B2ERROR("Tried to set the input runs but we didn't receive a Python sequence object (list,tuple).");
    m_data.setResult(c_Failure);
    return c_Failure;
  }
  return execute(vecRuns, iteration, iov);
}

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.

{
  // Check if we are calling this function directly and need to reset, or through Python where it was already done.
  if (m_data.getResult() != c_Undefined) {
    m_data.reset();
    m_data.setIteration(iteration);
  }
 
  if (m_inputFileNames.empty()) {
    B2ERROR("There aren't any input files set. Please use CalibrationAlgorithm::setInputFiles()");
    m_data.setResult(c_Failure);
    return c_Failure;
  }
 
  // Did we receive runs to execute over explicitly?
  if (!(runs.empty())) {
    for (auto expRun : runs) {
      B2DEBUG(29, "ExpRun requested = (" << expRun.first << ", " << expRun.second << ")");
    }
    // We've asked explicitly for certain runs, but we should check if the data granularity is 'run'
    if (strcmp(getGranularity().c_str(), "all") == 0) {
      B2ERROR(("The data is collected with granularity=all (exp=-1,run=-1), but you seem to request calibration for specific runs."
               " We'll continue but using ALL the input data given instead of the specific runs requested."));
    }
  } else {
    // If no runs are provided, infer the runs from all collected data
    runs = getRunListFromAllData();
    // Let's check that we have some now
    if (runs.empty()) {
      B2ERROR("No collected data in input files.");
      m_data.setResult(c_Failure);
      return c_Failure;
    }
    for (auto expRun : runs) {
      B2DEBUG(29, "ExpRun requested = (" << expRun.first << ", " << expRun.second << ")");
    }
  }
 
  m_data.setRequestedRuns(runs);
  if (iov.empty()) {
    // If no user specified IoV we use the IoV from the executed run list
    iov = IntervalOfValidity(runs[0].first, runs[0].second, runs[runs.size() - 1].first, runs[runs.size() - 1].second);
  }
  m_data.setRequestedIov(iov);
  // After here, the getObject<...>(...) helpers start to work
 
  CalibrationAlgorithm::EResult result = calibrate();
  m_data.setResult(result);
  return result;
}

fillRunToInputFilesMap()

void fillRunToInputFilesMap ( )

inherited

Fill the mapping of ExpRun -> Files.

Definition at line 331 of file CalibrationAlgorithm.cc.

{
  m_runsToInputFiles.clear();
  // Save TDirectory to change back at the end
  TDirectory* dir = gDirectory;
  RunRange* runRange;
  // Construct the TDirectory name where we expect our objects to be
  string runRangeObjName(getPrefix() + "/" + RUN_RANGE_OBJ_NAME);
  for (const auto& fileName : m_inputFileNames) {
    //Open TFile to get the objects
    unique_ptr<TFile> f;
    f.reset(TFile::Open(fileName.c_str(), "READ"));
    runRange = dynamic_cast<RunRange*>(f->Get(runRangeObjName.c_str()));
    if (runRange) {
      // Insert or extend the run -> file mapping for this ExpRun
      auto expRuns = runRange->getExpRunSet();
      for (const auto& expRun : expRuns) {
        auto runFiles = m_runsToInputFiles.find(expRun);
        if (runFiles != m_runsToInputFiles.end()) {
          (runFiles->second).push_back(fileName);
        } else {
          m_runsToInputFiles.insert(std::make_pair(expRun, std::vector<std::string> {fileName}));
        }
      }
    } else {
      B2WARNING("Missing a RunRange object for file: " << fileName);
    }
  }
  dir->cd();
}

findPayloadBoundaries()

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

inherited

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

Definition at line 521 of file CalibrationAlgorithm.cc.

{
  m_boundaries.clear();
  if (m_inputFileNames.empty()) {
    B2ERROR("There aren't any input files set. Please use CalibrationAlgorithm::setInputFiles()");
    return m_boundaries;
  }
  // Reset the internal execution data just in case something is hanging around
  m_data.reset();
  if (runs.empty()) {
    // Want to loop over all runs we could possibly know about
    runs = getRunListFromAllData();
  }
  // Let's check that we have some now
  if (runs.empty()) {
    B2ERROR("No collected data in input files.");
    return m_boundaries;
  }
  // In order to find run boundaries we must have collected with data granularity == 'run'
  if (strcmp(getGranularity().c_str(), "all") == 0) {
    B2ERROR("The data is collected with granularity='all' (exp=-1,run=-1), and we can't use that to find run boundaries.");
    return m_boundaries;
  }
  m_data.setIteration(iteration);
  // User defined setup function
  boundaryFindingSetup(runs, iteration);
  std::vector<ExpRun> runList;
  // Loop over run list and call derived class "isBoundaryRequired" member function
  for (auto currentRun : runs) {
    runList.push_back(currentRun);
    m_data.setRequestedRuns(runList);
    // After here, the getObject<...>(...) helpers start to work
    if (isBoundaryRequired(currentRun)) {
      m_boundaries.push_back(currentRun);
    }
    // Only want run-by-run
    runList.clear();
    // Don't want memory hanging around
    m_data.clearCalibrationData();
  }
  m_data.reset();
  boundaryFindingTearDown();
  return m_boundaries;
}

fitGaussianWRange()

void fitGaussianWRange	(	TH1D *&	temphist,
		fstatus &	status )

function to perform gauss fit for input histogram

Definition at line 307 of file CDCDedxInjectTimeAlgorithm.cc.

{
  double histmean = temphist->GetMean();
  double histrms = temphist->GetRMS();
  temphist->GetXaxis()->SetRangeUser(histmean - 5.0 * histrms, histmean + 5.0 * histrms);
 
  int fs = temphist->Fit("gaus", "Q0");
  if (fs != 0) {
    B2INFO(Form("\tFit (round 1) for hist (%s) failed (status = %d)", temphist->GetName(), fs));
    status = fitFailed;
    return;
  } else {
    double mean = temphist->GetFunction("gaus")->GetParameter(1);
    double width = temphist->GetFunction("gaus")->GetParameter(2);
    temphist->GetXaxis()->SetRangeUser(mean - 5.0 * width, mean + 5.0 * width);
    fs = temphist->Fit("gaus", "QR", "", mean - m_sigmaR * width, mean + m_sigmaR * width);
    if (fs != 0) {
      B2INFO(Form("\tFit (round 2) for hist (%s) failed (status = %d)", temphist->GetName(), fs));
      status = fitFailed;
      return;
    } else {
      temphist->GetXaxis()->SetRangeUser(mean - 5.0 * width, mean + 5.0 * width);
      B2INFO(Form("\tFit for hist (%s) successful (status = %d)", temphist->GetName(), fs));
      status = fitOK;
    }
  }
}

getAllGranularityExpRun()

static Calibration::ExpRun getAllGranularityExpRun ( )

inlinestaticprotectedinherited

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

Definition at line 327 of file CalibrationAlgorithm.h.

{return m_allExpRun;}

getCollectorName()

const std::string & getCollectorName ( ) const

inlineinherited

Alias for prefix.

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

Definition at line 164 of file CalibrationAlgorithm.h.

{return getPrefix();}

getCorrection()

double getCorrection	(	unsigned int	ring,
		unsigned int	time,
		const std::map< int, std::vector< double > > &	vmeans )

function to get the correction factor of mean

Definition at line 874 of file CDCDedxInjectTimeAlgorithm.cc.

{
 
  unsigned int iv = ring * 2;
 
  unsigned int sizet = m_vtlocaledges.size(); //time
 
  std::vector<unsigned int> tedges(sizet); //time edges array
  std::copy(m_vtlocaledges.begin(), m_vtlocaledges.end(), tedges.begin());
 
  if (time >= 5e6) time = 5e6 - 10;
  unsigned int it = m_DBInjectTime->getTimeBin(tedges, time);
 
  double center = 0.5 * (m_vtlocaledges.at(it) + m_vtlocaledges.at(it + 1));
 
  //no corr before veto bin (usually one or two starting bin)
  //intrapolation for entire range except
  //--extrapolation (for first half and last half of intended bin)
  int thisbin = it, nextbin = it;
  if (center != time && it > 0) {
 
    if (time < center) {
      thisbin = it - 1;
    } else {
      if (it < sizet - 2)nextbin = it + 1;
      else thisbin = it - 1;
    }
 
    if (it <= 2) {
      double diff = vmeans.at(iv).at(2) - vmeans.at(iv).at(1) ;
      if (diff < -0.015) { //difference above 1.0%
        thisbin = it;
        if (it == 1) nextbin = it;
        else nextbin = it + 1;
      } else {
        if (it == 1) {
          thisbin = it;
          nextbin = it + 1;
        }
      }
    }
  }
 
  double thisdedx = vmeans.at(iv).at(thisbin);
  double nextdedx = vmeans.at(iv).at(nextbin);
 
  double thistime = 0.5 * (m_vtlocaledges.at(thisbin) + m_vtlocaledges.at(thisbin + 1));
  double nexttime = 0.5 * (m_vtlocaledges.at(nextbin) + m_vtlocaledges.at(nextbin + 1));
 
  double newdedx = vmeans.at(iv).at(it);
  if (thisbin != nextbin)
    newdedx = thisdedx + ((nextdedx - thisdedx) / (nexttime - thistime)) * (time - thistime);
 
  return newdedx;
}

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.

{return m_description;}

getExpRunInfo()

void getExpRunInfo

(

)

function to get exp/run information (payload object, plotting)

Definition at line 336 of file CDCDedxInjectTimeAlgorithm.cc.

{
  int cruns = 0;
  for (auto expRun : getRunList()) {
    if (cruns == 0)B2INFO("CDCDedxInjectTimeAlgorithm: start exp " << expRun.first << " and run " << expRun.second << "");
    cruns++;
  }
 
  const auto erStart = getRunList()[0];
  int estart = erStart.first;
  int rstart = erStart.second;
 
  const auto erEnd = getRunList()[cruns - 1];
  // cppcheck-suppress variableScope ; kept next to the related declarations for readability
  int rend = erEnd.second;
 
  updateDBObjPtrs(1, erStart.second, erStart.first);
 
  if (m_isminStat) {
    m_suffix = Form("e%dr%dto%d_nruns%d", estart, rstart, rend, cruns);
    B2INFO("\t+ run = " << rend << ", m_suffix = " << m_suffix << "");
  } else {
    m_suffix = Form("e%dr%d", estart, rstart);
    B2INFO("tool run = " << estart << ", exp = " << estart << ", m_suffix = " << m_suffix << "");
  }
}

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.

{
  string expRunString;
  expRunString += to_string(expRun.first);
  expRunString += ".";
  expRunString += to_string(expRun.second);
  return expRunString;
}

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.

{
  string dirName = getPrefix() + "/" + name;
  string objName = name + "_" + getExpRunString(expRun);
  return dirName + "/" + objName;
}

getGranularity()

const std::string & getGranularity ( ) const

inlineinherited

Get the granularity of collected data.

Definition at line 188 of file CalibrationAlgorithm.h.

{return m_granularityOfData;};

getGranularityFromData()

string getGranularityFromData ( ) const

protectedinherited

Get the granularity of collected data.

Definition at line 384 of file CalibrationAlgorithm.cc.

{
  // Save TDirectory to change back at the end
  TDirectory* dir = gDirectory;
  const RunRange* runRange;
  string runRangeObjName(getPrefix() + "/" + RUN_RANGE_OBJ_NAME);
  // We only check the first file
  string fileName = m_inputFileNames[0];
  unique_ptr<TFile> f;
  f.reset(TFile::Open(fileName.c_str(), "READ"));
  runRange = dynamic_cast<RunRange*>(f->Get(runRangeObjName.c_str()));
  if (!runRange) {
    B2FATAL("The input file " << fileName << " does not contain a RunRange object at "
            << runRangeObjName << ". Please set your input files to exclude it.");
    return "";
  }
  string granularity = runRange->getGranularity();
  dir->cd();
  return granularity;
}

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.

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

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.

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

    {
      return m_jsonExecutionInput.at(key);
    }

getIovFromAllData()

IntervalOfValidity getIovFromAllData ( ) const

inherited

Get the complete IoV from inspection of collected data.

Definition at line 326 of file CalibrationAlgorithm.cc.

{
  return getRunRangeFromAllData().getIntervalOfValidity();
}

getIteration()

int getIteration ( ) const

inlineprotectedinherited

Get current iteration.

Definition at line 269 of file CalibrationAlgorithm.h.

{ return m_data.getIteration(); }

getMeanReso()

void getMeanReso	(	std::array< std::vector< TH1D * >, numdedx::nrings > &	hvar,
		std::map< int, std::vector< double > > &	vmeans,
		std::map< int, std::vector< double > > &	vresos )

function to get mean and reso of histogram

Definition at line 274 of file CDCDedxInjectTimeAlgorithm.cc.

{
  for (unsigned int ir = 0; ir < c_rings; ir++) {
 
    for (unsigned int it = 0; it < m_tbins; it++) {
      double mean = 1.00, meanerr = 0.0;
      double reso = 1.00, resoerr = 0.0;
      if (hvar[ir][it]->Integral() > 250) {
        fstatus status;
        fitGaussianWRange(hvar[ir][it], status);
        if (status != fitOK) {
          mean = hvar[ir][it]->GetMean();
          hvar[ir][it]->SetTitle(Form("%s, (%d)", hvar[ir][it]->GetTitle(), status));
        } else {
          mean = hvar[ir][it]->GetFunction("gaus")->GetParameter(1);
          meanerr = hvar[ir][it]->GetFunction("gaus")->GetParError(1);
          reso = hvar[ir][it]->GetFunction("gaus")->GetParameter(2);
          resoerr = hvar[ir][it]->GetFunction("gaus")->GetParError(2);
          std::string title = Form("#mu_{fit}: %0.03f, #sigma_{fit}: %0.03f", mean, reso);
          hvar[ir][it]->SetTitle(Form("%s, %s", hvar[ir][it]->GetTitle(), title.data()));
        }
      }
 
      vmeans[ir * 2].push_back(mean);
      vresos[ir * 2].push_back(reso);
      vmeans[ir * 2 + 1].push_back(meanerr);
      vresos[ir * 2 + 1].push_back(resoerr);
    }
  }
}

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.

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

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.

    {
      return m_jsonExecutionOutput.at(key);
    }

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.

{return m_data.getPayloads();}

getPayloadValues()

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

inlineinherited

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

Definition at line 207 of file CalibrationAlgorithm.h.

{return m_data.getPayloadValues();}

getPrefix()

const std::string & getPrefix ( ) const

inlineinherited

Get the prefix used for getting calibration data.

Definition at line 146 of file CalibrationAlgorithm.h.

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

{return m_data.getRequestedRuns();}

getRunListFromAllData()

vector< ExpRun > getRunListFromAllData ( ) const

inherited

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

Definition at line 319 of file CalibrationAlgorithm.cc.

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

getRunRangeFromAllData()

RunRange getRunRangeFromAllData ( ) const

inherited

Get the complete RunRange from inspection of collected data.

Definition at line 362 of file CalibrationAlgorithm.cc.

{
  // Save TDirectory to change back at the end
  TDirectory* dir = gDirectory;
  RunRange runRange;
  // Construct the TDirectory name where we expect our objects to be
  string runRangeObjName(getPrefix() + "/" + RUN_RANGE_OBJ_NAME);
  for (const auto& fileName : m_inputFileNames) {
    //Open TFile to get the objects
    unique_ptr<TFile> f;
    f.reset(TFile::Open(fileName.c_str(), "READ"));
    const RunRange* runRangeOther = dynamic_cast<RunRange*>(f->Get(runRangeObjName.c_str()));
    if (runRangeOther) {
      runRange.merge(runRangeOther);
    } else {
      B2WARNING("Missing a RunRange object for file: " << fileName);
    }
  }
  dir->cd();
  return runRange;
}

getTimeBinLabel()

std::string getTimeBinLabel ( const double & tedges, const int & it )

inline

function to return time label for histograms labeling

Definition at line 188 of file CDCDedxInjectTimeAlgorithm.h.

    {
      std::string label = "";
      if (tedges < 2e4)label = Form("%0.01f-%0.01fK", m_tedges[it] / 1e3, m_tedges[it + 1] / 1e3);
      else if (tedges < 1e5)label = Form("%0.0f-%0.0fK", m_tedges[it] / 1e3, m_tedges[it + 1] / 1e3);
      else label = Form("%0.01f-%0.01fM", m_tedges[it] / 1e6, m_tedges[it + 1] / 1e6);
      return label;
    }

getVecInputFileNames()

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

inlineprotectedinherited

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

Definition at line 275 of file CalibrationAlgorithm.h.

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

{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, SVDClusterAbsoluteTimeShifterAlgorithm, SVDCoGTimeCalibrationAlgorithm, TestBoundarySettingAlgorithm, and TestCalibrationAlgorithm.

Definition at line 243 of file CalibrationAlgorithm.h.

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

loadInputJson()

bool loadInputJson ( const std::string & jsonString )

inherited

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

Definition at line 503 of file CalibrationAlgorithm.cc.

{
  try {
    auto jsonInput = nlohmann::json::parse(jsonString);
    // Input string has an object (dict) as the top level object?
    if (jsonInput.is_object()) {
      m_jsonExecutionInput = jsonInput;
      return true;
    } else {
      B2ERROR("JSON input string isn't an object type i.e. not a '{}' at the top level.");
      return false;
    }
  } catch (nlohmann::json::parse_error&) {
    B2ERROR("Parsing of JSON input string failed");
    return false;
  }
}

plotBinLevelDist()

void plotBinLevelDist	(	std::array< std::vector< TH1D * >, 2 > &	hvar,
		const std::string &	var )

function to draw dedx, chi and time dist.

Definition at line 533 of file CDCDedxInjectTimeAlgorithm.cc.

{
  TCanvas cfit("cfit", "cfit", 1000, 500);
  cfit.Divide(2, 1);
  std::stringstream psname_fit;
  psname_fit << Form("%s_%s_%s.pdf[", m_prefix.data(), var.data(), m_suffix.data());
  cfit.Print(psname_fit.str().c_str());
  psname_fit.str("");
  psname_fit << Form("%s_%s_%s.pdf", m_prefix.data(), var.data(), m_suffix.data());
  for (unsigned int it = 0; it < m_tbins; it++) {
    for (unsigned int ir = 0; ir < c_rings; ir++) {
      cfit.cd(ir + 1);
      hvar[ir][it]->SetFillColorAlpha(ir + 5, 0.25);
      hvar[ir][it]->Draw();
    }
    cfit.Print(psname_fit.str().c_str());
  }
  psname_fit.str("");
  psname_fit << Form("%s_%s_%s.pdf]", m_prefix.data(), var.data(), m_suffix.data());
  cfit.Print(psname_fit.str().c_str());
}

plotEventStats()

void plotEventStats

(

)

function to draw event/track statistics plots

Definition at line 556 of file CDCDedxInjectTimeAlgorithm.cc.

{
  // draw event and track statistics
  TCanvas cestat("cestat", "cestat", 1000, 500);
  cestat.SetBatch(kTRUE);
  cestat.Divide(2, 1);
 
  cestat.cd(1);
  auto hestats = getObjectPtr<TH1I>("hestats");
  if (hestats) {
    hestats->SetName(Form("hestats_%s", m_suffix.data()));
    hestats->SetStats(0);
    hestats->Draw("hist text");
  }
  cestat.cd(2);
  auto htstats = getObjectPtr<TH1I>("htstats");
  if (htstats) {
    htstats->SetName(Form("htstats_%s", m_suffix.data()));
    htstats->SetStats(0);
    htstats->Draw("hist text");
  }
  cestat.Print(Form("%s_eventstat_%s.pdf", m_prefix.data(), m_suffix.data()));
}

plotFinalConstants()

void plotFinalConstants	(	std::map< int, std::vector< double > > &	vmeans,
		std::map< int, std::vector< double > > &	vresos,
		std::array< double, numdedx::nrings > &	scale,
		std::array< double, numdedx::nrings > &	scale_reso )

function to final constant from merging or abs fits

Definition at line 751 of file CDCDedxInjectTimeAlgorithm.cc.

{
 
  std::vector<std::vector<double>> oldvectors;
  if (m_DBInjectTime)oldvectors = m_DBInjectTime->getConstVector();
 
  const int c_type = 2; //old and new
  std::string sname[c_rings] = {"mean", "reso"};
  std::string stype[c_type] = {"new", "old"};
  const int lcolors[c_rings] = {2, 4};
  const int lmarker[c_type] = {20, 24}; //+2 for different rings
 
  TH1D* hmean[c_rings][c_type], *hreso[c_rings][c_type];
 
  TCanvas* cconst[c_rings];
  for (int ic = 0; ic < 2; ic++) {
    cconst[ic] = new TCanvas(Form("c%sconst", sname[ic].data()), "", 900, 500);
    cconst[ic]->SetGridy(1);
  }
 
  TLegend* mleg = new TLegend(0.50, 0.54, 0.80, 0.75, NULL, "brNDC");
  mleg->SetBorderSize(0);
  mleg->SetFillStyle(0);
 
  TLegend* rleg = new TLegend(0.50, 0.54, 0.80, 0.75, NULL, "brNDC");
  rleg->SetBorderSize(0);
  rleg->SetFillStyle(0);
 
  for (unsigned int ip = 0; ip < c_type; ip++) {
 
    for (unsigned int ir = 0; ir < c_rings; ir++) {
 
      std::string hname = Form("hfmean_%s_%s_%s", m_sring[ir].data(), stype[ip].data(), m_suffix.data());
      hmean[ir][ip] = new TH1D(hname.data(), "", m_tbins, 0, m_tbins);
      std::string title = Form("#mu(dedx), final-mean-compare (%s)", m_suffix.data());
      hmean[ir][ip]->SetTitle(Form("%s;injection time(#mu-second);#mu (dedx-fit)", title.data()));
 
      hname = Form("hfreso_%s_%s_%s", m_sring[ir].data(), stype[ip].data(), m_suffix.data());
      hreso[ir][ip] = new TH1D(hname.data(), "", m_tbins, 0, m_tbins);
      title = Form("#sigma(#chi), final-reso-compare (%s)", m_suffix.data());
      hreso[ir][ip]->SetTitle(Form("%s;injection time(#mu-second);#sigma (#chi-fit)", title.data()));
 
      for (unsigned int it = 0; it < m_tbins; it++) {
 
        std::string label = getTimeBinLabel(m_tedges[it], it);
        double mean = 0.0, reso = 0.0;
        if (ip == 0) {
          mean = m_vinjPayload[ir * 3 + 1].at(it);
          //reso is reso/mu (reso is relative so mean needs to be relative)
          reso = m_vinjPayload[ir * 3 + 2].at(it);
 
        } else {
          mean = oldvectors[ir * 3 + 1].at(it);
          reso = oldvectors[ir * 3 + 2].at(it);
 
        }
 
        //old payloads
        hmean[ir][ip]->SetBinContent(it + 1, mean);
        hmean[ir][ip]->SetBinError(it + 1, vmeans[ir * 2 + 1].at(it));
        hmean[ir][ip]->GetXaxis()->SetBinLabel(it + 1, label.data());
 
        hreso[ir][ip]->SetBinContent(it + 1, reso);
        hreso[ir][ip]->SetBinError(it + 1, vresos[ir * 2 + 1].at(it));
        hreso[ir][ip]->GetXaxis()->SetBinLabel(it + 1, label.data());
      }
 
      cconst[0]->cd();
      if (ip == 1)mleg->AddEntry(hmean[ir][ip], Form("%s, %s", m_sring[ir].data(), stype[ip].data()), "lep");
      else mleg->AddEntry(hmean[ir][ip], Form("%s, %s (scaled by %0.03f)", m_sring[ir].data(), stype[ip].data(), scale[ir]), "lep");
      setHistStyle(hmean[ir][ip], lcolors[ir], lmarker[ip] + ir * 2, 0.60, 1.05);
      if (ir == 0 && ip == 0)hmean[ir][ip]->Draw("");
      else hmean[ir][ip]->Draw("same");
      if (ir == 1 && ip == 1)mleg->Draw("same");
 
      cconst[1]->cd();
      if (ip == 1)rleg->AddEntry(hreso[ir][ip], Form("%s, %s", m_sring[ir].data(), stype[ip].data()), "lep");
      else rleg->AddEntry(hreso[ir][ip], Form("%s, %s (scaled by %0.03f)", m_sring[ir].data(), stype[ip].data(), scale_reso[ir]), "lep");
      setHistStyle(hreso[ir][ip], lcolors[ir], lmarker[ip] + ir * 2, 0.6, 1.9);
      if (ir == 0  && ip == 0)hreso[ir][ip]->Draw("");
      else hreso[ir][ip]->Draw("same");
      if (ir == 1 && ip == 1)rleg->Draw("same");
    }
  }
 
  const std::string pdfName = Form("%s_finalconst_%s.pdf", m_prefix.data(), m_suffix.data());
 
  const std::string rootName = Form("%s_finalconst_%s.root", m_prefix.data(), m_suffix.data());
 
// Save mean and resolution in one PDF.
  cconst[0]->Print((pdfName + "(").c_str());
  cconst[1]->Print((pdfName + ")").c_str());
 
// Save both canvases and histograms in one ROOT file.
  TFile rootFile(rootName.c_str(), "RECREATE");
 
  rootFile.cd();
 
  cconst[0]->Write("cmeanconst");
  cconst[1]->Write("cresoconst");
 
  for (unsigned int ir = 0; ir < c_rings; ++ir) {
    for (unsigned int ip = 0; ip < c_type; ++ip) {
      hmean[ir][ip]->Write();
      hreso[ir][ip]->Write();
    }
  }
 
  rootFile.Close();
 
  for (int ic = 0; ic < 2; ic++) delete cconst[ic];
 
  for (unsigned int ir = 0; ir < c_rings; ir++) {
    for (unsigned int ip = 0; ip < c_type; ip++) {
      delete hmean[ir][ip];
      delete hreso[ir][ip];
    }
  }
}

plotInjectionTime()

void plotInjectionTime

(

std::array< std::array< TH1D *, 3 >, numdedx::nrings > &

hvar

)

function to injection time distributions (HER/LER in three bins)

Definition at line 581 of file CDCDedxInjectTimeAlgorithm.cc.

{
  TCanvas ctzoom("ctzoom", "ctzoom", 1500, 450);
  ctzoom.SetBatch(kTRUE);
  ctzoom.Divide(3, 1);
  for (int wt = 0; wt < 3; wt++) {
    ctzoom.cd(wt + 1);
    if (wt == 2) gPad->SetLogy();
    for (unsigned int ir = 0; ir < c_rings; ir++) {
      hvar[ir][wt]->SetStats(0);
      hvar[ir][wt]->SetFillColorAlpha(5 + ir, 0.20);
      if (ir == 0) {
        double max1 = hvar[ir][wt]->GetMaximum();
        double max2 = hvar[c_rings - 1][wt]->GetMaximum();
        if (max2 > max1) hvar[ir][wt]->SetMaximum(max2 * 1.05);
        hvar[ir][wt]->Draw("");
      } else hvar[ir][wt]->Draw("same");
    }
  }
  ctzoom.Print(Form("%s_timezoom_%s.pdf]", m_prefix.data(), m_suffix.data()));
}

plotRelConstants()

void plotRelConstants	(	std::map< int, std::vector< double > > &	vmeans,
		std::map< int, std::vector< double > > &	vresos,
		std::map< int, std::vector< double > > &	corr,
		const std::string &	svar )

function to relative constant from dedx fit mean and chi fit reso

Definition at line 604 of file CDCDedxInjectTimeAlgorithm.cc.

{
  std::string sname[3] = {"mean", "reso"};
  const int lcolors[c_rings] = {2, 4};
 
  TH1D* hmean[c_rings], *hcorr[c_rings];
  TH1D* hreso[c_rings];
 
  TCanvas* cconst[2];
  for (int ic = 0; ic < 2; ic++) {
    cconst[ic] = new TCanvas(Form("c%sconst", sname[ic].data()), "", 900, 500);
    cconst[ic]->SetGridy(1);
  }
 
  TLegend* mleg = new TLegend(0.50, 0.54, 0.80, 0.75, NULL, "brNDC");
  mleg->SetBorderSize(0);
  mleg->SetFillStyle(0);
 
  for (unsigned int ir = 0; ir < c_rings; ir++) {
 
    std::string mtitle = Form("#mu(dedx), relative const. compare, (%s)", m_suffix.data());
    hmean[ir] = new TH1D(Form("hmean_%s_%s", m_suffix.data(), m_sring[ir].data()), "", m_tbins, 0, m_tbins);
 
    std::string rtitle = Form("#sigma(#chi), relative const. compare, (%s)", m_suffix.data());
    hreso[ir] = new TH1D(Form("hreso_%s_%s", m_suffix.data(), m_sring[ir].data()), "", m_tbins, 0, m_tbins);
 
    hcorr[ir] = new TH1D(Form("hcorr_%s_%s", m_suffix.data(), m_sring[ir].data()), "", m_tbins, 0, m_tbins);
    if (svar == "chi") {
      hmean[ir]->SetTitle(Form("%s;injection time(#mu-second);#mu (#chi-fit)", rtitle.data()));
      hreso[ir]->SetTitle(Form("%s;injection time(#mu-second);#sigma (#chi-fit)", rtitle.data()));
      hcorr[ir]->SetTitle(Form("%s;injection time(#mu-second);#sigma (#chi-fit bin-bais-corr)", rtitle.data()));
 
    } else {
      hmean[ir]->SetTitle(Form("%s;injection time(#mu-second);#mu (dedx-fit)", mtitle.data()));
      hreso[ir]->SetTitle(Form("%s;injection time(#mu-second);#sigma (dedx-fit)", mtitle.data()));
      hcorr[ir]->SetTitle(Form("%s;injection time(#mu-second);#mu (dedx-fit, bin-bais-corr)", mtitle.data()));
    }
 
 
    for (unsigned int it = 0; it < m_tbins; it++) {
 
      std::string label = getTimeBinLabel(m_tedges[it], it);
 
      hmean[ir]->SetBinContent(it + 1, vmeans[ir * 2].at(it));
      hmean[ir]->SetBinError(it + 1, vmeans[ir * 2 + 1].at(it));
      hmean[ir]->GetXaxis()->SetBinLabel(it + 1, label.data());
 
      hreso[ir]->SetBinContent(it + 1, vresos[ir * 2].at(it));
      hreso[ir]->SetBinError(it + 1, vresos[ir * 2 + 1].at(it));
      hreso[ir]->GetXaxis()->SetBinLabel(it + 1, label.data());
 
      hcorr[ir]->SetBinContent(it + 1, corr[ir * 2].at(it));
      hcorr[ir]->SetBinError(it + 1, corr[ir * 2 + 1].at(it));
      hcorr[ir]->GetXaxis()->SetBinLabel(it + 1, label.data());
    }
 
    mleg->AddEntry(hmean[ir], Form("%s", m_sring[ir].data()), "lep");
    cconst[0]->cd();
    if (svar == "chi") setHistStyle(hmean[ir], lcolors[ir], ir + 24, -0.60, 0.60);
    else if (svar == "dedx")  setHistStyle(hmean[ir], lcolors[ir], ir + 24, 0.60, 1.10);
    else setHistStyle(hmean[ir], lcolors[ir], ir + 24, 0.9, 1.10);
 
    if (ir == 0)hmean[ir]->Draw("");
    else hmean[ir]->Draw("same");
    if (svar == "dedx") {
      mleg->AddEntry(hcorr[ir], Form("%s (bin-bias-corr)", m_sring[ir].data()), "lep");
      setHistStyle(hcorr[ir], lcolors[ir], ir + 20, 0.60, 1.10);
      hcorr[ir]->Draw("same");
    }
    if (ir == 1)mleg->Draw("same");
 
    cconst[1]->cd();
    if (svar == "chi") setHistStyle(hreso[ir], lcolors[ir], ir + 24, 0.5, 1.50);
    else setHistStyle(hreso[ir], lcolors[ir], ir + 24, 0.0, 0.15);
    if (ir == 0)hreso[ir]->Draw("");
    else hreso[ir]->Draw("same");
    if (svar == "chi") {
      mleg->AddEntry(hcorr[ir], Form("%s (bin-bias-corr)", m_sring[ir].data()), "lep");
      setHistStyle(hcorr[ir], lcolors[ir], ir + 20, 0.5, 1.50);
      hcorr[ir]->Draw("same");
    }
    if (ir == 1)mleg->Draw("same");
  }
 
  const std::string rootName = Form("%s_relconst_%s_%s.root", m_prefix.data(), svar.data(), m_suffix.data());
  TFile rootFile(rootName.c_str(), "RECREATE");
 
  rootFile.cd();
 
  cconst[0]->Write("cmeanconst");
  cconst[1]->Write("cresoconst");
 
  rootFile.Close();
 
  for (int ic = 0; ic < 2; ic++) {
 
    delete hmean[ic];
    delete hreso[ic];
    delete hcorr[ic];
  }
}

plotTimeStat()

void plotTimeStat

(

std::array< std::vector< TH1D * >, numdedx::nrings > &

htime

)

function to draw time stats

Definition at line 708 of file CDCDedxInjectTimeAlgorithm.cc.

{
  const int lcolors[c_rings] = {2, 4};
 
  TH1D* htimestat[c_rings];
 
  TCanvas* cconst = new TCanvas("ctimestatconst", "", 900, 500);
  cconst->SetGridy(1);
 
  TLegend* rleg = new TLegend(0.40, 0.60, 0.80, 0.72, NULL, "brNDC");
  rleg->SetBorderSize(0);
  rleg->SetFillStyle(0);
 
  for (unsigned int ir = 0; ir < c_rings; ir++) {
 
    std::string title = Form("injection time, her-ler comparison, (%s)", m_suffix.data());
    htimestat[ir] = new TH1D(Form("htimestat_%s_%s", m_suffix.data(), m_sring[ir].data()), "", m_tbins, 0, m_tbins);
    htimestat[ir]->SetTitle(Form("%s;injection time(#mu-second);norm. entries", title.data()));
 
    for (unsigned int it = 0; it < m_tbins; it++) {
      std::string label = getTimeBinLabel(m_tedges[it], it);
      htimestat[ir]->SetBinContent(it + 1, htime[ir][it]->Integral());
      htimestat[ir]->SetBinError(it + 1, 0);
      htimestat[ir]->GetXaxis()->SetBinLabel(it + 1, label.data());
    }
 
    cconst->cd();
    double norm = htimestat[ir]->GetMaximum();
    rleg->AddEntry(htimestat[ir], Form("%s (scaled with %0.02f)", m_sring[ir].data(), norm), "lep");
    htimestat[ir]->Scale(1.0 / norm);
    setHistStyle(htimestat[ir], lcolors[ir], ir + 20, 0.0, 1.10);
    htimestat[ir]->SetFillColorAlpha(lcolors[ir], 0.30);
    if (ir == 0) htimestat[ir]->Draw("hist");
    else htimestat[ir]->Draw("hist same");
    if (ir == 1)rleg->Draw("same");
  }
 
  cconst->SaveAs(Form("%s_relconst_timestat_%s.pdf", m_prefix.data(), m_suffix.data()));
  cconst->SaveAs(Form("%s_relconst_timestat_%s.root", m_prefix.data(), m_suffix.data()));
  delete cconst;
}

resetInputJson()

void resetInputJson ( )

inlineprotectedinherited

Clears the m_inputJson member variable.

Definition at line 330 of file CalibrationAlgorithm.h.

{m_jsonExecutionInput.clear();}

resetOutputJson()

void resetOutputJson ( )

inlineprotectedinherited

Clears the m_outputJson member variable.

Definition at line 333 of file CalibrationAlgorithm.h.

{m_jsonExecutionOutput.clear();}

saveCalibration() [1/6]

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

protectedinherited

Store DBArray payload with given name with default IOV.

Definition at line 297 of file CalibrationAlgorithm.cc.

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

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.

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

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.

{
  saveCalibration(data, DataStore::objectName(data->IsA(), ""));
}

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.

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

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.

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

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.

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

setChiPars()

void setChiPars ( int value, double min, double max )

inline

function to set chi hist parameters

Definition at line 83 of file CDCDedxInjectTimeAlgorithm.h.

    {
      m_chiBins = value;
      m_chiMin = min;
      m_chiMax = max;
    }

setDedxPars()

void setDedxPars ( int value, double min, double max )

inline

function to set dedx hist parameters

Definition at line 73 of file CDCDedxInjectTimeAlgorithm.h.

    {
      m_dedxBins = value;
      m_dedxMin = min;
      m_dedxMax = max;
    }

setDescription()

void setDescription ( const std::string & description )

inlineprotectedinherited

Set algorithm description (in constructor)

Definition at line 321 of file CalibrationAlgorithm.h.

{m_description = description;}

setFitWidth()

void setFitWidth ( double value )

inline

function to set fit range (sigma)

Definition at line 63 of file CDCDedxInjectTimeAlgorithm.h.

{m_sigmaR = value;}

setHistStyle()

static void setHistStyle ( TH1D *& htemp, const int ic, const int is, const double min, const double max )

inlinestatic

function to set histogram cosmetics

Definition at line 173 of file CDCDedxInjectTimeAlgorithm.h.

    {
      htemp->SetStats(0);
      htemp->LabelsDeflate();
      htemp->SetMarkerColor(ic);
      htemp->SetMarkerStyle(is);
      htemp->GetXaxis()->SetLabelOffset(-0.055);
      htemp->GetYaxis()->SetTitleOffset(0.75);
      htemp->SetMinimum(min);
      htemp->SetMaximum(max);
    }

setInputFileNames() [1/2]

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

protectedinherited

Set the input file names used for this algorithm.

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

Definition at line 194 of file CalibrationAlgorithm.cc.

{
  // A lot of code below is tweaked from RootInputModule::initialize,
  // since we're basically copying the functionality anyway.
  if (inputFileNames.empty()) {
    B2WARNING("You have called setInputFileNames() with an empty list. Did you mean to do that?");
    return;
  }
  auto tmpInputFileNames = RootIOUtilities::expandWordExpansions(inputFileNames);
 
  // We'll use a set to enforce sorted unique file paths as we check them
  set<string> setInputFileNames;
  // Check that files exist and convert to absolute paths
  for (auto path : tmpInputFileNames) {
    string fullPath = fs::absolute(path).string();
    if (fs::exists(fullPath)) {
      setInputFileNames.insert(fs::canonical(fullPath).string());
    } else {
      B2WARNING("Couldn't find the file " << path);
    }
  }
 
  if (setInputFileNames.empty()) {
    B2WARNING("No valid files specified!");
    return;
  } else {
    // Reset the run -> files map as our files are likely different
    m_runsToInputFiles.clear();
  }
 
  // Open TFile to check they can be accessed by ROOT
  TDirectory* dir = gDirectory;
  for (const string& fileName : setInputFileNames) {
    unique_ptr<TFile> f;
    try {
      f.reset(TFile::Open(fileName.c_str(), "READ"));
    } catch (logic_error&) {
      //this might happen for ~invaliduser/foo.root
      //actually undefined behaviour per standard, reported as ROOT-8490 in JIRA
    }
    if (!f || !f->IsOpen()) {
      B2FATAL("Couldn't open input file " + fileName);
    }
  }
  dir->cd();
 
  // Copy the entries of the set to a vector
  m_inputFileNames = vector<string>(setInputFileNames.begin(), setInputFileNames.end());
  m_granularityOfData = getGranularityFromData();
}

setInputFileNames() [2/2]

void setInputFileNames ( PyObject * inputFileNames )

inherited

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

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

Definition at line 166 of file CalibrationAlgorithm.cc.

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

setMergePayload()

void setMergePayload ( bool value = true )

inline

function to decide merged vs relative calibration

Definition at line 53 of file CDCDedxInjectTimeAlgorithm.h.

{m_isMerge = value;}

setMinTracks()

void setMinTracks ( int value )

inline

function to set min # of tracks in time bins (0-40ms)

Definition at line 68 of file CDCDedxInjectTimeAlgorithm.h.

{m_thersE = value;}

setMonitoringPlots()

void setMonitoringPlots ( bool value = false )

inline

function to enable monitoring plots

Definition at line 58 of file CDCDedxInjectTimeAlgorithm.h.

{m_ismakePlots = value;}

setOutputJsonValue()

template<class T>

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

inlineprotectedinherited

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

Definition at line 337 of file CalibrationAlgorithm.h.

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

{m_prefix = prefix;}

updateDBObjPtrs()

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

staticprotectedinherited

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

Definition at line 405 of file CalibrationAlgorithm.cc.

{
  // Construct an EventMetaData object but NOT in the Datastore
  EventMetaData emd(event, run, experiment);
  // Explicitly update while avoiding registering a Datastore object
  DBStore::Instance().update(emd);
  // Also update the intra-run objects to the event at the same time (maybe unnecessary...)
  DBStore::Instance().updateEvent(event);
}

Member Data Documentation

c_rings

const int c_rings = numdedx::nrings

staticprivate

injection ring constants

Definition at line 237 of file CDCDedxInjectTimeAlgorithm.h.

m_allExpRun

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

staticprivateinherited

allExpRun

Definition at line 364 of file CalibrationAlgorithm.h.

m_boundaries

std::vector<Calibration::ExpRun> m_boundaries

protectedinherited

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

Definition at line 261 of file CalibrationAlgorithm.h.

m_chiBins

int m_chiBins

private

bins for chi histogram

Definition at line 251 of file CDCDedxInjectTimeAlgorithm.h.

m_chiMax

double m_chiMax

private

max range of chi

Definition at line 253 of file CDCDedxInjectTimeAlgorithm.h.

m_chiMin

double m_chiMin

private

min range of chi

Definition at line 252 of file CDCDedxInjectTimeAlgorithm.h.

m_countR

int m_countR

private

a hack for running functions once

Definition at line 255 of file CDCDedxInjectTimeAlgorithm.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_DBInjectTime

DBObjPtr<CDCDedxInjectionTime> m_DBInjectTime

private

Injection time DB object.

Definition at line 267 of file CDCDedxInjectTimeAlgorithm.h.

m_dedxBins

int m_dedxBins

private

bins for dedx histogram

Definition at line 247 of file CDCDedxInjectTimeAlgorithm.h.

m_dedxMax

double m_dedxMax

private

max range of dedx

Definition at line 249 of file CDCDedxInjectTimeAlgorithm.h.

m_dedxMin

double m_dedxMin

private

min range of dedx

Definition at line 248 of file CDCDedxInjectTimeAlgorithm.h.

m_description

std::string m_description {""}

privateinherited

Description of the algorithm.

Definition at line 385 of file CalibrationAlgorithm.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_ismakePlots

bool m_ismakePlots

private

produce plots for monitoring

Definition at line 259 of file CDCDedxInjectTimeAlgorithm.h.

m_isMerge

bool m_isMerge

private

merge payload when rel constant

Definition at line 260 of file CDCDedxInjectTimeAlgorithm.h.

m_isminStat

bool m_isminStat

private

flag to merge runs for statistics thershold

Definition at line 258 of file CDCDedxInjectTimeAlgorithm.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_prefix

std::string m_prefix

private

string prefix for plot names

Definition at line 262 of file CDCDedxInjectTimeAlgorithm.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_sigmaR

double m_sigmaR

private

fit dedx dist in sigma range

Definition at line 245 of file CDCDedxInjectTimeAlgorithm.h.

m_sring

std::array<std::string, numdedx::nrings> m_sring {"ler", "her"}

private

injection ring name

Definition at line 238 of file CDCDedxInjectTimeAlgorithm.h.

{"ler", "her"};

m_suffix

std::string m_suffix

private

string suffix for object names

Definition at line 263 of file CDCDedxInjectTimeAlgorithm.h.

m_tbins

unsigned int m_tbins = 0

private

internal time bins

Definition at line 244 of file CDCDedxInjectTimeAlgorithm.h.

m_tedges

double* m_tedges = nullptr

private

internal time array (copy of vtlocaledges)

Definition at line 243 of file CDCDedxInjectTimeAlgorithm.h.

m_thersE

int m_thersE

private

min tracks to start calibration

Definition at line 256 of file CDCDedxInjectTimeAlgorithm.h.

m_vinjPayload

std::vector<std::vector<double> > m_vinjPayload

private

vector to store payload values

Definition at line 265 of file CDCDedxInjectTimeAlgorithm.h.

m_vtedges

std::vector<double> m_vtedges

private

external time vector

Definition at line 240 of file CDCDedxInjectTimeAlgorithm.h.

m_vtlocaledges

std::vector<double> m_vtlocaledges

private

internal time vector

Definition at line 241 of file CDCDedxInjectTimeAlgorithm.h.

---

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

• cdc/calibration/CDCdEdx/include/CDCDedxInjectTimeAlgorithm.h
• cdc/calibration/CDCdEdx/src/CDCDedxInjectTimeAlgorithm.cc