A calibration algorithm for CDC dE/dx to find the bad wires. More...

#include <CDCDedxBadWireAlgorithm.h>

Inheritance diagram for CDCDedxBadWireAlgorithm:

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

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

virtual	~CDCDedxBadWireAlgorithm ()
	Destructor.

void	setMonitoringPlots (bool value=false)
	function to enable plotting

void	setHighFracThres (double value)
	function to set high dedx fraction threshold

void	setRMSThres (double value)
	function to set RMS Threshold

void	setMeanThres (double value)
	function to set Mean Threshold

void	setADC (bool value=false)
	function to choose adc or dedx as variable

void	setHistPars (int nbin, double min, double max)
	function to set adc/dedx parameters

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

void	plotWireDist (const std::vector< double > &inwires, std::map< int, std::vector< double > > &vhitvar)
	function to draw per wire plots

void	printCanvas (TList list, TList hflist, Color_t color)
	function to print canvas

void	plotBadWireMap (const std::vector< double > &vbadwires, const std::vector< double > &vdeadwires)
	function to plot wire status map (all, bad and dead)

TH2F *	getHistoPattern (const std::vector< double > &inwires, const std::string &suffix, int &total)
	function to get wire map with input file (all, bad and dead)

void	plotQaPars (std::map< int, std::vector< double > > &qapars)
	function to plot the QA (decision) parameters

void	plotEventStats ()
	function to draw the stats

void	setTextCosmetics (TPaveText *pt, double size)
	function to change text styles

void	setHistCosmetics (TH2F *hist, Color_t color)
	function to change histogram styles

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
	cdcdedx badwire algorithm

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

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

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

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

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

int	getIteration () const
	Get current iteration.

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

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

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

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

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

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

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

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

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

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

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

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

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

void	clearCalibrationData ()
	Clear calibration data.

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

void	resetInputJson ()
	Clears the m_inputJson member variable.

void	resetOutputJson ()
	Clears the m_outputJson member variable.

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

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

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

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

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

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

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

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

Private Attributes
unsigned int	c_nwireCDC
	number of wires in CDC

bool	m_isMakePlots
	produce plots for status

bool	m_isADC
	Use adc if(true) else dedx for calibration.

int	m_varBins
	number of bins for input variable

double	m_varMin
	min range for input variable

double	m_varMax
	max range for input variable

double	m_meanThres
	mean Threshold accepted for good wire

double	m_rmsThres
	rms Threshold accepted for good wire

double	m_fracThres
	high-frac Threshold accepted for good wire

double	m_amean
	average mean of dedx for all wires

double	m_arms
	average rms of dedx for all wires

std::string	m_varName
	std::string to set var name (adc or dedx)

std::string	m_suffix
	suffix std::string for naming plots

DBObjPtr< CDCDedxBadWires >	m_DBBadWires
	Badwire DB object.

DBObjPtr< CDCDedxWireGain >	m_DBWireGains
	Wiregain DB object.

DBObjPtr< CDCGeometry >	m_cdcGeo
	Geometry of CDC.

std::vector< std::string >	m_inputFileNames
	List of input files to the Algorithm, will initially be user defined but then gets the wildcards expanded during execute()

std::map< Calibration::ExpRun, std::vector< std::string > >	m_runsToInputFiles
	Map of Runs to input files. Gets filled when you call getRunRangeFromAllData, gets cleared when setting input files again.

std::string	m_granularityOfData
	Granularity of input data. This only changes when the input files change so it isn't specific to an execution.

ExecutionData	m_data
	Data specific to a SINGLE execution of the algorithm. Gets reset at the beginning of execution.

std::string	m_description {""}
	Description of the algorithm.

std::string	m_prefix {""}
	The name of the TDirectory the collector objects are contained within.

nlohmann::json	m_jsonExecutionInput = nlohmann::json::object()
	Optional input JSON object used to make decisions about how to execute the algorithm code.

nlohmann::json	m_jsonExecutionOutput = nlohmann::json::object()
	Optional output JSON object that can be set during the execution by the underlying algorithm code.

Static Private Attributes
static const Calibration::ExpRun	m_allExpRun = make_pair(-1, -1)
	allExpRun

Detailed Description

A calibration algorithm for CDC dE/dx to find the bad wires.

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

◆ CDCDedxBadWireAlgorithm()

CDCDedxBadWireAlgorithm ( )

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

Definition at line 26 of file CDCDedxBadWireAlgorithm.cc.

                                                 :
  CalibrationAlgorithm("CDCDedxElectronCollector"),
  c_nwireCDC(c_nSenseWires),
  m_isMakePlots(true),
  m_isADC(false),
  m_varBins(100),
  m_varMin(0.0),
  m_varMax(7.0),
  m_meanThres(1.0),
  m_rmsThres(1.0),
  m_fracThres(1.0),
  m_varName("hitdedx"),
  m_suffix("")
{
  // Set module properties
  setDescription("A calibration algorithm for CDC dE/dx bad wires");
}

◆ ~CDCDedxBadWireAlgorithm()

virtual ~CDCDedxBadWireAlgorithm ( )

inlinevirtual

Destructor.

Definition at line 48 of file CDCDedxBadWireAlgorithm.h.

48{}

Member Function Documentation

◆ boundaryFindingSetup()

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

inlineprotectedvirtualinherited

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

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

Definition at line 252 of file CalibrationAlgorithm.h.

252{};

◆ boundaryFindingTearDown()

virtual void boundaryFindingTearDown ( )

inlineprotectedvirtualinherited

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

Definition at line 257 of file CalibrationAlgorithm.h.

257{};

◆ calibrate()

CalibrationAlgorithm::EResult calibrate ( )

overrideprotectedvirtual

cdcdedx badwire algorithm

Implements CalibrationAlgorithm.

Definition at line 47 of file CDCDedxBadWireAlgorithm.cc.

{
 
  getExpRunInfo();
 
  //old wg for book-keeping previous bad+dead
  if (!m_DBBadWires.isValid() || !m_DBWireGains.isValid())
    B2FATAL("There is no valid payload for BadWire and/or Wirgain");
 
  // Get data objects
  auto ttree = getObjectPtr<TTree>("tree");
  if (ttree->GetEntries() < 1000) return c_NotEnoughData;
 
  vector<int>* wire = 0;
  ttree->SetBranchAddress("wire", &wire);
 
  vector<double>* hitvar = 0;
  if (m_isADC) ttree->SetBranchAddress("adccorr", &hitvar);
  else ttree->SetBranchAddress("dedxhit", &hitvar);
 
  if (m_isADC) m_varName = "hitadc";
  m_suffix = Form("%s_%s", m_varName.data(), m_suffix.data());
 
  TH1D hvarall(Form("hvarall_%s", m_suffix.data()), "", m_varBins, m_varMin, m_varMax);
  hvarall.SetTitle(Form("dist %s; %s; %s", m_suffix.data(), m_varName.data(), "entries"));
 
  map<int, vector<double>> vhitvar;
 
  for (int i = 0; i < ttree->GetEntries(); ++i) {
    ttree->GetEvent(i);
    for (unsigned int ih = 0; ih < wire->size(); ++ih) {
      double ivalue = hitvar->at(ih);
      vhitvar[wire->at(ih)].push_back(ivalue);
      hvarall.Fill(ivalue);
    }
  }
 
  m_amean = hvarall.GetMean();
  m_arms = hvarall.GetRMS();
 
  // Commenting minstat cut on March 2024,
  //it is not worth to skip the calibration if there is more than 5% bad/dead wires
 
  //return if >5% bad wire or null histogram
  // int minstat = 0;
  // for (unsigned int jw = 0; jw < c_nwireCDC; ++jw)
  //   if (vhitvar[jw].size() <= 100) minstat++;
  // if (minstat > 0.05 * c_nwireCDC) return c_NotEnoughData;
 
  if (m_amean == 0 || m_arms == 0)  return c_NotEnoughData;
 
  map<int, vector<double>> qapars;
  vector<double> vdefectwires, vbadwires, vdeadwires;
 
  for (unsigned int jw = 0; jw < c_nwireCDC; ++jw) {
    int ncount = 0, tcount = 0;
    double nmean = 0.;
    for (unsigned int jh = 0; jh < vhitvar[jw].size(); ++jh) {
      double jvalue = vhitvar[jw][jh];
      if (jvalue < m_varMax) {
        ncount++;
        nmean += jvalue;
      } else tcount++;
    }
 
    bool badwire = false;
    if (ncount < 100) {
      qapars[0].push_back(0);
      qapars[1].push_back(0);
      qapars[2].push_back(0);
      badwire = true; //partial dead
    } else {
      nmean = nmean / ncount;
      if (abs(nmean - m_amean) / m_amean > m_meanThres) badwire = true;
 
      double nrms = 0.;
      for (unsigned int kh = 0; kh < vhitvar[jw].size(); ++kh) {
        double kvalue = vhitvar[jw][kh];
        if (kvalue < m_varMax)  nrms += pow(kvalue - nmean, 2);
      }
 
      nrms = sqrt(nrms / ncount);
      if (abs(nrms - m_arms) / m_arms > m_rmsThres) badwire = true;
 
      double badfrac = 0.0;
      if (tcount > 0) badfrac = (1.0 * tcount) / (tcount + ncount);
      if (badfrac > m_fracThres) badwire = true;
 
      qapars[0].push_back(nmean);
      qapars[1].push_back(nrms);
      qapars[2].push_back(badfrac);
    }
 
    if (badwire) {
      vdefectwires.push_back(0.0);
      if (ncount == 0) vdeadwires.push_back(jw);
      else vbadwires.push_back(jw);
    } else vdefectwires.push_back(1.0);
  }
 
 
  if (m_isMakePlots) {
    //1. plot bad and good wire plots.
    plotWireDist(vbadwires, vhitvar);
 
    //2. plots wire status map
    plotBadWireMap(vbadwires, vdeadwires);
 
    //3. plot control parameters histograms
    plotQaPars(qapars);
 
    //4. plot statistics related histograms
    plotEventStats();
  }
 
  // Save payloads
  B2INFO("dE/dx Badwire Calibration done: " << vdefectwires.size() << " wires");
  CDCDedxBadWires* c_badwires = new CDCDedxBadWires(vdefectwires);
  saveCalibration(c_badwires, "CDCDedxBadWires");
 
  m_suffix.clear();
 
  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;
}

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

◆ getAllGranularityExpRun()

Calibration::ExpRun getAllGranularityExpRun ( ) const

inlineprotectedinherited

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

Definition at line 327 of file CalibrationAlgorithm.h.

327{return m_allExpRun;}

◆ getCollectorName()

std::string getCollectorName ( ) const

inlineinherited

Alias for prefix.

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

Definition at line 164 of file CalibrationAlgorithm.h.

164{return getPrefix();}

◆ getDescription()

const std::string & getDescription ( ) const

inlineinherited

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

Definition at line 216 of file CalibrationAlgorithm.h.

216{return m_description;}

◆ getExpRunInfo()

void getExpRunInfo ( )

function to get extract calibration run/exp

Definition at line 173 of file CDCDedxBadWireAlgorithm.cc.

{
 
  int cruns = 0;
  for (auto expRun : getRunList()) {
    if (cruns == 0) B2INFO("CDCDedxBadWires: 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];
  int rend = erEnd.second;
 
  updateDBObjPtrs(1, rstart, estart);
 
  if (m_suffix.length() > 0) m_suffix = Form("%s_e%d_r%dr%d", m_suffix.data(), estart, rstart, rend);
  else  m_suffix = Form("e%d_r%dr%d", estart, rstart, rend);
}

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

◆ getHistoPattern()

TH2F * getHistoPattern	(	const std::vector< double > &	inwires,
		const std::string &	suffix,
		int &	total )

function to get wire map with input file (all, bad and dead)

Definition at line 367 of file CDCDedxBadWireAlgorithm.cc.

{
 
  B2INFO("Creating CDCGeometryPar object");
  CDCGeometryPar& cdcgeo = CDCGeometryPar::Instance(&(*m_cdcGeo));
 
  TH2F* temp = new TH2F(Form("temp_%s_%s", m_suffix.data(), suffix.data()), "", 2400, -1.2, 1.2, 2400, -1.2, 1.2);
 
  int jwire = -1;
  total = 0;
  for (unsigned int ilay = 0; ilay < c_maxNSenseLayers; ++ilay) {
    for (unsigned int iwire = 0; iwire < cdcgeo.nWiresInLayer(ilay); ++iwire) {
      jwire++;
      double phi = 2.*TMath::Pi() * (float(iwire) / float(cdcgeo.nWiresInLayer(ilay)));
      double radius = cdcgeo.senseWireR(ilay) / 100.;
      double x = radius * cos(phi);
      double y = radius * sin(phi);
      if (suffix == "all") {
        total++;
        temp->Fill(x, y);
      } else {
        if (count(inwires.begin(), inwires.end(), jwire)) {
          temp->Fill(x, y);
          total++;
        }
      }
    }
  }
  return temp;
}

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

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

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

◆ getVecInputFileNames()

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

inlineprotectedinherited

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

Definition at line 275 of file CalibrationAlgorithm.h.

275{return m_inputFileNames;}

◆ inputJsonKeyExists()

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

inlineprotectedinherited

Test for a key in the input JSON object.

Definition at line 360 of file CalibrationAlgorithm.h.

360{return m_jsonExecutionInput.count(key);}

◆ isBoundaryRequired()

virtual bool isBoundaryRequired ( const Calibration::ExpRun & )

inlineprotectedvirtualinherited

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

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

Definition at line 243 of file CalibrationAlgorithm.h.

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

◆ plotBadWireMap()

void plotBadWireMap	(	const std::vector< double > &	vbadwires,
		const std::vector< double > &	vdeadwires )

function to plot wire status map (all, bad and dead)

Definition at line 316 of file CDCDedxBadWireAlgorithm.cc.

{
 
  TCanvas cmap(Form("cmap_%s", m_suffix.data()), "", 800, 800);
  cmap.SetTitle("CDC dE/dx bad wire status");
 
  int total = 0;
  TH2F* hxyAll = getHistoPattern(vbadwires, "all", total);
  hxyAll->SetTitle(Form("wire status map (%s)", m_suffix.data()));
  setHistCosmetics(hxyAll, kGray);
  hxyAll->Draw();
 
  int nbad = 0.0;
  TH2F* hxyBad = getHistoPattern(vbadwires, "bad", nbad);
  if (hxyBad) {
    setHistCosmetics(hxyBad, kRed);
    hxyBad->Draw("same");
  }
 
  int ndead = 0.0;
  TH2F* hxyDead = getHistoPattern(vdeadwires, "dead", ndead);
  if (hxyDead) {
    setHistCosmetics(hxyDead, kBlack);
    hxyDead->Draw("same");
  }
 
  int ndefect = nbad + ndead;
  auto leg = new TLegend(0.68, 0.80, 0.90, 0.92);
  leg->SetBorderSize(0);
  leg->SetLineWidth(3);
  leg->SetHeader(Form("total defective: %d (~%0.02f%%)", ndefect, 100.*(ndefect) / c_nwireCDC));
  leg->AddEntry(hxyBad, Form("bad #rightarrow %d", nbad), "p");
  leg->AddEntry(hxyDead, Form("dead #rightarrow %d", ndead), "p");
  leg->Draw();
 
  gStyle->SetLegendTextSize(0.025);
  TPaveText* pt = new TPaveText(-0.30, -1.47, -0.31, -1.30, "br");
  setTextCosmetics(pt, 0.02258064);
 
  TText* text = pt->AddText("CDC-wire map: counter-clockwise and start from +x");
  text->SetTextColor(kGray + 1);
  pt->Draw("same");
 
  cmap.SaveAs(Form("cdcdedx_bdcal_wiremap_%s.pdf", m_suffix.data()));
 
  delete hxyAll;
  delete hxyBad;
  delete hxyDead;
}

◆ plotEventStats()

void plotEventStats ( )

function to draw the stats

Definition at line 440 of file CDCDedxBadWireAlgorithm.cc.

{
 
  TCanvas cstats("cstats", "cstats", 1000, 500);
  cstats.SetBatch(kTRUE);
  cstats.Divide(2, 1);
 
  cstats.cd(1);
  auto hestats = getObjectPtr<TH1I>("hestats");
  if (hestats) {
    hestats->SetName(Form("htstats_%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_bdcal_qastats_%s.pdf", m_suffix.data()));
}

◆ plotQaPars()

void plotQaPars ( std::map< int, std::vector< double > > & qapars )

function to plot the QA (decision) parameters

Definition at line 399 of file CDCDedxBadWireAlgorithm.cc.

{
 
  string qaname[3] = {"mean", "rms", "high_fraction"};
 
  double linemin[3] = {m_amean* (1 - m_meanThres), m_arms* (1 - m_rmsThres), m_fracThres * 100};
  double linemax[3] = {m_amean* (1 + m_meanThres), m_arms* (1 + m_rmsThres), m_fracThres * 100};
 
  for (int iqa = 0; iqa < 3; iqa++) {
 
    TH1D histqa(Form("%s_%s", qaname[iqa].data(), m_suffix.data()), "", c_nwireCDC, -0.5, 14335.5);
 
    for (unsigned int jw = 0; jw < c_nwireCDC; jw++) {
      if (iqa == 2) histqa.SetBinContent(jw + 1, qapars[iqa][jw] * 100);
      else histqa.SetBinContent(jw + 1, qapars[iqa][jw]);
    }
 
    TCanvas c_pars(Form("c_pars_%d", iqa), "", 800, 600);
    c_pars.cd();
    gPad->SetGridy();
 
    histqa.SetTitle(Form("%s vs wires (%s); wire ; %s", qaname[iqa].data(), m_suffix.data(), qaname[iqa].data()));
    histqa.SetStats(0);
    histqa.Draw();
 
    TLine* lmin = new TLine(-0.5, linemin[iqa], 14335.5, linemin[iqa]);
    lmin->SetLineColor(kRed);
    lmin->Draw("same");
    TLine* lmax = new TLine(-0.5, linemax[iqa], 14335.5, linemax[iqa]);
    lmax->SetLineColor(kRed);
    lmax->Draw("same");
 
    c_pars.Print(Form("cdcdedx_bdcal_%s_%s.root", qaname[iqa].data(), m_suffix.data()));
    c_pars.Print(Form("cdcdedx_bdcal_%s_%s.pdf", qaname[iqa].data(), m_suffix.data()));
 
    delete lmax;
    delete lmin;
  }
}

◆ plotWireDist()

void plotWireDist	(	const std::vector< double > &	inwires,
		std::map< int, std::vector< double > > &	vhitvar )

function to draw per wire plots

Definition at line 197 of file CDCDedxBadWireAlgorithm.cc.

{
 
  TList* bdlist = new TList();
  bdlist->SetName("badwires");
 
  TList* goodlist = new TList();
  goodlist->SetName("goodwires");
 
  TList* hflist = new TList();
  hflist->SetName("highfracwires");
 
  for (unsigned int jw = 0; jw < c_nwireCDC; ++jw) {
 
    TH1D* hvar = new TH1D(Form("%s_wire%d", m_suffix.data(), jw), "", m_varBins, m_varMin, m_varMax);
 
    TH1D* hvarhf = new TH1D(Form("hf%s_wire%d", m_suffix.data(), jw), "", m_varBins, m_varMin, m_varMax);
    hvarhf->SetTitle(Form("%s, wire = %d; %s; entries", m_suffix.data(), jw, m_varName.data()));
 
    int ncount = 0, tcount = 0;
 
    for (unsigned int jh = 0; jh < vhitvar[jw].size(); ++jh) {
      double jvalue = vhitvar[jw][jh];
      if (jvalue < m_varMax) {
        ncount++;
        hvar->Fill(jvalue);
      } else {
        tcount++;
        if (jvalue < m_varMax * 10.) hvarhf->Fill(jvalue / 10.);
      }
    }
 
    double badfrac = 0.0;
    if (tcount > 0) badfrac = (1.0 * tcount) / (tcount + ncount);
    hvar->SetTitle(Form("%s, wire = %d; %s; %0.01f", m_suffix.data(), jw, m_varName.data(), badfrac * 100));
 
    bool isbad = false;
    if (count(inwires.begin(), inwires.end(), jw)) isbad = true;
 
    double oldwg = m_DBWireGains->getWireGain(jw);
    if (oldwg == 0) {
      hvar->SetLineWidth(2);
      hvar->SetLineColor(kRed);
    }
 
    if (isbad) {
      bdlist->Add(hvar);
      hflist->Add(hvarhf);
    } else {
      if (hvar->Integral() > 100) goodlist->Add(hvar);
    }
  }
 
  printCanvas(bdlist, hflist, kYellow - 9);
  printCanvas(goodlist, hflist, kGreen);
 
  delete bdlist;
  delete goodlist;
  delete hflist;
}

◆ printCanvas()

void printCanvas	(	TList *	list,
		TList *	hflist,
		Color_t	color )

function to print canvas

Definition at line 260 of file CDCDedxBadWireAlgorithm.cc.

{
 
  string listname = list->GetName();
  string sfx = Form("%s_%s", listname.data(), m_suffix.data());
 
  TCanvas ctmp(Form("cdcdedx_%s", sfx.data()), "", 1200, 1200);
  ctmp.Divide(4, 4);
  ctmp.SetBatch(kTRUE);
 
  stringstream psname;
  psname << Form("cdcdedx_bdcal_%s.pdf[", sfx.data());
  ctmp.Print(psname.str().c_str());
  psname.str("");
  psname << Form("cdcdedx_bdcal_%s.pdf", sfx.data());
 
  for (int ih = 0; ih < list->GetSize(); ih++) {
 
    TH1D* hist = (TH1D*)list->At(ih);
 
    double frac = stod(hist->GetYaxis()->GetTitle());
 
    TPaveText* pinfo = new TPaveText(0.40, 0.63, 0.89, 0.89, "NBNDC");
    pinfo->AddText(Form("#mu: %0.2f(%0.2f#pm%0.2f)", hist->GetMean(), m_amean, m_meanThres * m_amean));
    pinfo->AddText(Form("#sigma: %0.2f(%0.2f#pm%0.2f)", hist->GetRMS(), m_arms, m_rmsThres * m_arms));
    pinfo->AddText(Form("N: %0.00f", hist->Integral()));
    pinfo->AddText(Form("hf: %0.00f%%(%0.00f%%)", frac, m_fracThres * 100));
    setTextCosmetics(pinfo, 0.04258064);
 
    ctmp.cd(ih % 16 + 1);
    hist->GetYaxis()->SetTitle("entries");
    hist->SetFillColor(color);
    hist->SetStats(0);
    hist->Draw();
    pinfo->Draw("same");
 
    if (listname == "badwires") {
      TH1D* histhf = (TH1D*)hflist->At(ih);
      if (hist->GetMaximum() < histhf->GetMaximum()) hist->SetMaximum(histhf->GetMaximum() * 1.05);
      histhf->SetFillColor(kGray);
      histhf->SetStats(0);
      histhf->Draw("same");
    }
 
    if (((ih + 1) % 16 == 0) || ih == (list->GetSize() - 1))  {
      ctmp.Print(psname.str().c_str());
      ctmp.Clear("D");
    }
  }
 
  psname.str("");
  psname << Form("cdcdedx_bdcal_%s.pdf]", sfx.data());
  ctmp.Print(psname.str().c_str());
}

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

◆ setADC()

void setADC ( bool value = false )

inline

function to choose adc or dedx as variable

Definition at line 73 of file CDCDedxBadWireAlgorithm.h.

    {
      m_isADC = value;
      if (m_isADC) m_varMax = 1000.0;
      else m_varMax = 7.0;
    }

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

◆ setHighFracThres()

void setHighFracThres ( double value )

inline

function to set high dedx fraction threshold

Definition at line 58 of file CDCDedxBadWireAlgorithm.h.

58{m_fracThres = value;}

◆ setHistCosmetics()

void setHistCosmetics	(	TH2F *	hist,
		Color_t	color )

inline

function to change histogram styles

Definition at line 140 of file CDCDedxBadWireAlgorithm.h.

    {
      hist->SetMarkerStyle(20);
      hist->SetMarkerSize(0.3);
      hist->SetMarkerColor(color);
      hist->SetFillColor(color);
      hist->SetStats(0);
    }

◆ setHistPars()

void setHistPars	(	int	nbin,
		double	min,
		double	max )

inline

function to set adc/dedx parameters

Definition at line 83 of file CDCDedxBadWireAlgorithm.h.

    {
      m_varBins = nbin;
      m_varMin = min;
      m_varMax = max;
    }

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

◆ setMeanThres()

void setMeanThres ( double value )

inline

function to set Mean Threshold

Definition at line 68 of file CDCDedxBadWireAlgorithm.h.

68{m_meanThres = value;}

◆ setMonitoringPlots()

void setMonitoringPlots ( bool value = false )

inline

function to enable plotting

Definition at line 53 of file CDCDedxBadWireAlgorithm.h.

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

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

◆ setRMSThres()

void setRMSThres ( double value )

inline

function to set RMS Threshold

Definition at line 63 of file CDCDedxBadWireAlgorithm.h.

63{m_rmsThres = value;}

◆ setTextCosmetics()

void setTextCosmetics	(	TPaveText *	pt,
		double	size )

inline

function to change text styles

Definition at line 128 of file CDCDedxBadWireAlgorithm.h.

    {
      pt->SetTextAlign(11);
      pt->SetFillStyle(3001);
      pt->SetLineColor(2);
      pt->SetTextFont(82);
      pt->SetTextSize(size);
    }

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

Member Data Documentation

◆ c_nwireCDC

unsigned int c_nwireCDC

private

number of wires in CDC

Definition at line 158 of file CDCDedxBadWireAlgorithm.h.

◆ m_allExpRun

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

staticprivateinherited

allExpRun

Definition at line 364 of file CalibrationAlgorithm.h.

◆ m_amean

double m_amean

private

average mean of dedx for all wires

Definition at line 169 of file CDCDedxBadWireAlgorithm.h.

◆ m_arms

double m_arms

private

average rms of dedx for all wires

Definition at line 170 of file CDCDedxBadWireAlgorithm.h.

◆ m_boundaries

std::vector<Calibration::ExpRun> m_boundaries

protectedinherited

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

Definition at line 261 of file CalibrationAlgorithm.h.

◆ m_cdcGeo

DBObjPtr<CDCGeometry> m_cdcGeo

private

Geometry of CDC.

Definition at line 177 of file CDCDedxBadWireAlgorithm.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_DBBadWires

DBObjPtr<CDCDedxBadWires> m_DBBadWires

private

Badwire DB object.

Definition at line 175 of file CDCDedxBadWireAlgorithm.h.

◆ m_DBWireGains

DBObjPtr<CDCDedxWireGain> m_DBWireGains

private

Wiregain DB object.

Definition at line 176 of file CDCDedxBadWireAlgorithm.h.

◆ m_description

std::string m_description {""}

privateinherited

Description of the algorithm.

Definition at line 385 of file CalibrationAlgorithm.h.

385{""};

◆ m_fracThres

double m_fracThres

private

high-frac Threshold accepted for good wire

Definition at line 168 of file CDCDedxBadWireAlgorithm.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_isADC

bool m_isADC

private

Use adc if(true) else dedx for calibration.

Definition at line 161 of file CDCDedxBadWireAlgorithm.h.

◆ m_isMakePlots

bool m_isMakePlots

private

produce plots for status

Definition at line 160 of file CDCDedxBadWireAlgorithm.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_meanThres

double m_meanThres

private

mean Threshold accepted for good wire

Definition at line 166 of file CDCDedxBadWireAlgorithm.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_rmsThres

double m_rmsThres

private

rms Threshold accepted for good wire

Definition at line 167 of file CDCDedxBadWireAlgorithm.h.

◆ m_runsToInputFiles

std::map<Calibration::ExpRun, std::vector<std::string> > m_runsToInputFiles

privateinherited

Map of Runs to input files. Gets filled when you call getRunRangeFromAllData, gets cleared when setting input files again.

Definition at line 376 of file CalibrationAlgorithm.h.

◆ m_suffix

std::string m_suffix

private

suffix std::string for naming plots

Definition at line 173 of file CDCDedxBadWireAlgorithm.h.

◆ m_varBins

int m_varBins

private

number of bins for input variable

Definition at line 163 of file CDCDedxBadWireAlgorithm.h.

◆ m_varMax

double m_varMax

private

max range for input variable

Definition at line 165 of file CDCDedxBadWireAlgorithm.h.

◆ m_varMin

double m_varMin

private

min range for input variable

Definition at line 164 of file CDCDedxBadWireAlgorithm.h.

◆ m_varName

std::string m_varName

private

std::string to set var name (adc or dedx)

Definition at line 172 of file CDCDedxBadWireAlgorithm.h.

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

cdc/calibration/CDCdEdx/include/CDCDedxBadWireAlgorithm.h
cdc/calibration/CDCdEdx/src/CDCDedxBadWireAlgorithm.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

◆ CDCDedxBadWireAlgorithm()

◆ ~CDCDedxBadWireAlgorithm()

Member Function Documentation

◆ boundaryFindingSetup()

◆ boundaryFindingTearDown()

◆ calibrate()

◆ checkPyExpRun()

◆ clearCalibrationData()

◆ commit() [1/2]

◆ commit() [2/2]

◆ convertPyExpRun()

◆ dumpOutputJson()

◆ execute() [1/2]

◆ execute() [2/2]

◆ fillRunToInputFilesMap()

◆ findPayloadBoundaries()

◆ getAllGranularityExpRun()

◆ getCollectorName()

◆ getDescription()

◆ getExpRunInfo()

◆ getExpRunString()

◆ getFullObjectPath()

◆ getGranularity()

◆ getGranularityFromData()

◆ getHistoPattern()

◆ getInputFileNames()

◆ getInputJsonObject()

◆ getInputJsonValue()

◆ getIovFromAllData()

◆ getIteration()

◆ getObjectPtr()

◆ getOutputJsonValue()

◆ getPayloads()

◆ getPayloadValues()

◆ getPrefix()

◆ getRunList()

◆ getRunListFromAllData()

◆ getRunRangeFromAllData()

◆ getVecInputFileNames()

◆ inputJsonKeyExists()

◆ isBoundaryRequired()

◆ loadInputJson()

◆ plotBadWireMap()

◆ plotEventStats()

◆ plotQaPars()

◆ plotWireDist()

◆ printCanvas()

◆ resetInputJson()

◆ resetOutputJson()

◆ saveCalibration() [1/6]

◆ saveCalibration() [2/6]

◆ saveCalibration() [3/6]

◆ saveCalibration() [4/6]

◆ saveCalibration() [5/6]

◆ saveCalibration() [6/6]

◆ setADC()

◆ setDescription()

◆ setHighFracThres()

◆ setHistCosmetics()

◆ setHistPars()

◆ setInputFileNames() [1/2]

◆ setInputFileNames() [2/2]

◆ setMeanThres()

◆ setMonitoringPlots()

◆ setOutputJsonValue()

◆ setPrefix()

◆ setRMSThres()

◆ setTextCosmetics()

◆ updateDBObjPtrs()