A validation algorithm for CDC dE/dx electron. More...

#include <CDCDedxValidationAlgorithm.h>

Inheritance diagram for CDCDedxValidationAlgorithm:

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

Public Member Functions
	CDCDedxValidationAlgorithm ()
	Constructor: Sets the description, the properties and the parameters of the algorithm.

virtual	~CDCDedxValidationAlgorithm ()
	Destructor.

void	printCanvasRun (std::map< int, TH1D * > &htemp, std::string namesfx)
	Draw dE/dx per run histogram canvas.

void	printCanvas (std::vector< TH1D * > &htemp, std::string namesfx, std::string svar)
	Draw dE/dx histograms across bins.

void	fitGaussianWRange (TH1D *&temphist, std::string &status)
	Perform Gaussian fit with range on a histogram.

void	getExpRunInfo ()
	function to get extract calibration run/exp

void	defineHisto (std::vector< TH1D * > &htemp, std::string var, std::string stype)
	Define dE/dx histograms for plotting.

void	wireGain (std::vector< TH1D * > &hdedxhit)
	Validate wire gain data using dE/dx histograms.

void	printCanvasWire (std::vector< TH1D * > temp, std::string namesfx, const std::vector< double > &vdedx_mean)
	Plot dE/dx vs wire number.

void	fit (TH1D *&hist, double &mean, double &meanErr, double &sigma, double &sigmaErr)
	Perform full Gaussian fit and extract parameters.

void	bhabhaValidation ()
	Validate dE/dx using bhabha sample (vs run, cosine)

void	radeeValidation ()
	Validate dE/dx using radee sample (vs momentum, injection time)

void	defineTimeBins (std::vector< double > &vtlocaledges)
	Set bin edges for injection time.

void	printCanvasdEdx (std::array< std::vector< TH1D * >, 2 > &htemp, std::string namesfx, std::string svar)
	Draw dE/dx histograms for momentum and cosine bins.

std::string	getTimeBinLabel (const double &tedges, const int &it)
	Get time bin label string.

void	setTestingPayload (const std::string &testingPayloadName)
	Set testing payload name.

void	setGlobalTag (const std::string &globalTagName)
	Set Global Tag name.

void	setTextCosmetics (TPaveText pt, Color_t color)
	Set text cosmetics for TPaveText.

void	plotEventStats ()
	Plot summary statistics of selected events.

void	DatabaseIN (int experiment, int run)
	Load database payload for given run.

WireGainData	getwiregain (int experiment, int run)
	Retrieve wire gain data from DB.

CosGainData	getcosgain (int experiment, int run)
	Retrieve cosine gain data from DB.

OnedData	getonedgain (int experiment, int run)
	Retrieve 1D gain data from DB.

double	getrungain (int experiment, int run)
	Retrieve run gain data from DB.

void	resetDatabase ()
	Clear current DB pointers and state.

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::DBImportQuery >	getPayloadValues ()
	Get constants (in TObjects) for database update from last execution but passed by VALUE.

bool	commit ()
	Submit constants from last calibration into database.

bool	commit (std::list< Database::DBImportQuery > payloads)
	Submit constants from a (potentially previous) set of payloads.

const std::string &	getDescription () const
	Get the description of the algorithm (set by developers in constructor)

bool	loadInputJson (const std::string &jsonString)
	Load the m_inputJson variable from a string (useful from Python interface). The return bool indicates success or failure.

const std::string	dumpOutputJson () const
	Dump the JSON string of the output JSON object.

const std::vector< Calibration::ExpRun >	findPayloadBoundaries (std::vector< Calibration::ExpRun > runs, int iteration=0)
	Used to discover the ExpRun boundaries that you want the Python CAF to execute on. This is optional and only used in some.

template<>
std::shared_ptr< TTree >	getObjectPtr (const std::string &name, const std::vector< Calibration::ExpRun > &requestedRuns)
	Specialization of getObjectPtr<TTree>.

Protected Member Functions
virtual EResult	calibrate () override
	Main calibration method.

void	setInputFileNames (std::vector< std::string > inputFileNames)
	Set the input file names used for this algorithm.

virtual bool	isBoundaryRequired (const Calibration::ExpRun &)
	Given the current collector data, make a decision about whether or not this run should be the start of a payload boundary.

virtual void	boundaryFindingSetup (std::vector< Calibration::ExpRun >, int)
	If you need to make some changes to your algorithm class before 'findPayloadBoundaries' is run, make them in this function.

virtual void	boundaryFindingTearDown ()
	Put your algorithm back into a state ready for normal execution if you need to.

const std::vector< Calibration::ExpRun > &	getRunList () const
	Get the list of runs for which calibration is called.

int	getIteration () const
	Get current iteration.

std::vector< std::string >	getVecInputFileNames () const
	Get the input file names used for this algorithm as a STL vector.

template<class T>
std::shared_ptr< T >	getObjectPtr (const std::string &name, const std::vector< Calibration::ExpRun > &requestedRuns)
	Get calibration data object by name and list of runs, the Merge function will be called to generate the overall object.

template<class T>
std::shared_ptr< T >	getObjectPtr (std::string name)
	Get calibration data object (for all runs the calibration is requested for) This function will only work during or after execute() has been called once.

template<>
shared_ptr< TTree >	getObjectPtr (const string &name, const vector< ExpRun > &requestedRuns)
	We cheekily cast the TChain to TTree for the returned pointer so that the user never knows Hopefully this doesn't cause issues if people do low level stuff to the tree...

std::string	getGranularityFromData () const
	Get the granularity of collected data.

void	saveCalibration (TClonesArray *data, const std::string &name)
	Store DBArray payload with given name with default IOV.

void	saveCalibration (TClonesArray *data, const std::string &name, const IntervalOfValidity &iov)
	Store DBArray with given name and custom IOV.

void	saveCalibration (TObject *data)
	Store DB payload with default name and default IOV.

void	saveCalibration (TObject *data, const IntervalOfValidity &iov)
	Store DB payload with default name and custom IOV.

void	saveCalibration (TObject *data, const std::string &name)
	Store DB payload with given name with default IOV.

void	saveCalibration (TObject *data, const std::string &name, const IntervalOfValidity &iov)
	Store DB payload with given name and custom IOV.

void	updateDBObjPtrs (const unsigned int event, const int run, const int experiment)
	Updates any DBObjPtrs by calling update(event) for DBStore.

void	setDescription (const std::string &description)
	Set algorithm description (in constructor)

void	clearCalibrationData ()
	Clear calibration data.

Calibration::ExpRun	getAllGranularityExpRun () const
	Returns the Exp,Run pair that means 'Everything'. Currently unused.

void	resetInputJson ()
	Clears the m_inputJson member variable.

void	resetOutputJson ()
	Clears the m_outputJson member variable.

template<class T>
void	setOutputJsonValue (const std::string &key, const T &value)
	Set a key:value pair for the outputJson object, expected to used internally during calibrate()

template<class T>
const T	getOutputJsonValue (const std::string &key) const
	Get a value using a key from the JSON output object, not sure why you would want to do this.

template<class T>
const T	getInputJsonValue (const std::string &key) const
	Get an input JSON value using a key. The normal exceptions are raised when the key doesn't exist.

const nlohmann::json &	getInputJsonObject () const
	Get the entire top level JSON object. We explicitly say this must be of object type so that we might pick.

bool	inputJsonKeyExists (const std::string &key) const
	Test for a key in the input JSON object.

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

Private Member Functions
std::string	getExpRunString (Calibration::ExpRun &expRun) const
	Gets the "exp.run" string repr. of (exp,run)

std::string	getFullObjectPath (const std::string &name, Calibration::ExpRun expRun) const
	constructs the full TDirectory + Key name of an object in a TFile based on its name and exprun

Private Attributes
double	m_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_cosBins
	bins for cosine

double	m_cosMin
	min range of cosine

double	m_cosMax
	max range of cosine

int	m_momBins
	bins for momentum

double	m_momMin
	min range of momentum

double	m_momMax
	max range of momentum

double *	m_tedges
	internal time array (copy of vtlocaledges)

unsigned int	m_tbins
	internal time bins

int	m_eaBin

double	m_eaMin
	lower edge of entrance angle

double	m_eaMax
	upper edge of entrance angle

std::array< std::string, 2 >	m_sring {"ler", "her"}
	injection ring name

std::string	m_suffix
	suffix string to separate plots

DBObjPtr< CDCGeometry >	m_cdcGeo
	Geometry of CDC.

std::string	m_testingPayloadName = ""
	Testing payload location.

std::string	m_GlobalTagName = ""
	Global Tag name.

StoreObjPtr< EventMetaData >	m_EventMetaData
	Event metadata.

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 validation algorithm for CDC dE/dx electron.

Definition at line 86 of file CDCDedxValidationAlgorithm.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

◆ CDCDedxValidationAlgorithm()

CDCDedxValidationAlgorithm ( )

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

Definition at line 37 of file CDCDedxValidationAlgorithm.cc.

                                                       :
  CalibrationAlgorithm("ElectronValCollector"),
  m_sigmaR(2.0),
  m_dedxBins(600),
  m_dedxMin(0.0),
  m_dedxMax(5.0),
  m_cosBins(100),
  m_cosMin(-1.0),
  m_cosMax(1.0),
  m_momBins(80),
  m_momMin(0.0),
  m_momMax(8.0),
  m_eaBin(316),
  m_eaMin(-TMath::Pi() / 2),
  m_eaMax(+TMath::Pi() / 2),
  m_suffix("")
{
  // Set module properties
  setDescription("A validation algorithm for CDC dE/dx electron");
}

◆ ~CDCDedxValidationAlgorithm()

virtual ~CDCDedxValidationAlgorithm ( )

inlinevirtual

Destructor.

Definition at line 98 of file CDCDedxValidationAlgorithm.h.

98{}

Member Function Documentation

◆ bhabhaValidation()

void bhabhaValidation ( )

Validate dE/dx using bhabha sample (vs run, cosine)

Definition at line 251 of file CDCDedxValidationAlgorithm.cc.

{
  auto ttree = getObjectPtr<TTree>("tBhabha");
 
  double dedx, costh;
  int run, charge;
 
  std::vector<int>* wire = 0;
  ttree->SetBranchAddress("wire", &wire);
 
  std::vector<double>* dedxhit = 0;
  ttree->SetBranchAddress("dedxhit", &dedxhit);
 
  ttree->SetBranchAddress("dedx", &dedx);
  ttree->SetBranchAddress("run", &run);
  ttree->SetBranchAddress("charge", &charge);
  ttree->SetBranchAddress("costh", &costh);
 
  std::map<int, TH1D*> hdedx_run;
  std::array<std::vector<TH1D*>, 3> hdedx_cos;
  std::array<std::vector<TH1D*>, 2> hdedx_cos_peaks;
  std::vector<TH1D*> hdedxhit(c_nSenseWires);
 
  const double cosBinWidth = (m_cosMax - m_cosMin) / m_cosBins;
  const double cosBinW = (m_cosMax - m_cosMin) / 4;
 
  std::string stype[3] = {"all", "posi", "elec"};
 
  for (int it = 0; it < 3; ++it) {
    hdedx_cos[it].resize(m_cosBins);
    defineHisto(hdedx_cos[it], "costh", stype[it]);
  }
 
  for (int ir = 0; ir < 2; ir++) {
    hdedx_cos_peaks[ir].resize(4);
    defineHisto(hdedx_cos_peaks[ir], "cos_peaks", Form("%s", stype[ir + 1].data()));
  }
 
  defineHisto(hdedxhit, "wire", "wire");
 
  // Loop over all the entries in the tree
  for (int i = 0; i < ttree->GetEntries(); ++i) {
    ttree->GetEvent(i);
    if (dedx <= 0) continue;
 
    // Check if a dE/dx histogram for this run number already exists
    if (hdedx_run.find(run) == hdedx_run.end()) {
      std::string histName = Form("hist_dedx_run_%d", run);
      std::string histTitle = Form("dE/dx Histogram for Run %d", run);
      hdedx_run[run] = new TH1D(histName.data(), histTitle.data(), m_dedxBins, m_dedxMin, m_dedxMax);
    }
 
    // Fill run-specific histogram
    hdedx_run[run]->Fill(dedx);
 
    // Fill cos(theta) histograms (all charge + by charge sign)
    int binIndex = static_cast<int>((costh - m_cosMin) / cosBinWidth);
    if (binIndex >= 0 && binIndex < m_cosBins) {
      hdedx_cos[0][binIndex]->Fill(dedx);  // All charge
 
      if (charge > 0)
        hdedx_cos[1][binIndex]->Fill(dedx);
      else if (charge < 0)
        hdedx_cos[2][binIndex]->Fill(dedx);
    }
 
    // Fill dE/dx for each wire hit
    for (unsigned int j = 0; j < wire->size(); ++j) {
      int jwire = wire->at(j);
      double jhitdedx = dedxhit->at(j);
      hdedxhit[jwire]->Fill(jhitdedx);
    }
 
    // Fill cos(theta) peaks histograms
    int binI = static_cast<int>((costh - m_cosMin) / cosBinW);
    if (binI >= 0 && binI < 4) {
      if (charge > 0)
        hdedx_cos_peaks[0][binI]->Fill(dedx);
      else if (charge < 0)
        hdedx_cos_peaks[1][binI]->Fill(dedx);
    }
  }
 
  printCanvasRun(hdedx_run, Form("plots/run/dedx_vs_run_%s", m_suffix.data()));
  printCanvas(hdedx_cos[0], Form("plots/costh/dedx_vs_cos_all_%s", m_suffix.data()), "costh");
  printCanvas(hdedx_cos[1], Form("plots/costh/dedx_vs_cos_positrons_%s", m_suffix.data()), "costh");
  printCanvas(hdedx_cos[2], Form("plots/costh/dedx_vs_cos_electrons_%s", m_suffix.data()), "costh");
  printCanvasdEdx(hdedx_cos_peaks, Form("plots/costh/dedxpeaks_vs_cos_%s", m_suffix.data()), "costh");
  wireGain(hdedxhit);
}

◆ boundaryFindingSetup()

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

inlineprotectedvirtualinherited

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

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

Definition at line 252 of file CalibrationAlgorithm.h.

252{};

◆ boundaryFindingTearDown()

virtual void boundaryFindingTearDown ( )

inlineprotectedvirtualinherited

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

Definition at line 257 of file CalibrationAlgorithm.h.

257{};

◆ calibrate()

CalibrationAlgorithm::EResult calibrate ( )

overrideprotectedvirtual

Main calibration method.

Implements CalibrationAlgorithm.

Definition at line 62 of file CDCDedxValidationAlgorithm.cc.

{
 
  getExpRunInfo();
 
  std::vector<std::string> subdirs = {"run", "costh", "mom", "wire", "injection", "oneD"};
  for (const auto& dir : subdirs) {
    gSystem->Exec(Form("mkdir -p plots/%s", dir.c_str()));
  }
 
  // Get data objects
  auto tBhabha = getObjectPtr<TTree>("tBhabha");
 
  // require at least 100 tracks
  if (tBhabha->GetEntries() < 100) return c_NotEnoughData;
 
  // Get data objects
  auto tRadee = getObjectPtr<TTree>("tRadee");
 
  // require at least 100 tracks
  if (tRadee->GetEntries() < 100) return c_NotEnoughData;
 
  bhabhaValidation();
  radeeValidation();
  plotEventStats();
  return c_OK;
}

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

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

◆ clearCalibrationData()

void clearCalibrationData ( )

inlineprotectedinherited

Clear calibration data.

Definition at line 324 of file CalibrationAlgorithm.h.

324{m_data.clearCalibrationData();}

◆ commit() [1/2]

bool commit ( )

inherited

Submit constants from last calibration into database.

Definition at line 302 of file CalibrationAlgorithm.cc.

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

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

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

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

◆ DatabaseIN()

void DatabaseIN	(	int	experiment,
		int	run )

Load database payload for given run.

Parameters

experiment	Experiment number
run	Run number

Definition at line 833 of file CDCDedxValidationAlgorithm.cc.

{
  if (m_EventMetaData.isValid()) {
    m_EventMetaData->setExperiment(experiment);
    m_EventMetaData->setRun(run);
  }
 
  auto& dbConfiguration = Conditions::Configuration::getInstance();
  dbConfiguration.setGlobalTags({"online"});
  if (!m_testingPayloadName.empty() && m_GlobalTagName.empty()) {
    dbConfiguration.prependTestingPayloadLocation(m_testingPayloadName);
  } else if (m_testingPayloadName.empty() && !m_GlobalTagName.empty()) {
    dbConfiguration.prependGlobalTag(m_GlobalTagName);
  } else
    B2FATAL("Setting both testing payload and Global Tag or setting no one of them.");
 
  /* Mimic a module initialization. */
  DataStore::Instance().setInitializeActive(true);
  m_EventMetaData.registerInDataStore();
  DataStore::Instance().setInitializeActive(false);
  if (!m_EventMetaData.isValid())
    m_EventMetaData.construct(1, run, experiment);
 
  /* Database instance and configuration. */
  DBStore& dbStore = DBStore::Instance();
  dbStore.update();
  dbStore.updateEvent();
}

◆ defineHisto()

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

Define dE/dx histograms for plotting.

Parameters

htemp	Vector to hold histograms
var	Variable name
stype	charge type

Definition at line 343 of file CDCDedxValidationAlgorithm.cc.

{
  int xbins;
  double xmin, xmax;
  double binWidth = 0.0;
 
  if (var == "mom") {
    xbins = m_momBins; xmin = m_momMin; xmax = m_momMax;
  } else if (var == "oned") {
    xbins = m_eaBin; xmin = m_eaMin; xmax = m_eaMax; m_dedxBins = 250;
  } else if (var == "costh") {
    xbins = m_cosBins; xmin = m_cosMin; xmax = m_cosMax;
  } else if (var == "inj") {
    xbins  = m_tbins;
  } else if (var == "mom_peaks") {
    xbins = 4; xmin = m_momMin; xmax = 4.0;
  }  else if (var == "cos_peaks") {
    xbins = 4; xmin = m_cosMin; xmax = m_cosMax;
  }  else {
    xbins = c_nSenseWires; m_dedxBins = 250;
  }
 
  if (var == "costh" || var == "mom" || var == "mom_peaks" || var == "cos_peaks" || var == "oned") {
    binWidth = (xmax - xmin) / xbins;
  }
 
  for (int ic = 0; ic < xbins; ic++) {
    std::string title = Form("dedxhit-dist, wire:%d", ic);
    std::string name = Form("hdedx_%s_%d", var.data(), ic);
 
    if (var == "costh" || var == "mom" || var == "mom_peaks" || var == "cos_peaks" || var == "oned") {
      double min = ic * binWidth + xmin;
      double max = min + binWidth;
      title = Form("%s: (%0.02f, %0.02f) %s", var.data(), min, max, stype.data());
      name = Form("hdedx_%s_%s_%d", var.data(), stype.data(), ic);
    } else if (var == "inj") {
      std::string label = getTimeBinLabel(m_tedges[ic], ic);
      title = Form("%s, time(%s)", stype.data(), label.data());
      name = Form("h%s_%s_t%d", var.data(), stype.data(), ic);
    }
    htemp[ic] = new TH1D(name.data(), "", m_dedxBins, m_dedxMin, m_dedxMax);
    htemp[ic]->SetTitle(Form("%s;dedx;entries", title.data()));
  }
}

◆ defineTimeBins()

void defineTimeBins ( std::vector< double > & vtlocaledges )

Set bin edges for injection time.

Parameters

vtlocaledges Vector of time bin edges

Definition at line 792 of file CDCDedxValidationAlgorithm.cc.

{
  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;
    vtlocaledges.push_back(fixedges[ib]);
  }
}

◆ dumpOutputJson()

const std::string dumpOutputJson ( ) const

inlineinherited

Dump the JSON string of the output JSON object.

Definition at line 223 of file CalibrationAlgorithm.h.

223{return m_jsonExecutionOutput.dump();}

◆ execute() [1/2]

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

inherited

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

Definition at line 83 of file CalibrationAlgorithm.cc.

{
  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 330 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 520 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;
}

◆ fit()

void fit	(	TH1D *&	hist,
		double &	mean,
		double &	meanErr,
		double &	sigma,
		double &	sigmaErr )

Perform full Gaussian fit and extract parameters.

Parameters

hist	Histogram to fit
mean	Fitted mean
meanErr	Error on the mean
sigma	Fitted sigma
sigmaErr	Error on the sigma

Definition at line 565 of file CDCDedxValidationAlgorithm.cc.

{
 
  std::string status = "";
 
  if (hist->Integral() > 100)
    fitGaussianWRange(hist, status);
 
  if (status != "fitOK") {
    hist->SetFillColor(kOrange);
    mean = 0.0, meanErr = 0.0, sigma = 0.0, sigmaErr = 0.0;
  } else {
    mean = hist->GetFunction("gaus")->GetParameter(1);
    meanErr = hist->GetFunction("gaus")->GetParError(1);
    sigma = hist->GetFunction("gaus")->GetParameter(2);
    sigmaErr = hist->GetFunction("gaus")->GetParError(2);
    hist->SetFillColor(kYellow);
  }
}

◆ fitGaussianWRange()

void fitGaussianWRange	(	TH1D *&	temphist,
		std::string &	status )

Perform Gaussian fit with range on a histogram.

Parameters

temphist	Histogram to fit
status	Status string updated based on fit result

Definition at line 643 of file CDCDedxValidationAlgorithm.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()

Calibration::ExpRun getAllGranularityExpRun ( ) const

inlineprotectedinherited

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

Definition at line 327 of file CalibrationAlgorithm.h.

327{return m_allExpRun;}

◆ getCollectorName()

std::string getCollectorName ( ) const

inlineinherited

Alias for prefix.

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

Definition at line 164 of file CalibrationAlgorithm.h.

164{return getPrefix();}

◆ getcosgain()

CosGainData getcosgain	(	int	experiment,
		int	run )

Retrieve cosine gain data from DB.

Parameters

experiment	Experiment number
run	Run number

Returns: CosGainData structure

Definition at line 900 of file CDCDedxValidationAlgorithm.cc.

{
 
  DatabaseIN(experiment, run);
 
  std::vector<double> cosgain, cos;
 
  DBObjPtr<CDCDedxCosineCor> DBCosineCor;
  if (!DBCosineCor.isValid())  B2FATAL("Cosine gain data are not valid.");
 
  unsigned int nCosBins = DBCosineCor->getSize();
 
  for (unsigned int il = 0; il < nCosBins; ++il) {
    double costh = -1.0 + (il + 0.5) * 2.0 / nCosBins;
    costh += .000001;
    cosgain.push_back(DBCosineCor->getMean(il));
    cos.push_back(costh);
  }
 
  resetDatabase();
  return {cosgain, cos};
}

◆ getDescription()

const std::string & getDescription ( ) const

inlineinherited

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

Definition at line 216 of file CalibrationAlgorithm.h.

216{return m_description;}

◆ getExpRunInfo()

void getExpRunInfo ( )

function to get extract calibration run/exp

Definition at line 91 of file CDCDedxValidationAlgorithm.cc.

{
 
  int cruns = 0;
  for (auto expRun : getRunList()) {
    if (cruns == 0) B2INFO("start exp " << expRun.first << " and run " << expRun.second << "");
    cruns++;
  }
 
  const auto erStart = getRunList()[0];
  int estart = erStart.first;
  int rstart = erStart.second;
 
  updateDBObjPtrs(1, rstart, estart);
 
  if (m_suffix.length() > 0) m_suffix = Form("%s_e%d_r%d", m_suffix.data(), estart, rstart);
  else  m_suffix = Form("e%d_r%d", estart, rstart);
}

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

std::string getGranularity ( ) const

inlineinherited

Get the granularity of collected data.

Definition at line 188 of file CalibrationAlgorithm.h.

188{return m_granularityOfData;};

◆ getGranularityFromData()

string getGranularityFromData ( ) const

protectedinherited

Get the granularity of collected data.

Definition at line 383 of file CalibrationAlgorithm.cc.

{
  // Save TDirectory to change back at the end
  TDirectory* dir = gDirectory;
  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.

357{return m_jsonExecutionInput;}

◆ getInputJsonValue()

template<class T>

const T getInputJsonValue ( const std::string & key ) const

inlineprotectedinherited

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

Definition at line 350 of file CalibrationAlgorithm.h.

    {
      return m_jsonExecutionInput.at(key);
    }

◆ getIovFromAllData()

IntervalOfValidity getIovFromAllData ( ) const

inherited

Get the complete IoV from inspection of collected data.

Definition at line 325 of file CalibrationAlgorithm.cc.

{
  return getRunRangeFromAllData().getIntervalOfValidity();
}

◆ getIteration()

int getIteration ( ) const

inlineprotectedinherited

Get current iteration.

Definition at line 269 of file CalibrationAlgorithm.h.

269{ return m_data.getIteration(); }

◆ getObjectPtr()

template<class T>

std::shared_ptr< T > getObjectPtr ( std::string name )

inlineprotectedinherited

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

Definition at line 285 of file CalibrationAlgorithm.h.

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

◆ getonedgain()

OnedData getonedgain	(	int	experiment,
		int	run )

Retrieve 1D gain data from DB.

Parameters

experiment	Experiment number
run	Run number

Returns: OnedData structure

Definition at line 923 of file CDCDedxValidationAlgorithm.cc.

{
 
  DatabaseIN(experiment, run);
 
  std::vector<double> inner1D, outer1D, Enta;
 
  DBObjPtr<CDCDedx1DCell> DBOneDCell;
  if (!DBOneDCell.isValid())  B2FATAL("OneD cell gain data are not valid.");
 
  for (int i = 0; i < 2; i++) {
 
    unsigned int nBins = DBOneDCell->getNBins(i);
    double binSize = TMath::Pi() / nBins;
 
    for (unsigned int nbin = 0; nbin < nBins; nbin++) {
 
      double enta = (-1 * TMath::Pi() / 2.0) + binSize * nbin;
      if (i == 0) {
        Enta.push_back(enta);
        inner1D.push_back(DBOneDCell->getMean(0, nbin));
      } else
        outer1D.push_back(DBOneDCell->getMean(17, nbin));
    }
  }
  resetDatabase();
  return {inner1D, outer1D, Enta};
 
}

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

204{return m_data.getPayloads();}

◆ getPayloadValues()

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

inlineinherited

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

Definition at line 207 of file CalibrationAlgorithm.h.

207{return m_data.getPayloadValues();}

◆ getPrefix()

std::string getPrefix ( ) const

inlineinherited

Get the prefix used for getting calibration data.

Definition at line 146 of file CalibrationAlgorithm.h.

146{return m_prefix;}

◆ getrungain()

double getrungain	(	int	experiment,
		int	run )

Retrieve run gain data from DB.

Parameters

experiment	Experiment number
run	Run number

Returns: double

Definition at line 953 of file CDCDedxValidationAlgorithm.cc.

{
 
  DatabaseIN(experiment, run);
 
  DBObjPtr<CDCDedxRunGain> RunGain;
  if (!RunGain.isValid())  B2FATAL("Run gain data are not valid.");
  double gain = RunGain->getRunGain();
  return gain;
}

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

{
  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 361 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"));
    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

Get time bin label string.

Parameters

tedges	Time edge
it	Index of the bin

Returns: Formatted time bin label string

Definition at line 189 of file CDCDedxValidationAlgorithm.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()

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

◆ getwiregain()

WireGainData getwiregain	(	int	experiment,
		int	run )

Retrieve wire gain data from DB.

Parameters

experiment	Experiment number
run	Run number

Returns: WireGainData structure

Definition at line 862 of file CDCDedxValidationAlgorithm.cc.

{
 
  DatabaseIN(experiment, run);
 
  std::vector<double> wiregain;
  std::vector<double> layermean(c_maxNSenseLayers);
 
  DBObjPtr<CDCDedxWireGain> DBWireGains;
  if (!DBWireGains.isValid())  B2FATAL("Wire gain data are not valid.");
 
  CDCGeometryPar& cdcgeo = CDCGeometryPar::Instance(&(*m_cdcGeo));
 
  int jwire = -1;
  for (unsigned int il = 0; il < c_maxNSenseLayers; ++il) {
 
    int activewires = 0;
    layermean[il] = 0.0;
 
    for (unsigned int iw = 0; iw < cdcgeo.nWiresInLayer(il); ++iw) {
      jwire++;
 
      wiregain.push_back(DBWireGains->getWireGain(jwire));
 
      if (wiregain.at(jwire) > 0) {
        layermean[il] += wiregain.at(jwire);
        activewires++;
      }
    }
 
    if (activewires > 0) layermean[il] /= activewires;
    else layermean[il] = 1.0;
  }
 
  resetDatabase();
  return { wiregain, layermean };
}

◆ inputJsonKeyExists()

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

inlineprotectedinherited

Test for a key in the input JSON object.

Definition at line 360 of file CalibrationAlgorithm.h.

360{return m_jsonExecutionInput.count(key);}

◆ isBoundaryRequired()

virtual bool isBoundaryRequired ( const Calibration::ExpRun & )

inlineprotectedvirtualinherited

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

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

Definition at line 243 of file CalibrationAlgorithm.h.

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

◆ plotEventStats()

void plotEventStats ( )

Plot summary statistics of selected events.

Definition at line 807 of file CDCDedxValidationAlgorithm.cc.

{
 
  TCanvas cstats("cstats", "cstats", 800, 400);
  cstats.SetBatch(kTRUE);
  cstats.Divide(2, 1);
 
  cstats.cd(1);
  auto hestats = getObjectPtr<TH1I>("hestats");
  if (hestats) {
    hestats->SetName(Form("hestats_%s", m_suffix.data()));
    hestats->SetStats(0);
    hestats->DrawCopy("");
  }
 
  cstats.cd(2);
  auto htstats = getObjectPtr<TH1I>("htstats");
  if (htstats) {
    htstats->SetName(Form("htstats_%s", m_suffix.data()));
    htstats->SetStats(0);
    htstats->DrawCopy("");
  }
 
  cstats.Print(Form("cdcdedx_stats_%s.pdf", m_suffix.data()));
}

◆ printCanvas()

void printCanvas	(	std::vector< TH1D * > &	htemp,
		std::string	namesfx,
		std::string	svar )

Draw dE/dx histograms across bins.

Parameters

htemp	Vector of histograms
namesfx	Suffix to distinguish output
svar	Variable name for binning

Definition at line 475 of file CDCDedxValidationAlgorithm.cc.

{
  int xbins;
  double xmin, xmax;
 
  if (svar == "mom") {
    xbins = m_momBins; xmin = m_momMin; xmax = m_momMax;
  } else if (svar == "oned") {
    xbins = m_eaBin; xmin = m_eaMin; xmax = m_eaMax;
  } else if (svar == "costh") {
    xbins = m_cosBins; xmin = m_cosMin; xmax = m_cosMax;
  }  else if (svar == "inj") {
    xbins  = m_tbins;
  } else if (svar == "mom_peaks") {
    xbins = 4; xmin = m_momMin; xmax = 4.0;
  } else {
    B2FATAL("wrong input");
  }
 
  // Set up the TCanvas with 4x4 grid
  TCanvas* ctmp = new TCanvas("tmp", "tmp", 1200, 1200);
  ctmp->Divide(4, 4); // Divide into 4x4 grid
 
  // Prepare the PDF output
  std::stringstream psname;
  psname << Form("%s.pdf[", namesfx.data());
  ctmp->Print(psname.str().c_str());
  psname.str("");
  psname << Form("%s.pdf", namesfx.data());
 
  std::ofstream outFile;
  outFile.open(Form("%s.txt", namesfx.data()));
  CDCDedxWireGainAlgorithm wireg;
 
  // Iterate through the histograms and plot them in the canvas
  for (int i = 0; i < xbins; ++i) {
 
    ctmp->cd(i % 16 + 1);
    TPaveText pt(0.6, 0.73, 0.85, 0.89, "NBNDC");
    setTextCosmetics(pt, kBlack);
 
    if (svar == "oned") {
      unsigned int minbin, maxbin;
      wireg.getTruncatedBins(htemp[i], minbin, maxbin);
      htemp[i]->SetTitle(Form("dedxhit-dist, entabin: %d ;%d;%d", i, minbin, maxbin));
 
      double dedxmean  = wireg.getTruncationMean(htemp[i], minbin, maxbin);
 
      const double binWidth = (xmax - xmin) / xbins;
      double binCenter = xmin + (i + 0.5) * binWidth; // Calculate bin center for cos(theta) or mom
 
      outFile << binCenter << " " <<  dedxmean << std::endl;
    } else {
      double mean, meanErr, sigma, sigmaErr;
      fit(htemp[i], mean, meanErr, sigma, sigmaErr);
 
      if (svar == "mom" || svar == "costh" || svar == "mom_peaks") {
        const double binWidth = (xmax - xmin) / xbins;
        double binCenter = xmin + (i + 0.5) * binWidth; // Calculate bin center for cos(theta) or mom
 
        outFile << binCenter << " " <<  mean << " " << meanErr << " " << sigma << " " << sigmaErr << std::endl;
      } else {
        std::string label = getTimeBinLabel(m_tedges[i], i);
        outFile << i << " " << label << " " <<  mean << " " << meanErr << " " << sigma << " " << sigmaErr << std::endl;
      }
 
      pt.AddText(Form("#mu_{fit}: %0.03f#pm%0.03f", mean, meanErr));
      pt.AddText(Form("#sigma_{fit}: %0.03f#pm%0.03f", sigma, sigmaErr));
    }
    htemp[i]->SetStats(0);
    htemp[i]->DrawCopy("");
    pt.DrawClone("same");
 
    if ((i + 1) % 16 == 0 || ((i + 1) == xbins)) {
      ctmp->SetBatch(kTRUE);
      ctmp->Print(psname.str().c_str());
      ctmp->Clear("D");
    }
  }
 
  // ctmp->Print(psname.str().c_str());
  psname.str("");
  psname << Form("%s.pdf]", namesfx.data());
  ctmp->Print(psname.str().c_str());
 
  outFile.close();
 
  delete ctmp;
}

◆ printCanvasdEdx()

void printCanvasdEdx	(	std::array< std::vector< TH1D * >, 2 > &	htemp,
		std::string	namesfx,
		std::string	svar )

Draw dE/dx histograms for momentum and cosine bins.

Parameters

htemp	Array of vectors of histograms
namesfx	Suffix to distinguish output
svar	Variable name ("momentum" or "cosTheta")

Definition at line 388 of file CDCDedxValidationAlgorithm.cc.

{
  int xbins = 4;
  double xmin, xmax;
 
  if (svar == "mom") {
    xmin = m_momMin; xmax = 4.0;
  } else if (svar == "costh") {
    xmin = m_cosMin; xmax = m_cosMax;
  } else {
    B2FATAL("wrong input");
  }
  double binWidth = (xmax - xmin) / xbins;
 
  // Set up the TCanvas with 2x2 grid
  TCanvas* ctmp = new TCanvas("tmp", "tmp", 1200, 1200);
  ctmp->Divide(2, 2); // Divide into 2x2 grid
 
  // Prepare the PDF output
  std::stringstream psname;
  psname << Form("%s.pdf[", namesfx.data());
  ctmp->Print(psname.str().c_str());
  psname.str("");
  psname << Form("%s.pdf", namesfx.data());
 
  // Iterate through the histograms and plot them in the canvas
  for (int i = 0; i < xbins; ++i) {
 
    ctmp->cd(i % 4 + 1);
 
    double emean, emeanErr, esigma, esigmaErr;
    double pmean, pmeanErr, psigma, psigmaErr;
 
    fit(htemp[0][i], emean, emeanErr, esigma, esigmaErr);
    fit(htemp[1][i], pmean, pmeanErr, psigma, psigmaErr);
 
    double min = i * binWidth + xmin;
    double max = min + binWidth;
 
    TPaveText pt(0.6, 0.63, 0.85, 0.89, "NBNDC");
    setTextCosmetics(pt, kBlack);
    pt.AddText("e+");
    pt.AddText(Form("#mu_{fit}: %0.03f#pm%0.03f", emean, emeanErr));
    pt.AddText(Form("#sigma_{fit}: %0.03f#pm%0.03f", esigma, esigmaErr));
 
    pt.AddText("e-");
    pt.AddText(Form("#mu_{fit}: %0.03f#pm%0.03f", pmean, pmeanErr));
    pt.AddText(Form("#sigma_{fit}: %0.03f#pm%0.03f", psigma, psigmaErr));
 
    htemp[0][i]->SetStats(0);
    htemp[1][i]->SetStats(0);
    htemp[0][i]->SetFillColor(0);
    htemp[1][i]->SetFillColor(0);
    htemp[0][i]->SetLineColor(8);
    htemp[1][i]->SetLineColor(9);
    htemp[0][i]->SetTitle(Form("%s: (%0.02f, %0.02f)", svar.data(), min, max));
    if (htemp[0][i]->GetEntries() > 0)
      htemp[0][i]->Scale(1.0 / htemp[0][i]->GetEntries());
    if (htemp[1][i]->GetEntries() > 0)
      htemp[1][i]->Scale(1.0 / htemp[1][i]->GetEntries());
 
    if (htemp[1][i]->GetMaximum() > htemp[0][i]->GetMaximum())
      htemp[0][i]->SetMaximum(htemp[1][i]->GetMaximum());
 
    htemp[0][i]->DrawCopy("HIST");
    htemp[1][i]->DrawCopy("same HIST");
    pt.DrawClone("same");
 
    TLegend* lego = new TLegend(0.15, 0.67, 0.3, 0.8);
    lego->AddEntry(htemp[0][i], "e+", "l");
    lego->AddEntry(htemp[1][i], "e-", "l");
    lego->Draw("same");
 
    if ((i + 1) % 4 == 0 || i == xbins - 1) {
      ctmp->SetBatch(kTRUE);
      ctmp->Print(psname.str().c_str());
      if ((i + 1) % 4 == 0) ctmp->Clear("D");
    }
  }
 
  psname.str("");
  psname << Form("%s.pdf]", namesfx.data());
  ctmp->Print(psname.str().c_str());
 
  delete ctmp;
}

◆ printCanvasRun()

void printCanvasRun	(	std::map< int, TH1D * > &	htemp,
		std::string	namesfx )

Draw dE/dx per run histogram canvas.

Parameters

htemp	Histogram map (run number -> TH1D pointer)
namesfx	Suffix to distinguish output

Definition at line 585 of file CDCDedxValidationAlgorithm.cc.

{
  // Set up the TCanvas with 4x4 grid
  TCanvas* ctmp = new TCanvas("tmp", "tmp", 1200, 1200);
  ctmp->Divide(4, 4); // Divide into 4x4 grid
 
  // Prepare the PDF output
  std::stringstream psname;
  psname << Form("%s.pdf[", namesfx.data());
  ctmp->Print(psname.str().c_str());
  psname.str("");
  psname << Form("%s.pdf", namesfx.data());
 
  std::ofstream outFile;
  outFile.open(Form("%s.txt", namesfx.data()));
 
  // Iterate through the histograms and plot them in the canvas
  int irun = 0;
  for (const auto& entry : htemp) {
    int run = entry.first;
    TH1D* hist = entry.second;
 
    ctmp->cd(irun % 16 + 1);
 
    TPaveText pt(0.6, 0.73, 0.85, 0.89, "NBNDC");
    setTextCosmetics(pt, kBlack);
 
    double mean, meanErr, sigma, sigmaErr;
    fit(hist, mean, meanErr, sigma, sigmaErr);
 
    outFile << run << " " <<  mean << " " << meanErr << " " << sigma << " " << sigmaErr << std::endl;
 
    pt.AddText(Form("#mu_{fit}: %0.03f#pm%0.03f", mean, meanErr));
    pt.AddText(Form("#sigma_{fit}: %0.03f#pm%0.03f", sigma, sigmaErr));
 
    hist->SetStats(0);
    hist->DrawCopy("");
    pt.DrawClone("same");
 
    if ((irun + 1) % 16 == 0 || irun == int(htemp.size() - 1)) {
      ctmp->SetBatch(kTRUE);
      ctmp->Print(psname.str().c_str());
      ctmp->Clear("D");
    }
    irun++;
  }
 
  ctmp->Print(psname.str().c_str());
  psname.str("");
  psname << Form("%s.pdf]", namesfx.data());
  ctmp->Print(psname.str().c_str());
 
  outFile.close();
 
  delete ctmp;
}

◆ printCanvasWire()

void printCanvasWire	(	std::vector< TH1D * >	temp,
		std::string	namesfx,
		const std::vector< double > &	vdedx_mean )

Plot dE/dx vs wire number.

Parameters

temp	Vector of histograms
namesfx	Suffix to distinguish output
vdedx_mean	Vector of mean dE/dx values

Definition at line 750 of file CDCDedxValidationAlgorithm.cc.

{
  TCanvas* ctmp = new TCanvas("tmp", "tmp", 900, 900);
  ctmp->Divide(4, 4);
 
  std::stringstream psname;
  psname << Form("%s.pdf[", namesfx.data());
  ctmp->Print(psname.str().c_str());
  psname.str("");
  psname << Form("%s.pdf", namesfx.data());
 
  for (unsigned int ip = 0; ip < c_nwireCDC; ip++) {
    int minbin = std::stoi(temp[ip]->GetXaxis()->GetTitle());
    int maxbin = std::stoi(temp[ip]->GetYaxis()->GetTitle());
    temp[ip]->SetFillColor(kYellow - 9);
    temp[ip]->SetTitle(Form("%s, #mu_{trunc} %0.03f;dedxhit;entries", temp[ip]->GetTitle(), vdedx_mean.at(ip)));
 
    ctmp->cd(ip % 16 + 1);
    gPad->cd();
    temp[ip]->DrawCopy("hist");
    TH1D* hdedxhitC = (TH1D*)temp[ip]->Clone(Form("%sC", temp[ip]->GetName()));
    hdedxhitC->GetXaxis()->SetRange(minbin, maxbin);
    hdedxhitC->SetFillColor(kAzure + 1);
    hdedxhitC->DrawCopy("same histo");
 
    if ((ip + 1) % 16 == 0) {
      ctmp->SetBatch(kTRUE);
      ctmp->Print(psname.str().c_str());
      ctmp->Clear("D");
    }
    delete temp[ip];
    delete hdedxhitC;
 
  }
 
  psname.str("");
  psname << Form("%s.pdf]",  namesfx.data());
  ctmp->Print(psname.str().c_str());
  delete ctmp;
}

◆ radeeValidation()

void radeeValidation ( )

Validate dE/dx using radee sample (vs momentum, injection time)

Definition at line 111 of file CDCDedxValidationAlgorithm.cc.

{
  auto ttree = getObjectPtr<TTree>("tRadee");
 
  double dedx, costh, p, injtime = 0.0, injring = 1.0;
  int charge;
 
  std::vector<double>* dedxhit = 0, *enta = 0;
  std::vector<int>* layer = 0;
 
  ttree->SetBranchAddress("dedx", &dedx);
  ttree->SetBranchAddress("p", &p);
  ttree->SetBranchAddress("costh", &costh);
  ttree->SetBranchAddress("charge", &charge);
  ttree->SetBranchAddress("injtime", &injtime);
  ttree->SetBranchAddress("injring", &injring);
  ttree->SetBranchAddress("dedxhit", &dedxhit);
  ttree->SetBranchAddress("entaRS", &enta);
  ttree->SetBranchAddress("layer", &layer);
 
  std::vector<double> vtlocaledges;
  defineTimeBins(vtlocaledges);
  m_tbins = vtlocaledges.size() - 1;
  m_tedges = &vtlocaledges[0];
 
  std::array<std::array<std::vector<TH1D*>, 2>, 13> hdedx_mom;
  std::array<std::vector<TH1D*>, 2> hdedx_mom_peaks, hdedx_inj, hdedx_oned;
  TH1D* htimes = new TH1D("htimes", "", m_tbins, m_tedges);
 
  const double momBinWidth = (m_momMax - m_momMin) / m_momBins;
  const double momBinW = (4.0 - m_momMin) / 4;
 
  std::string scos[13] = {"acos", "cos#theta > 0.0", "cos#theta < 0.0", "cos#theta <= -0.8",
                          "cos#theta > -0.8 and cos#theta <= -0.6",
                          "cos#theta > -0.6 and cos#theta <= -0.4", "cos#theta > -0.4 and cos#theta <= -0.2",
                          "cos#theta > -0.2 and cos#theta <= 0", "cos#theta > 0 and cos#theta <= 0.2",
                          "cos#theta > 0.2 and cos#theta <= 0.4", "cos#theta > 0.4 and cos#theta <= 0.6",
                          "cos#theta > 0.6 and cos#theta <= 0.8", "cos#theta > 0.8"
                         };
  std::string stype[2] = {"posi", "elec"};
  std::string sLayer[2] = {"IL", "OL"};
 
  // Define histograms for momentum bins and charge types
  for (int ic = 0; ic < 13; ic++) {
    for (int it = 0; it < 2; ++it) {
      hdedx_mom[ic][it].resize(m_momBins);
      defineHisto(hdedx_mom[ic][it], "mom", Form("%d_%s", ic, stype[it].data()));
    }
  }
 
  // Define histograms for injection time bins and rings
  for (unsigned int ir = 0; ir < 2; ir++) {
    hdedx_inj[ir].resize(m_tbins);
    hdedx_mom_peaks[ir].resize(4);
    hdedx_oned[ir].resize(m_eaBin);
 
    defineHisto(hdedx_inj[ir], "inj", m_sring[ir].data());
    defineHisto(hdedx_mom_peaks[ir], "mom_peaks", Form("%s", stype[ir].data()));
    defineHisto(hdedx_oned[ir], "oned", Form("%s", sLayer[ir].data()));
  }
 
  double eaBW = (m_eaMax - m_eaMin) / m_eaBin;
  double icos[3] = {0, -1, -1};
  double chgtype;
 
  // Loop over all the entries in the tree
  for (int i = 0; i < ttree->GetEntries(); ++i) {
    ttree->GetEvent(i);
 
    // Skip invalid events
    if (dedx <= 0 || injtime < 0 || injring < 0) continue;
 
    // Calculate momentum bin index for hdedx_mom
    int binIndex = static_cast<int>((abs(p) - m_momMin) / momBinWidth);
 
    // Determine cos(theta) category
 
    icos[1] = (costh > 0) ? 1 : 2;
    icos[2] = int((costh + 1.0) / 0.2) + 3;
    if (icos[2] < 3)  icos[2] = 3;
    if (icos[2] > 12) icos[2] = 12;
 
    // Determine charge type
    chgtype = (charge > 0) ? 0 : 1;
 
    // Fill momentum histograms (only if binIndex is valid)
    if (binIndex >= 0 && binIndex < m_momBins) {
      hdedx_mom[icos[0]][chgtype][binIndex]->Fill(dedx);
      hdedx_mom[icos[1]][chgtype][binIndex]->Fill(dedx);
      hdedx_mom[icos[2]][chgtype][binIndex]->Fill(dedx);
    }
 
    // Add larger times to the last bin
    if (injtime > m_tedges[m_tbins]) injtime = m_tedges[m_tbins] - 10.0;
 
    // Injection ring type
    int wr = (injring > 0.5) ? 1 : 0;
 
    // Injection time bin
    unsigned int tb = htimes->GetXaxis()->FindBin(injtime);
    tb = std::min(tb, static_cast<unsigned int>(m_tbins)) - 1;
 
    // Fill injection time and dE/dx histograms
    htimes->Fill(injtime);
    hdedx_inj[wr][tb]->Fill(dedx);
 
    // Fill hdedx_mom_peaks with its own binning
    int binI = static_cast<int>((abs(p) - m_momMin) / momBinW);
    if (binI >= 0 && binI < 4) {
      hdedx_mom_peaks[chgtype][binI]->Fill(dedx);
    }
 
    // Fill dE/dx in enta bins from hits
    for (unsigned int j = 0; j < dedxhit->size(); ++j) {
      if (dedxhit->at(j) == 0) continue;
 
      double entaval = enta->at(j);
      int ibin = std::floor((entaval - m_eaMin) / eaBW);
      if (ibin < 0 || ibin >= m_eaBin) continue;
 
      int mL = (layer->at(j) < 8) ? 0 : 1;
      hdedx_oned[mL][ibin]->Fill(dedxhit->at(j));
    }
  }
 
 
  for (int ic = 0; ic < 13; ic++) {
    for (int it = 0; it < 2; ++it) {
      printCanvas(hdedx_mom[ic][it], Form("plots/mom/dedx_vs_mom_%d_%s_%s", ic, stype[it].data(), m_suffix.data()), "mom");
    }
  }
  for (int it = 0; it < 2; ++it) {
    printCanvas(hdedx_inj[it], Form("plots/injection/dedx_vs_inj_%s_%s", m_sring[it].data(), m_suffix.data()), "inj");
    printCanvas(hdedx_oned[it], Form("plots/oneD/dedx_vs_1D_%s_%s", sLayer[it].data(), m_suffix.data()), "oned");
  }
 
  printCanvasdEdx(hdedx_mom_peaks, Form("plots/mom/dedxpeaks_vs_mom_%s", m_suffix.data()), "mom");
 
}

◆ resetDatabase()

void resetDatabase ( )

Clear current DB pointers and state.

Definition at line 964 of file CDCDedxValidationAlgorithm.cc.

{
  /* Reset both DataStore and Database. */
  DataStore::Instance().reset();
  Database::Instance().reset(false);
  DBStore::Instance().reset(false);
}

◆ resetInputJson()

void resetInputJson ( )

inlineprotectedinherited

Clears the m_inputJson member variable.

Definition at line 330 of file CalibrationAlgorithm.h.

330{m_jsonExecutionInput.clear();}

◆ resetOutputJson()

void resetOutputJson ( )

inlineprotectedinherited

Clears the m_outputJson member variable.

Definition at line 333 of file CalibrationAlgorithm.h.

333{m_jsonExecutionOutput.clear();}

◆ saveCalibration() [1/6]

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

protectedinherited

Store DBArray payload with given name with default IOV.

Definition at line 297 of file CalibrationAlgorithm.cc.

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

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

◆ setGlobalTag()

void setGlobalTag ( const std::string & globalTagName )

inline

Set Global Tag name.

Parameters

globalTagName Name of the global tag

Definition at line 211 of file CDCDedxValidationAlgorithm.h.

    {
      m_GlobalTagName = globalTagName;
    }

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

{
  // 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.");
  }
}

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

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

◆ setOutputJsonValue()

template<class T>

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

inlineprotectedinherited

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

Definition at line 337 of file CalibrationAlgorithm.h.

337{m_jsonExecutionOutput[key] = value;}

◆ setPrefix()

void setPrefix ( const std::string & prefix )

inlineinherited

Set the prefix used to identify datastore objects.

Definition at line 167 of file CalibrationAlgorithm.h.

167{m_prefix = prefix;}

◆ setTestingPayload()

void setTestingPayload ( const std::string & testingPayloadName )

inline

Set testing payload name.

Parameters

testingPayloadName Name of the payload

Definition at line 202 of file CDCDedxValidationAlgorithm.h.

    {
      m_testingPayloadName = testingPayloadName;
    }

◆ setTextCosmetics()

void setTextCosmetics	(	TPaveText	pt,
		Color_t	color )

inline

Set text cosmetics for TPaveText.

Parameters

pt	TPaveText object
color	Color to apply

Definition at line 221 of file CDCDedxValidationAlgorithm.h.

    {
      pt.SetBorderSize(0);
      pt.SetShadowColor(kWhite);
      pt.SetTextColor(color);
    }

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

{
  // 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);
}

◆ wireGain()

void wireGain ( std::vector< TH1D * > & hdedxhit )

Validate wire gain data using dE/dx histograms.

Parameters

hdedxhit Vector of dE/dx hit histograms

Definition at line 671 of file CDCDedxValidationAlgorithm.cc.

{
 
  std::vector<double> vdedx_means;
  std::vector<double> layermean(c_maxNSenseLayers);
  std::vector<double> lgmean(c_maxNSenseLayers);
 
  std::ofstream outFile, outFileLayer, outFileAvg, outFilebdwire;
  outFile.open(Form("plots/wire/dedx_mean_gwire_%s.txt", m_suffix.data()));
  outFilebdwire.open(Form("plots/wire/dedx_mean_badwire_%s.txt", m_suffix.data()));
  outFileLayer.open(Form("plots/wire/dedx_mean_layer_%s.txt", m_suffix.data()));
  outFileAvg.open(Form("plots/wire/dedx_mean_layer_avg_%s.txt", m_suffix.data()));
 
  int activelayers = 0;
  double layeravg = 0.0;
 
  CDCGeometryPar& cdcgeo = CDCGeometryPar::Instance(&(*m_cdcGeo));
  CDCDedxWireGainAlgorithm wireg;
 
  DBObjPtr<CDCDedxBadWires> Badwire;
 
  int jwire = -1;
  for (unsigned int il = 0; il < c_maxNSenseLayers; ++il) {
 
    int activewires = 0, goodwires = 0;
    layermean[il] = 0.0;
    lgmean[il] = 0.0;
 
    for (unsigned int iw = 0; iw < cdcgeo.nWiresInLayer(il); ++iw) {
      jwire++;
 
      unsigned int minbin, maxbin;
      wireg.getTruncatedBins(hdedxhit[jwire], minbin, maxbin);
      hdedxhit[jwire]->SetTitle(Form("dedxhit-dist, wire: %d ;%d;%d", jwire, minbin, maxbin));
 
      double dedxmean  = wireg.getTruncationMean(hdedxhit[jwire], minbin, maxbin);
      vdedx_means.push_back(dedxmean);
 
      if (Badwire->getBadWireStatus(jwire) == kTRUE)
        outFilebdwire << jwire << " " << dedxmean << std::endl;
      else
        outFile << jwire << " " << dedxmean << std::endl;
 
      if (vdedx_means.at(jwire) > 0) {
        layermean[il] += vdedx_means.at(jwire);
        activewires++;
        if (Badwire->getBadWireStatus(jwire) != kTRUE) {
          lgmean[il] += vdedx_means.at(jwire);
          goodwires++;
        }
      }
    }
 
    if (activewires > 0) layermean[il] /= activewires;
    else layermean[il] = 1.0;
 
    if (goodwires > 0) lgmean[il] /= goodwires;
    else lgmean[il] = 1.0;
 
    outFileLayer << il << " " << layermean[il] << " " << lgmean[il] << std::endl;
 
    //calculate outer layer average for active layer
    if (il >= 8 && layermean[il] > 0) {
      layeravg += layermean[il];
      activelayers++;
    }
  }
 
  //normalisation of wiregains to get outergain ~1.0
  if (activelayers > 0) layeravg /= activelayers;
  outFileAvg << layeravg << std::endl;
 
  outFile.close();
  outFilebdwire.close();
  outFileLayer.close();
  outFileAvg.close();
  printCanvasWire(hdedxhit, Form("plots/wire/dedx_vs_wire_%s", m_suffix.data()), vdedx_means);
}

Definition at line 288 of file CDCDedxValidationAlgorithm.h.

◆ m_description

std::string m_description {""}

double m_momMin

private

min range of momentum

Definition at line 296 of file CDCDedxValidationAlgorithm.h.

◆ m_prefix

std::string m_prefix {""}

privateinherited

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

Definition at line 388 of file CalibrationAlgorithm.h.

388{""};

◆ m_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 285 of file CDCDedxValidationAlgorithm.h.

◆ m_sring

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

private

injection ring name

Definition at line 306 of file CDCDedxValidationAlgorithm.h.

306{"ler", "her"};

◆ m_suffix

std::string m_suffix

private

suffix string to separate plots

Definition at line 308 of file CDCDedxValidationAlgorithm.h.

◆ m_tbins

unsigned int m_tbins

private

internal time bins

Definition at line 300 of file CDCDedxValidationAlgorithm.h.

◆ m_tedges

double* m_tedges

private

internal time array (copy of vtlocaledges)

Definition at line 299 of file CDCDedxValidationAlgorithm.h.

◆ m_testingPayloadName

std::string m_testingPayloadName = ""

private

Testing payload location.

Definition at line 313 of file CDCDedxValidationAlgorithm.h.

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

cdc/calibration/CDCdEdx/include/CDCDedxValidationAlgorithm.h
cdc/calibration/CDCdEdx/src/CDCDedxValidationAlgorithm.cc

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ EResult

Constructor & Destructor Documentation

◆ CDCDedxValidationAlgorithm()

◆ ~CDCDedxValidationAlgorithm()

Member Function Documentation

◆ bhabhaValidation()

◆ boundaryFindingSetup()

◆ boundaryFindingTearDown()

◆ calibrate()

◆ checkPyExpRun()

◆ clearCalibrationData()

◆ commit() [1/2]

◆ commit() [2/2]

◆ convertPyExpRun()

◆ DatabaseIN()

◆ defineHisto()

◆ defineTimeBins()

◆ dumpOutputJson()

◆ execute() [1/2]

◆ execute() [2/2]

◆ fillRunToInputFilesMap()

◆ findPayloadBoundaries()

◆ fit()

◆ fitGaussianWRange()

◆ getAllGranularityExpRun()

◆ getCollectorName()

◆ getcosgain()

◆ getDescription()

◆ getExpRunInfo()

◆ getExpRunString()

◆ getFullObjectPath()

◆ getGranularity()

◆ getGranularityFromData()

◆ getInputFileNames()

◆ getInputJsonObject()

◆ getInputJsonValue()

◆ getIovFromAllData()

◆ getIteration()

◆ getObjectPtr()

◆ getonedgain()

◆ getOutputJsonValue()

◆ getPayloads()

◆ getPayloadValues()

◆ getPrefix()

◆ getrungain()

◆ getRunList()

◆ getRunListFromAllData()

◆ getRunRangeFromAllData()

◆ getTimeBinLabel()

◆ getVecInputFileNames()

◆ getwiregain()

◆ inputJsonKeyExists()

◆ isBoundaryRequired()

◆ loadInputJson()

◆ plotEventStats()

◆ printCanvas()

◆ printCanvasdEdx()

◆ printCanvasRun()

◆ printCanvasWire()

◆ radeeValidation()

◆ resetDatabase()

◆ resetInputJson()

◆ resetOutputJson()

◆ saveCalibration() [1/6]

◆ saveCalibration() [2/6]

◆ saveCalibration() [3/6]

◆ saveCalibration() [4/6]

◆ saveCalibration() [5/6]

◆ saveCalibration() [6/6]

◆ setDescription()

◆ setGlobalTag()