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

#include <CDCDedx1DCellAlgorithm.h>

Inheritance diagram for CDCDedx1DCellAlgorithm:

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

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

virtual	~CDCDedx1DCellAlgorithm ()
	Destructor.

void	setEntaRange (double min=-1.0, double max=1.0)
	function to set min/max range of entrance angle for calibration

void	setEntaBins (unsigned int value=316)
	function to set number of entrance angle bins for calibration

void	setHistBins (int value=250)
	function to set nbins of dedx dist for calibration

void	setHistRange (double min=0.0, double max=5.0)
	function to set min/max range of dedx dist for calibration

void	setPtLimit (double value)
	function to set pt limit

void	setCosLimit (double value)
	function to set costheta limit

void	setTrucationBins (double lowedge, double upedge)
	function to set bins of truncation from histogram

void	setSplitFactor (int value)
	set bin split factor for all range

void	setChargeType (int value)
	set charge type

void	setAdjustmentFactor (int value)
	set adjustment factor

void	setLayerTrunc (bool value=false)
	function to set truncation method (local vs global)

void	setVariableBins (bool value)
	Set Var bins flag to on or off.

void	setRotSymmetry (bool value)
	set rotation sys to copy constants from one region to other

void	enableExtraPlots (bool value=false)
	funtion to set flag active for plotting

void	setPrintLog (bool value=false)
	funtion to set flag to print log

void	setMergePayload (bool value)
	set false if generating absolute (not relative) payload

void	setSuffix (const std::string &value)
	adding suffix to control plots

unsigned int	getRepresentativeLayer (unsigned int il) const
	Representative CDC layer for each SL group (used to access group-wise constants): SL0 => 1, SL1 => 9, SL2-8 => 17.

void	setBaselineFactor (double charge, double factor)
	adjust baseline based on charge or global overall works for only single charge or both

int	rotationalBin (int nbin, int ibin)
	class function to set rotation symmetry

void	getExpRunInfo ()
	function to extract calibration run/exp

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

void	defineHisto (std::array< std::vector< TH1D * >, 3 > &hdedxhit, std::array< TH1D , 3 > &hdedxlay, std::array< TH1D , 3 > &hentalay)
	function to define histograms

void	getTruncatedBins (TH1D *hist, int &binlow, int &binhigh)
	function to get bins of truncation from histogram

double	getTruncationMean (TH1D *hist, int binlow, int binhigh)
	function to get truncated mean

void	createPayload ()
	function to generate final constants

void	plotMergeFactor (std::map< int, std::vector< double > > bounds, const std::array< int, 2 > nDev, std::map< int, std::vector< int > > steps)
	function to plot merging factor

void	plotdedxHist (std::array< std::vector< TH1D * >, m_kNGroups > &hdedxhit)
	function to draw the dE/dx histogram in enta bins

void	plotLayerDist (std::array< TH1D *, m_kNGroups > &hdedxlay)
	function to draw dedx dist.

void	plotQaPars (std::array< TH1D , m_kNGroups > &hentalay, TH2D hptcosth)
	function to draw pt vs costh and entrance angle distribution for Inner/Outer layer

void	plotRelConst (std::vector< std::vector< double > > &tempconst)
	function to draw symm/Var layer constant

void	plotConstants ()
	function to draw the old/new final constants

void	plotEventStats ()
	function to draw the stats plots

const std::string &	getPrefix () const
	Get the prefix used for getting calibration data.

const std::string &	getCollectorName () const
	Alias for prefix.

void	setPrefix (const std::string &prefix)
	Set the prefix used to identify datastore objects.

void	setInputFileNames (PyObject *inputFileNames)
	Set the input file names used for this algorithm from a Python list.

PyObject *	getInputFileNames ()
	Get the input file names used for this algorithm and pass them out as a Python list of unicode strings.

std::vector< Calibration::ExpRun >	getRunListFromAllData () const
	Get the complete list of runs from inspection of collected data.

RunRange	getRunRangeFromAllData () const
	Get the complete RunRange from inspection of collected data.

IntervalOfValidity	getIovFromAllData () const
	Get the complete IoV from inspection of collected data.

void	fillRunToInputFilesMap ()
	Fill the mapping of ExpRun -> Files.

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

EResult	execute (std::vector< Calibration::ExpRun > runs={}, int iteration=0, IntervalOfValidity iov=IntervalOfValidity())
	Runs calibration over vector of runs for a given iteration.

EResult	execute (PyObject *runs, int iteration=0, IntervalOfValidity iov=IntervalOfValidity())
	Runs calibration over Python list of runs. Converts to C++ and then calls the other execute() function.

std::list< Database::DBImportQuery > &	getPayloads ()
	Get constants (in TObjects) for database update from last execution.

std::list< Database::DBImportQuery >	getPayloadValues () const
	Get constants (in TObjects) for database update from last execution but passed by VALUE.

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

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

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

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

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

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

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

Static Public Member Functions
static bool	checkPyExpRun (PyObject *pyObj)
	Checks that a PyObject can be successfully converted to an ExpRun type.

static Calibration::ExpRun	convertPyExpRun (PyObject *pyObj)
	Performs the conversion of PyObject to ExpRun.

Static Public Attributes
static constexpr int	m_kNGroups = 3
	SL grouping: inner (SL0), middle (SL1), outer (SL2–8)

Protected Member Functions
virtual EResult	calibrate () override
	1D cell algorithm

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

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

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

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

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

int	getIteration () const
	Get current iteration.

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

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

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

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

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

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

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

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

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

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

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

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

void	clearCalibrationData ()
	Clear calibration data.

void	resetInputJson ()
	Clears the m_inputJson member variable.

void	resetOutputJson ()
	Clears the m_outputJson member variable.

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

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

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

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

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

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

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

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

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

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

Private Attributes
double	m_eaMin
	lower edge of entrance angle

double	m_eaMax
	upper edge of entrance angle

double	m_eaBW
	binwdith of entrance angle bin

int	m_eaBin

int	m_eaB
	reset # of bins for entrance angle for each experiment

double	m_dedxMin
	lower edge of dedxhit

double	m_dedxMax
	upper edge of dedxhit

int	m_dedxBin

double	m_ptMax
	a limit on transverse momentum

double	m_cosMax
	a limit on cos theta

double	m_truncMin
	lower threshold on truncation

double	m_truncMax
	upper threshold on truncation

int	m_binSplit
	multiply nbins by this factor in full range

double	m_chargeType
	charge type for baseline adj

double	m_adjustFac
	factor with that one what to adjust baseline

bool	isFixTrunc
	true = fix window for all out/inner layers

bool	isVarBins
	true: if variable bin size is requested

bool	isRotSymm
	if rotation symmetry requested

bool	isMakePlots
	produce plots for status

bool	isPrintLog
	print more debug information

bool	isMerge
	print more debug information

std::string	m_suffix
	add suffix to all plot name

std::string	m_runExp
	add run and exp to title of plot

std::string	m_label [m_kNGroups] = {"SL0", "SL1", "SL2-8"}
	add inner/outer superlayer label

std::vector< int >	m_eaBinLocal

std::array< std::vector< int >, m_kNGroups >	m_binIndex
	symm/Var bin numbers

std::array< std::vector< double >, m_kNGroups >	m_binValue
	enta Var bin values

std::vector< std::vector< double > >	m_onedcors
	final vectors of calibration

DBObjPtr< CDCDedx1DCell >	m_DBOneDCell
	One cell correction DB object.

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

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

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

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

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

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

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

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

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

Detailed Description

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

Definition at line 28 of file CDCDedx1DCellAlgorithm.h.

Member Enumeration Documentation

◆ EResult

enum EResult

inherited

The result of calibration.

Enumerator
c_OK	Finished successfully =0 in Python.
c_Iterate	Needs iteration =1 in Python.
c_NotEnoughData	Needs more data =2 in Python.
c_Failure	Failed =3 in Python.
c_Undefined	Not yet known (before execution) =4 in Python.

Definition at line 40 of file CalibrationAlgorithm.h.

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

Constructor & Destructor Documentation

◆ CDCDedx1DCellAlgorithm()

CDCDedx1DCellAlgorithm ( )

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

Definition at line 25 of file CDCDedx1DCellAlgorithm.cc.

                                               :
  CalibrationAlgorithm("CDCDedxElectronCollector"),
  m_eaMin(-TMath::Pi() / 2),
  m_eaMax(+TMath::Pi() / 2),
  m_eaB(316),
  m_dedxMin(0.0),
  m_dedxMax(5.0),
  m_dedxBin(250),
  m_ptMax(8.0),
  m_cosMax(1.0),
  m_truncMin(0.05),
  m_truncMax(0.75),
  m_binSplit(3),
  m_chargeType(0),
  m_adjustFac(1.00),
  isFixTrunc(false),
  isVarBins(true),
  isRotSymm(false),
  isMakePlots(true),
  isPrintLog(false),
  isMerge(true),
  m_suffix("")
{
  // Set module properties
  setDescription("A calibration algorithm for the CDC dE/dx entrance angle cleanup correction");
}

◆ ~CDCDedx1DCellAlgorithm()

virtual ~CDCDedx1DCellAlgorithm ( )

inlinevirtual

Destructor.

Definition at line 42 of file CDCDedx1DCellAlgorithm.h.

42{}

Member Function Documentation

◆ boundaryFindingSetup()

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

inlineprotectedvirtualinherited

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

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

Definition at line 252 of file CalibrationAlgorithm.h.

252{};

◆ boundaryFindingTearDown()

virtual void boundaryFindingTearDown ( )

inlineprotectedvirtualinherited

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

Definition at line 257 of file CalibrationAlgorithm.h.

257{};

◆ calibrate()

CalibrationAlgorithm::EResult calibrate ( )

overrideprotectedvirtual

1D cell algorithm

Implements CalibrationAlgorithm.

Definition at line 55 of file CDCDedx1DCellAlgorithm.cc.

{
 
  getExpRunInfo();
 
  if (!m_DBOneDCell.isValid())
    B2FATAL("There is no valid previous payload for CDCDedx1DCell");
 
  //reading radiative electron collector TREE
  auto ttree = getObjectPtr<TTree>("tree");
  if (!ttree) return c_NotEnoughData;
 
  std::vector<double>* dedxhit = 0, *enta = 0;
  std::vector<int>* layer = 0;
  double pt = 0, costh = 0;
 
  ttree->SetBranchAddress("dedxhit", &dedxhit);
  ttree->SetBranchAddress("entaRS", &enta);
  ttree->SetBranchAddress("layer", &layer);
  ttree->SetBranchAddress("pt", &pt);
  ttree->SetBranchAddress("costh", &costh);
 
  //repair nbins if they are not divisible accordingly
  m_eaBin = m_eaB * m_binSplit;
  m_eaBW = (m_eaMax - m_eaMin) / m_eaBin;
 
  //Settings of variables bins
  CreateBinMapping();
 
  if (isPrintLog) {
    B2INFO("Superlayer0 bins: " << m_eaBinLocal[0]);
    B2INFO("Superlayer1 bins: " << m_eaBinLocal[1]);
    B2INFO("Superlayers2-8 bins: " << m_eaBinLocal[2]);
  }
 
  // dedxhit vector to store dE/dx values for each enta bin
  std::array<std::vector<TH1D*>, m_kNGroups> hdedxhit;
  std::array<TH1D*, m_kNGroups> hdedxlay{};
  std::array<TH1D*, m_kNGroups> hentalay{};
 
  TH2D* hptcosth = new TH2D("hptcosth", "pt vs costh dist;pt;costh", 1000, -8.0, 8.0, 1000, -1.0, 1.0);
 
  defineHisto(hdedxhit, hdedxlay, hentalay);
 
  //Star filling histogram defined above
  for (int i = 0; i < ttree->GetEntries(); ++i) {
 
    ttree->GetEvent(i);
 
    if (std::abs(costh) > m_cosMax) continue;
 
    // remove wide angle bhabha tracks
    // double mom = pt/sqrt(1-costh*costh);
    // if(abs(pt)<2.4 && abs(mom)>3.6)continue;
 
    if (std::abs(pt) > m_ptMax) continue;
 
    //change to random 10%
    int rand = gRandom->Integer(100);
    if (rand < 10) hptcosth->Fill(pt, costh);
 
    for (unsigned int j = 0; j < dedxhit->size(); ++j) {
 
      if (dedxhit->at(j) == 0) continue;
 
      double entaval = enta->at(j);
      //Mapped bin corresponds to entaval
      int ibin = std::floor((entaval - m_eaMin) / m_eaBW);
      if (ibin < 0 || ibin >= m_eaBin) continue;
 
      int lay = layer->at(j);
      int mL = (lay < 8) ? 0 : ((lay < 14) ? 1 : 2);
 
      hdedxlay[mL]->Fill(dedxhit->at(j));
      if (rand < 10) hentalay[mL]->Fill(entaval);
 
      int jbinea = ibin;
      if (isVarBins) jbinea = m_binIndex[mL].at(ibin);
      hdedxhit[mL][jbinea]->Fill(dedxhit->at(j));
    }
  }
  std::vector<std::vector<double>> tempconst(m_kNGroups);
  for (int il = 0; il < m_kNGroups; il++) {
 
    int minlay = 0, maxlay = 0;
 
    if (isFixTrunc) {
      getTruncatedBins(hdedxlay[il], minlay, maxlay);
      hdedxlay[il]->SetTitle(Form("%s;%d;%d", hdedxlay[il]->GetTitle(), minlay, maxlay));
    }
    tempconst[il].reserve(m_eaBinLocal[il]);
 
    for (int iea = 0; iea < m_eaBinLocal[il]; iea++) {
 
      int jea = iea;
 
      // rotation symmtery for 1<->3 and 4<->2 but only symmetric bin
      if (!isVarBins && isRotSymm) jea = rotationalBin(m_eaBinLocal[il], jea);
 
      TH1D* htemp = (TH1D*)hdedxhit[il][jea]->Clone(Form("h_%s_b%d_c", m_label[il].data(), jea));
 
      int minbin = 1, maxbin = 1;
      if (isFixTrunc) {
        minbin = minlay;
        maxbin = maxlay;
      } else {
        //extract truncation window per bin
        getTruncatedBins(htemp, minbin, maxbin);
      }
 
      double dedxmean;
      dedxmean = getTruncationMean(htemp, minbin, maxbin);
      tempconst[il].push_back(dedxmean);
 
      hdedxhit[il][iea]->SetTitle(Form("%s, #mu_{truc} = %0.5f;%d;%d", hdedxhit[il][iea]->GetTitle(), dedxmean, minbin, maxbin));
    }
 
    //Expending constants
    std::vector<double>layerconst;
    layerconst.reserve(m_eaBin);
 
    for (int iea = 0; iea < m_eaBin; iea++) {
      int jea = iea;
      if (isVarBins)  jea = m_binIndex[il].at(iea);
      layerconst.push_back(tempconst[il].at(jea));
    }
 
    m_onedcors.push_back(layerconst);
 
    layerconst.clear();
 
  }
 
  // plot the rel constants var/sym bins
  if (isMakePlots)  plotRelConst(tempconst);
 
  //Saving final constants
  createPayload();
 
  if (isMakePlots) {
 
    //1. dE/dx dist. for entrance angle bins
    plotdedxHist(hdedxhit);
 
    //3. Inner and Outer layer dE/dx distributions
    plotLayerDist(hdedxlay);
 
    //4. entrance angle distribution sym/var bins
    plotQaPars(hentalay, hptcosth);
 
    //6. draw the final constants
    plotConstants();
 
    //7. plot statistics related plots here
    plotEventStats();
  }
 
  for (int il = 0; il < m_kNGroups; il++) {
    delete hentalay[il];
    delete hdedxlay[il];
    for (int iea = 0; iea < m_eaBinLocal[il]; iea++)
      delete hdedxhit[il][iea];
  }
 
  delete hptcosth;
  m_eaBinLocal.clear();
  for (int il = 0; il < m_kNGroups; il++) {
    m_binValue[il].clear();
    m_binIndex[il].clear();
 
  }
 
  m_suffix.clear();
  tempconst.clear();
  m_onedcors.clear();
  return c_OK;
}

◆ checkPyExpRun()

bool checkPyExpRun ( PyObject * pyObj )

staticinherited

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

Checks if the PyObject can be converted to ExpRun.

Definition at line 28 of file CalibrationAlgorithm.cc.

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

◆ 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 312 of file CalibrationAlgorithm.cc.

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

◆ convertPyExpRun()

ExpRun convertPyExpRun ( PyObject * pyObj )

staticinherited

Performs the conversion of PyObject to ExpRun.

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

Definition at line 70 of file CalibrationAlgorithm.cc.

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

◆ CreateBinMapping()

void CreateBinMapping ( )

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

Definition at line 259 of file CDCDedx1DCellAlgorithm.cc.

{
 
  std::map<int, std::vector<double>> bounds;
  std::map<int, std::vector<int>> steps;
 
  // number of intervals for each unique configuration
  const std::array<int, 2> nDev{8, 4};
 
  // config 0 -> used for SL = 0,1
  bounds[0] = {0, 108, 123, 133, 158, 183, 193, 208, 316};
  steps[0]  = {9, 3, 2, 1, 1, 2, 3, 9};
 
  // config 1 -> used for SL = 2-8
  bounds[1] = {0, 38, 158, 278, 316};
  steps[1]  = {2, 1, 1, 2};
 
  // map SL -> configuration
  const std::array<int, m_kNGroups> configIndex = {0, 0, 1};
 
  for (int il = 0; il < m_kNGroups; il++) {
 
    int icfg = configIndex[il];
 
    std::vector<double> scaledBounds = bounds[icfg];
    for (int ibin = 0; ibin <= nDev[icfg]; ibin++) {
      scaledBounds[ibin] = scaledBounds[ibin] * m_binSplit;
    }
 
    int ieaprime = -1, temp = -99, ibin = 0;
 
    double pastbin = m_eaMin;
    m_binValue[il].push_back(pastbin);
 
    for (int iea = 0; iea < m_eaBin; iea++) {
 
      if (isVarBins) {
        if (iea % int(scaledBounds[ibin + 1]) == 0 && iea > 0) ibin++;
        int diff = iea - int(scaledBounds[ibin]);
        if (diff % steps[icfg][ibin] == 0) ieaprime++;
      } else {
        ieaprime = iea;
      }
 
      m_binIndex[il].push_back(ieaprime);
 
      if (ieaprime != temp) {
        double binwidth = m_eaBW;
        if (isVarBins) binwidth = m_eaBW * steps[icfg][ibin];
        double binvalue = pastbin + binwidth;
        pastbin = binvalue;
        if (std::abs(binvalue) < 1e-5) binvalue = 0;
        m_binValue[il].push_back(binvalue);
      }
      temp = ieaprime;
    }
 
    m_eaBinLocal.push_back(int(m_binValue[il].size()) - 1);
  }
 
  if (isMakePlots) plotMergeFactor(bounds, nDev, steps);
}

◆ createPayload()

void createPayload ( )

function to generate final constants

Definition at line 412 of file CDCDedx1DCellAlgorithm.cc.

{
 
  B2INFO("dE/dx one cell calibration: Generating payloads");
 
  for (unsigned int il = 0; il < m_kNGroups; il++) {
 
    if (isMerge) {
      unsigned int nbins = m_DBOneDCell->getNBins(getRepresentativeLayer(il));
 
      if (int(nbins) != m_eaBin)
        B2ERROR("merging failed because of unmatch bins (old " << m_eaBin << " new " << nbins << ")");
 
      for (unsigned int iea = 0; iea < nbins; iea++) {
        double prev = m_DBOneDCell->getMean(getRepresentativeLayer(il), iea);
        m_onedcors[il][iea] *= prev;
      }
    }
 
    double binsize = TMath::Pi() / m_onedcors[il].size();
 
    auto computeAverages = [&](double angLow, double angHigh) {
      unsigned int binLow = std::floor((angLow + TMath::Pi() / 2.0) / binsize);
      unsigned int binHigh = std::floor((angHigh + TMath::Pi() / 2.0) / binsize);
      double sum_new = 0.0, sum_prev = 0.0;
      int count = 0;
 
      for (unsigned int iea = binLow; iea < binHigh; ++iea) {
        sum_new += m_onedcors[il][iea];
        sum_prev += m_DBOneDCell->getMean(getRepresentativeLayer(il), iea);
        ++count;
      }
 
      double avg_new = (count > 0) ? sum_new / count : 1.0;
      double avg_prev = (count > 0) ? sum_prev / count : 1.0;
      return std::make_pair(avg_new, avg_prev);
    };
 
    double negLow = -0.5, negHigh = -0.2;
    double posLow = 0.2, posHigh = 0.5;
 
    if (il == 2) {
      negLow = -0.75; negHigh = -0.25;
      posLow = 0.25; posHigh = 0.75;
    }
 
    auto [avgNewNeg, avgPrevNeg] = computeAverages(negLow, negHigh);
    auto [avgNewPos, avgPrevPos] = computeAverages(posLow, posHigh);
 
    double avgNew = (avgNewNeg + avgNewPos) / 2.0;
    double avgPrev = (avgPrevNeg + avgPrevPos) / 2.0;
    double scaleFactor = avgPrev / avgNew;
 
    for (int iea = 0; iea < m_eaBin; iea++) {
      m_onedcors[il][iea] *= scaleFactor;
    }
 
    if (m_chargeType > 0)
      for (int ie = 0; ie < m_eaBin / 2; ie++) m_onedcors[il][ie] *= m_adjustFac;
    if (m_chargeType < 0)
      for (int ie = m_eaBin / 2; ie < m_eaBin; ie++) m_onedcors[il][ie] *= m_adjustFac;
 
  }
 
  //Saving constants
  B2INFO("dE/dx Calibration done for CDCDedx1DCell");
  std::vector<unsigned int> layerToGroup(56);
 
  for (unsigned int layer = 0; layer < 56; layer++) {
    if (layer < 8) layerToGroup[layer] = 0;        // SL0
    else if (layer < 14) layerToGroup[layer] = 1;  // SL1
    else layerToGroup[layer] = 2;                  // SL2-8
  }
 
  CDCDedx1DCell* gain = new CDCDedx1DCell(0, m_onedcors, layerToGroup);
  saveCalibration(gain, "CDCDedx1DCell");
}

◆ defineHisto()

void defineHisto	(	std::array< std::vector< TH1D * >, 3 > &	hdedxhit,
		std::array< TH1D *, 3 > &	hdedxlay,
		std::array< TH1D *, 3 > &	hentalay )

function to define histograms

Definition at line 324 of file CDCDedx1DCellAlgorithm.cc.

{
  for (int il = 0; il < m_kNGroups; il++) {
 
    std::string title = Form("dedxhit dist (%s): %s ; dedxhit;entries", m_label[il].data(), m_runExp.data());
    hdedxlay[il] = new TH1D(Form("hdedxlay%s", m_label[il].data()), "", m_dedxBin, m_dedxMin, m_dedxMax);
    hdedxlay[il]->SetTitle(title.c_str());
 
    Double_t* nvarBins = m_binValue[il].data();
 
    if (isVarBins)
      title = Form("entaRS dist (variable bins): %s: (%s); entaRS (#alpha);entries", m_label[il].data(), m_runExp.data());
    else
      title = Form("entaRS dist (sym. bins): %s: (%s); entaRS (#alpha);entries", m_label[il].data(), m_runExp.data());
 
    hentalay[il] = new TH1D(Form("hentalay%s", m_label[il].data()), "", m_eaBinLocal[il], nvarBins);
    hentalay[il]->SetTitle(title.c_str());
 
    for (int iea = 0; iea < m_eaBinLocal[il]; iea++) {
 
      double min = m_binValue[il].at(iea);
      double max = m_binValue[il].at(iea + 1);
      double width = max - min;
 
      if (isPrintLog)
        B2INFO("bin: " << iea << " ], min:" << min << " , max: " << max << " , width: " << width);
 
      title = Form("%s: entaRS = (%0.03f to %0.03f)", m_label[il].data(), min, max);
 
      hdedxhit[il].push_back(new TH1D(Form("hdedxhit_%s_bin%d", m_label[il].data(), iea),
                                      "", m_dedxBin, m_dedxMin, m_dedxMax));
 
      hdedxhit[il][iea]->SetTitle(title.c_str());
    }
  }
}

◆ dumpOutputJson()

const std::string dumpOutputJson ( ) const

inlineinherited

Dump the JSON string of the output JSON object.

Definition at line 223 of file CalibrationAlgorithm.h.

223{return m_jsonExecutionOutput.dump();}

◆ enableExtraPlots()

void enableExtraPlots ( bool value = false )

inline

funtion to set flag active for plotting

Definition at line 115 of file CDCDedx1DCellAlgorithm.h.

115{isMakePlots = value;}

◆ execute() [1/2]

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

inherited

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

Definition at line 83 of file CalibrationAlgorithm.cc.

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

◆ execute() [2/2]

CalibrationAlgorithm::EResult execute	(	std::vector< Calibration::ExpRun >	runs = {},
		int	iteration = 0,
		IntervalOfValidity	iov = IntervalOfValidity() )

inherited

Runs calibration over vector of runs for a given iteration.

You can also specify the IoV to save the database payload as. By default the Algorithm will create an IoV from your requested ExpRuns, or from the overall ExpRuns of the input data if you haven't specified ExpRuns in this function.

No checks are performed to make sure that a IoV you specify matches the data you ran over, it simply labels the IoV to commit to the database later.

Definition at line 114 of file CalibrationAlgorithm.cc.

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

◆ fillRunToInputFilesMap()

void fillRunToInputFilesMap ( )

inherited

Fill the mapping of ExpRun -> Files.

Definition at line 331 of file CalibrationAlgorithm.cc.

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

◆ findPayloadBoundaries()

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

inherited

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

Definition at line 521 of file CalibrationAlgorithm.cc.

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

◆ getAllGranularityExpRun()

static Calibration::ExpRun getAllGranularityExpRun ( )

inlinestaticprotectedinherited

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

Definition at line 327 of file CalibrationAlgorithm.h.

327{return m_allExpRun;}

◆ getCollectorName()

const std::string & getCollectorName ( ) const

inlineinherited

Alias for prefix.

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

Definition at line 164 of file CalibrationAlgorithm.h.

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 extract calibration run/exp

Definition at line 234 of file CDCDedx1DCellAlgorithm.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 eend = erEnd.first;
  int rend = erEnd.second;
 
  updateDBObjPtrs(1, rstart, estart);
 
  m_runExp = Form("Range (%d:%d,%d:%d)", estart, rstart, eend, rend);
  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()

const 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 384 of file CalibrationAlgorithm.cc.

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

◆ getInputFileNames()

PyObject * getInputFileNames ( )

inherited

Get the input file names used for this algorithm and pass them out as a Python list of unicode strings.

Definition at line 245 of file CalibrationAlgorithm.cc.

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

◆ getInputJsonObject()

const nlohmann::json & getInputJsonObject ( ) const

inlineprotectedinherited

Get the entire top level JSON object. We explicitly say this must be of object type so that we might pick.

Definition at line 357 of file CalibrationAlgorithm.h.

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 326 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 ( ) const

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

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

◆ getRepresentativeLayer()

unsigned int getRepresentativeLayer ( unsigned int il ) const

inline

Representative CDC layer for each SL group (used to access group-wise constants): SL0 => 1, SL1 => 9, SL2-8 => 17.

Definition at line 137 of file CDCDedx1DCellAlgorithm.h.

    {
      static const std::array<unsigned int, m_kNGroups> repLayer = {1, 9, 17};
      return repLayer.at(il);
    }

◆ 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 319 of file CalibrationAlgorithm.cc.

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

◆ getRunRangeFromAllData()

RunRange getRunRangeFromAllData ( ) const

inherited

Get the complete RunRange from inspection of collected data.

Definition at line 362 of file CalibrationAlgorithm.cc.

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

◆ getTruncatedBins()

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

function to get bins of truncation from histogram

Definition at line 364 of file CDCDedx1DCellAlgorithm.cc.

{
 
  //calculating truncation average
  double sum = hist->Integral();
  if (sum <= 0 || hist->GetNbinsX() <= 0) {
    binlow = 1; binhigh = 1;
    return ;
  }
 
  binlow = 1.0; binhigh = 1.0;
  double sumPer5 = 0.0, sumPer75 = 0.0;
  for (int ibin = 1; ibin <= hist->GetNbinsX(); ibin++) {
    double bcdedx = hist->GetBinContent(ibin);
    if (sumPer5  <= m_truncMin * sum) {
      sumPer5 += bcdedx;
      binlow = ibin;
    }
    if (sumPer75  <= m_truncMax * sum) {
      sumPer75 += bcdedx;
      binhigh = ibin;
    }
  }
  return;
}

◆ getTruncationMean()

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

function to get truncated mean

Definition at line 391 of file CDCDedx1DCellAlgorithm.cc.

{
 
  //calculating truncation average
  if (hist->Integral() < 100) return 1.0;
 
  if (binlow <= 0 || binhigh > hist->GetNbinsX())return 1.0;
 
  double binweights = 0., sumofbc = 0.;
  for (int ibin = binlow; ibin <= binhigh; ibin++) {
    double bcdedx = hist->GetBinContent(ibin);
    if (bcdedx > 0) {
      binweights += (bcdedx * hist->GetBinCenter(ibin));
      sumofbc += bcdedx;
    }
  }
  if (sumofbc > 0) return binweights / sumofbc;
  else return 1.0;
}

◆ getVecInputFileNames()

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

inlineprotectedinherited

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

Definition at line 275 of file CalibrationAlgorithm.h.

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

Definition at line 243 of file CalibrationAlgorithm.h.

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

◆ loadInputJson()

bool loadInputJson ( const std::string & jsonString )

inherited

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

Definition at line 503 of file CalibrationAlgorithm.cc.

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

◆ plotConstants()

void plotConstants ( )

function to draw the old/new final constants

Definition at line 701 of file CDCDedx1DCellAlgorithm.cc.

{
 
  //Draw New/Old final constants
  TH1D* hnewconst[m_kNGroups], *holdconst[m_kNGroups];
  double min[m_kNGroups], max[m_kNGroups];
 
  for (unsigned int il = 0; il < m_kNGroups; il++) {
    unsigned int nbins = m_DBOneDCell->getNBins(getRepresentativeLayer(il));
 
    std::string title = Form("final calibration const dist (%s): %s; entaRS (#alpha); entries", m_label[il].data(), m_runExp.data());
    hnewconst[il] = new TH1D(Form("hnewconst_%s", m_label[il].data()), "", m_eaBin, m_eaMin, m_eaMax);
    hnewconst[il]->SetTitle(Form("%s", title.data()));
 
    title = Form("old calibration const dist (%s): %s; entaRS (#alpha); entries", m_label[il].data(), m_runExp.data());
    holdconst[il] = new TH1D(Form("holdconst_%s", m_label[il].data()), "", m_eaBin, m_eaMin, m_eaMax);
    holdconst[il]->SetTitle(Form("%s", title.data()));
 
    for (unsigned int iea = 0; iea < nbins; iea++) {
      double prev = m_DBOneDCell->getMean(getRepresentativeLayer(il), iea);
      holdconst[il]->SetBinContent(iea + 1, prev);
      hnewconst[il]->SetBinContent(iea + 1, m_onedcors[il][iea]);
    }
    min[il] = hnewconst[il]->GetMinimum();
    max[il] = hnewconst[il]->GetMaximum();
  }
 
  //Ploting final constants
  double globalMin = min[0];
  double globalMax = max[0];
  for (int il = 1; il < m_kNGroups; il++) {
    if (min[il] < globalMin) globalMin = min[il];
    if (max[il] > globalMax) globalMax = max[il];
  }
 
  gStyle->SetOptStat("ne");
  TCanvas cfconst("cfconst", "Final calibration constants", 1600, 600);
  cfconst.Divide(3, 1);
 
  for (int il = 0; il < m_kNGroups; il++) {
    cfconst.cd(il + 1);
    hnewconst[il]->GetYaxis()->SetRangeUser(globalMin * 0.95, globalMax * 1.05);
    hnewconst[il]->SetLineColor(kBlack);
    hnewconst[il]->Draw("histo");
    holdconst[il]->SetLineColor(kRed);
    holdconst[il]->Draw("histo same");
 
    auto legend = new TLegend(0.4, 0.75, 0.56, 0.85);
    legend->AddEntry(holdconst[il], "Old", "lep");
    legend->AddEntry(hnewconst[il], "New", "lep");
    legend->Draw();
  }
 
  cfconst.SaveAs(Form("cdcdedx_1dcell_fconsts_%s.pdf", m_suffix.data()));
  cfconst.SaveAs(Form("cdcdedx_1dcell_fconsts_%s.root", m_suffix.data()));
 
  for (int il = 0; il < m_kNGroups; il++) {
    delete hnewconst[il];
    delete holdconst[il];
  }
}

◆ plotdedxHist()

void plotdedxHist ( std::array< std::vector< TH1D * >, m_kNGroups > & hdedxhit )

function to draw the dE/dx histogram in enta bins

Definition at line 528 of file CDCDedx1DCellAlgorithm.cc.

{
 
  TCanvas ctmp("tmp", "tmp", 1200, 1200);
  ctmp.Divide(4, 4);
  std::stringstream psname;
 
  psname << Form("cdcdedx_1dcell_dedxhit_%s.pdf[", m_suffix.data());
  ctmp.Print(psname.str().c_str());
  psname.str("");
  psname << Form("cdcdedx_1dcell_dedxhit_%s.pdf", m_suffix.data());
 
  for (int il = 0; il < m_kNGroups; il++) {
 
    for (int jea = 0; jea < m_eaBinLocal[il]; jea++) {
 
      int minbin = std::stoi(hdedxhit[il][jea]->GetXaxis()->GetTitle());
      int maxbin = std::stoi(hdedxhit[il][jea]->GetYaxis()->GetTitle());
 
      ctmp.cd(jea % 16 + 1);
      hdedxhit[il][jea]->SetFillColor(4 + il);
 
      hdedxhit[il][jea]->SetTitle(Form("%s;dedxhit;entries", hdedxhit[il][jea]->GetTitle()));
      hdedxhit[il][jea]->DrawClone("hist");
      TH1D* htempC = (TH1D*)hdedxhit[il][jea]->Clone(Form("%sc2", hdedxhit[il][jea]->GetName()));
      htempC->GetXaxis()->SetRange(minbin, maxbin);
      htempC->SetFillColor(kGray);
      htempC->DrawClone("same hist");
 
      if (jea % 16 == 15 || (jea == m_eaBinLocal[il] - 1)) {
        ctmp.Print(psname.str().c_str());
        gPad->Clear("D");
        ctmp.Clear("D");
      }
      delete htempC;
    }
  }
  psname.str("");
  psname << Form("cdcdedx_1dcell_dedxhit_%s.pdf]", m_suffix.data());
  ctmp.Print(psname.str().c_str());
}

◆ plotEventStats()

void plotEventStats ( )

function to draw the stats plots

Definition at line 764 of file CDCDedx1DCellAlgorithm.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("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_1dcell_stats_%s.pdf", m_suffix.data()));
}

◆ plotLayerDist()

void plotLayerDist ( std::array< TH1D *, m_kNGroups > & hdedxlay )

function to draw dedx dist.

for Inner/outer layer

Definition at line 571 of file CDCDedx1DCellAlgorithm.cc.

{
 
  TCanvas cdedxlayer("layerdedxhit", "Inner and Outer Layer dedxhit dist", 900, 400);
  cdedxlayer.Divide(3, 1);
 
  for (int il = 0; il < m_kNGroups; il++) {
    int minlay = 0, maxlay = 0;
    if (isFixTrunc) {
      minlay = std::stoi(hdedxlay[il]->GetXaxis()->GetTitle());
      maxlay = std::stoi(hdedxlay[il]->GetYaxis()->GetTitle());
      double lowedge = hdedxlay[il]->GetXaxis()->GetBinLowEdge(minlay);
      double upedge = hdedxlay[il]->GetXaxis()->GetBinUpEdge(maxlay);
      hdedxlay[il]->SetTitle(Form("%s, trunc #rightarrow: %0.02f - %0.02f;dedxhit;entries", hdedxlay[il]->GetTitle(), lowedge, upedge));
    }
 
    cdedxlayer.cd(il + 1);
    hdedxlay[il]->SetFillColor(kYellow);
    hdedxlay[il]->Draw("histo");
 
    if (isFixTrunc) {
      TH1D* hdedxlayC = (TH1D*)hdedxlay[il]->Clone(Form("hdedxlayC%d", il));
      hdedxlayC->GetXaxis()->SetRange(minlay, maxlay);
      hdedxlayC->SetFillColor(kAzure + 1);
      hdedxlayC->Draw("same histo");
    }
  }
 
  cdedxlayer.SaveAs(Form("cdcdedx_1dcell_dedxlayer_%s.pdf", m_suffix.data()));
  cdedxlayer.SaveAs(Form("cdcdedx_1dcell_dedxlayer_%s.root", m_suffix.data()));
}

◆ plotMergeFactor()

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

function to plot merging factor

Definition at line 491 of file CDCDedx1DCellAlgorithm.cc.

{
  TCanvas cmfactor("cmfactor", "Merging factors", 800, 400);
  cmfactor.Divide(2, 1);
 
  std::array<TH1I*, 2> hists{};
 
  for (int icfg = 0; icfg < 2; icfg++) {
    Double_t* nvarBins = bounds[icfg].data();
 
    hists[icfg] = new TH1I(Form("hist_cfg%d", icfg), "", nDev[icfg], nvarBins);
 
    if (icfg == 0)
      hists[icfg]->SetTitle("Merging factor for SL0/SL1 bins;binindex;merge-factors");
    else
      hists[icfg]->SetTitle("Merging factor for SL2-8 bins;binindex;merge-factors");
 
    for (int ibin = 0; ibin < nDev[icfg]; ibin++) {
      hists[icfg]->SetBinContent(ibin + 1, steps[icfg][ibin]);
    }
 
    cmfactor.cd(icfg + 1);
    hists[icfg]->SetFillColor(kYellow);
    hists[icfg]->Draw("hist");
  }
 
  cmfactor.SaveAs(Form("cdcdedx_1dcell_mergefactor_%s.pdf", m_suffix.data()));
  cmfactor.SaveAs(Form("cdcdedx_1dcell_mergefactor_%s.root", m_suffix.data()));
 
  for (int icfg = 0; icfg < 2; icfg++) {
    delete hists[icfg];
  }
}

◆ plotQaPars()

void plotQaPars	(	std::array< TH1D *, m_kNGroups > &	hentalay,
		TH2D *	hptcosth )

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

Definition at line 604 of file CDCDedx1DCellAlgorithm.cc.

{
 
  TCanvas ceadist("ceadist", "Enta distributions", 1600, 800);
  ceadist.Divide(3, 1);
 
  for (int il = 0; il < m_kNGroups; il++) {
 
    ceadist.cd(il + 1);
    gPad->SetLogy();
    hentalay[il]->SetFillColor(kYellow);
    hentalay[il]->Draw("hist");
  }
 
  TCanvas cptcos("cptcos", "pt vs costh dist.", 400, 400);
  cptcos.cd();
  hptcosth->Draw("colz");
 
  cptcos.SaveAs(Form("cdcdedx_ptcosth_%s.pdf", m_suffix.data()));
  ceadist.SaveAs(Form("cdcdedx_1dcell_enta_%s.pdf", m_suffix.data()));
  ceadist.SaveAs(Form("cdcdedx_1dcell_enta_%s.root", m_suffix.data()));
}

◆ plotRelConst()

void plotRelConst ( std::vector< std::vector< double > > & tempconst )

function to draw symm/Var layer constant

Definition at line 628 of file CDCDedx1DCellAlgorithm.cc.

{
 
  const std::string pdfName =
    Form("cdcdedx_1dcell_relconst_%s.pdf", m_suffix.data());
 
  const std::string rootName =
    Form("cdcdedx_1dcell_relconst_%s.root", m_suffix.data());
 
  TFile rootFile(rootName.c_str(), "RECREATE");
 
  for (int il = 0; il < m_kNGroups; il++) {
 
 
    TH1D* hconst = new TH1D(Form("hconst%s", m_label[il].data()), "", m_eaBin, m_eaMin, m_eaMax);
    std::string title = Form("calibration const dist: %s: (%s); entaRS (#alpha); entries", m_label[il].data(), m_runExp.data());
    hconst->SetTitle(Form("%s", title.data()));
 
    TH1D* hconstvar = nullptr;
 
    if (isVarBins) {
      Double_t* nvarBins;
      nvarBins = &m_binValue[il][0];
 
      hconstvar = new TH1D(Form("hconstvar%s", m_label[il].data()), "", m_eaBinLocal[il], nvarBins);
      title = Form("calibration const dist (var bins): %s: (%s); entaRS (#alpha);entries", m_label[il].data(), m_runExp.data());
      hconstvar->SetTitle(Form("%s", title.data()));
 
      for (int iea = 0; iea < m_eaBinLocal[il]; iea++)
        hconstvar->SetBinContent(iea + 1, tempconst.at(il).at(iea));
    }
 
    for (int jea = 0; jea < m_eaBin; jea++) hconst->SetBinContent(jea + 1, m_onedcors.at(il).at(jea));
 
    gStyle->SetOptStat("ne");
    TCanvas cconst("cconst", "calibration Constants", 800, 400);
    if (isVarBins) {
      cconst.Divide(2, 1);
      cconst.SetWindowSize(1000, 800);
    }
 
    cconst.cd(1);
    hconst->SetFillColor(kYellow);
    hconst->Draw("histo");
    if (isVarBins && hconstvar) {
      cconst.cd(2);
      hconstvar->SetFillColor(kBlue);
      hconstvar->Draw("hist");
    }
 
    cconst.Update();
 
    if (m_kNGroups == 1) {
      cconst.Print(pdfName.c_str());
    } else if (il == 0) {
      cconst.Print((pdfName + "(").c_str());
    } else if (il == m_kNGroups - 1) {
      cconst.Print((pdfName + ")").c_str());
    } else {
      cconst.Print(pdfName.c_str());
    }
 
    // Save this canvas in the ROOT file
    rootFile.cd();
    cconst.Write();
 
    delete hconst;
    delete hconstvar;
  }
  rootFile.Close();
}

◆ resetInputJson()

void resetInputJson ( )

inlineprotectedinherited

Clears the m_inputJson member variable.

Definition at line 330 of file CalibrationAlgorithm.h.

330{m_jsonExecutionInput.clear();}

◆ resetOutputJson()

void resetOutputJson ( )

inlineprotectedinherited

Clears the m_outputJson member variable.

Definition at line 333 of file CalibrationAlgorithm.h.

333{m_jsonExecutionOutput.clear();}

◆ rotationalBin()

int rotationalBin	(	int	nbin,
		int	ibin )

inline

class function to set rotation symmetry

Definition at line 161 of file CDCDedx1DCellAlgorithm.h.

    {
      if (nbin % 4 != 0)return ibin;
      int jbin = ibin;
      if (ibin < nbin / 4) jbin = ibin + nbin / 2 ;
      else if (ibin >= 3 * nbin / 4) jbin = ibin - nbin / 2 ;
      return jbin;
    }

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

◆ setAdjustmentFactor()

void setAdjustmentFactor ( int value )

inline

set adjustment factor

Definition at line 95 of file CDCDedx1DCellAlgorithm.h.

95{m_adjustFac = value;}

◆ setBaselineFactor()

void setBaselineFactor	(	double	charge,
		double	factor )

inline

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

Definition at line 147 of file CDCDedx1DCellAlgorithm.h.

    {
 
      m_adjustFac = factor;
      if (charge < 0)m_chargeType = -1.0;
      else if (charge > 0)m_chargeType = 1.0;
      else if (charge == 0)m_chargeType = 0.0;
      else
        B2FATAL("Choose charge value either +/-1 or 0");
    }

◆ setChargeType()

void setChargeType ( int value )

inline

set charge type

Definition at line 90 of file CDCDedx1DCellAlgorithm.h.

90{m_chargeType = value;}

◆ setCosLimit()

void setCosLimit ( double value )

inline

function to set costheta limit

Definition at line 72 of file CDCDedx1DCellAlgorithm.h.

72{m_cosMax = value;}

◆ setDescription()

void setDescription ( const std::string & description )

inlineprotectedinherited

Set algorithm description (in constructor)

Definition at line 321 of file CalibrationAlgorithm.h.

321{m_description = description;}

◆ setEntaBins()

void setEntaBins ( unsigned int value = 316 )

inline

function to set number of entrance angle bins for calibration

Definition at line 52 of file CDCDedx1DCellAlgorithm.h.

52{m_eaB = value;}

◆ setEntaRange()

void setEntaRange	(	double	min = -1.0,
		double	max = 1.0 )

inline

function to set min/max range of entrance angle for calibration

Definition at line 47 of file CDCDedx1DCellAlgorithm.h.

47{m_eaMin = min; m_eaMax = max;}

◆ setHistBins()

void setHistBins ( int value = 250 )

inline

function to set nbins of dedx dist for calibration

Definition at line 57 of file CDCDedx1DCellAlgorithm.h.

57{m_dedxBin = value;}

◆ setHistRange()

void setHistRange	(	double	min = 0.0,
		double	max = 5.0 )

inline

function to set min/max range of dedx dist for calibration

Definition at line 62 of file CDCDedx1DCellAlgorithm.h.

62{m_dedxMin = min; m_dedxMax = max;}

◆ setInputFileNames() [1/2]

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

protectedinherited

Set the input file names used for this algorithm.

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

Definition at line 194 of file CalibrationAlgorithm.cc.

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

◆ setInputFileNames() [2/2]

void setInputFileNames ( PyObject * inputFileNames )

inherited

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

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

Definition at line 166 of file CalibrationAlgorithm.cc.

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

◆ setLayerTrunc()

void setLayerTrunc ( bool value = false )

inline

function to set truncation method (local vs global)

Definition at line 100 of file CDCDedx1DCellAlgorithm.h.

100{isFixTrunc = value;}

◆ setMergePayload()

void setMergePayload ( bool value )

inline

set false if generating absolute (not relative) payload

Definition at line 126 of file CDCDedx1DCellAlgorithm.h.

126{ isMerge = value;}

◆ setOutputJsonValue()

template<class T>

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

inlineprotectedinherited

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

Definition at line 337 of file CalibrationAlgorithm.h.

337{m_jsonExecutionOutput[key] = value;}

◆ setPrefix()

void setPrefix ( const std::string & prefix )

inlineinherited

Set the prefix used to identify datastore objects.

Definition at line 167 of file CalibrationAlgorithm.h.

167{m_prefix = prefix;}

◆ setPrintLog()

void setPrintLog ( bool value = false )

inline

funtion to set flag to print log

Definition at line 120 of file CDCDedx1DCellAlgorithm.h.

120{isPrintLog = value;}

◆ setPtLimit()

void setPtLimit ( double value )

inline

function to set pt limit

Definition at line 67 of file CDCDedx1DCellAlgorithm.h.

67{m_ptMax = value;}

◆ setRotSymmetry()

void setRotSymmetry ( bool value )

inline

set rotation sys to copy constants from one region to other

Definition at line 110 of file CDCDedx1DCellAlgorithm.h.

110{isRotSymm = value;}

◆ setSplitFactor()

void setSplitFactor ( int value )

inline

set bin split factor for all range

Definition at line 85 of file CDCDedx1DCellAlgorithm.h.

85{m_binSplit = value;}

◆ setSuffix()

void setSuffix ( const std::string & value )

inline

adding suffix to control plots

Definition at line 131 of file CDCDedx1DCellAlgorithm.h.

131{m_suffix = value;}

◆ setTrucationBins()

void setTrucationBins	(	double	lowedge,
		double	upedge )

inline

function to set bins of truncation from histogram

Definition at line 77 of file CDCDedx1DCellAlgorithm.h.

    {
      m_truncMin = lowedge; m_truncMax = upedge ;
    }

◆ setVariableBins()

void setVariableBins ( bool value )

inline

Set Var bins flag to on or off.

Definition at line 105 of file CDCDedx1DCellAlgorithm.h.

105{isVarBins = value;}

◆ updateDBObjPtrs()

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

staticprotectedinherited

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

Definition at line 405 of file CalibrationAlgorithm.cc.

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

Member Data Documentation

◆ isFixTrunc

bool isFixTrunc

private

true = fix window for all out/inner layers

Definition at line 267 of file CDCDedx1DCellAlgorithm.h.

◆ isMakePlots

bool isMakePlots

private

produce plots for status

Definition at line 270 of file CDCDedx1DCellAlgorithm.h.

◆ isMerge

bool isMerge

private

print more debug information

Definition at line 272 of file CDCDedx1DCellAlgorithm.h.

◆ isPrintLog

bool isPrintLog

private

print more debug information

Definition at line 271 of file CDCDedx1DCellAlgorithm.h.

◆ isRotSymm

bool isRotSymm

private

if rotation symmetry requested

Definition at line 269 of file CDCDedx1DCellAlgorithm.h.

◆ isVarBins

bool isVarBins

private

true: if variable bin size is requested

Definition at line 268 of file CDCDedx1DCellAlgorithm.h.

◆ m_adjustFac

double m_adjustFac

private

factor with that one what to adjust baseline

Definition at line 265 of file CDCDedx1DCellAlgorithm.h.

◆ m_allExpRun

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

staticprivateinherited

allExpRun

Definition at line 364 of file CalibrationAlgorithm.h.

◆ m_binIndex

std::array<std::vector<int>, m_kNGroups> m_binIndex

private

symm/Var bin numbers

Definition at line 279 of file CDCDedx1DCellAlgorithm.h.

◆ m_binSplit

int m_binSplit

private

multiply nbins by this factor in full range

Definition at line 262 of file CDCDedx1DCellAlgorithm.h.

◆ m_binValue

std::array<std::vector<double>, m_kNGroups> m_binValue

private

enta Var bin values

Definition at line 280 of file CDCDedx1DCellAlgorithm.h.

◆ m_boundaries

std::vector<Calibration::ExpRun> m_boundaries

protectedinherited

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

Definition at line 261 of file CalibrationAlgorithm.h.

◆ m_chargeType

double m_chargeType

private

charge type for baseline adj

Definition at line 264 of file CDCDedx1DCellAlgorithm.h.

◆ m_cosMax

double m_cosMax

private

a limit on cos theta

Definition at line 257 of file CDCDedx1DCellAlgorithm.h.

◆ m_data

ExecutionData m_data

privateinherited

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

Definition at line 382 of file CalibrationAlgorithm.h.

◆ m_DBOneDCell

DBObjPtr<CDCDedx1DCell> m_DBOneDCell

private

One cell correction DB object.

Definition at line 284 of file CDCDedx1DCellAlgorithm.h.

◆ m_dedxBin

int m_dedxBin

private

of bins for dedxhit range

Definition at line 254 of file CDCDedx1DCellAlgorithm.h.

◆ m_dedxMax

double m_dedxMax

private

upper edge of dedxhit

Definition at line 253 of file CDCDedx1DCellAlgorithm.h.

◆ m_dedxMin

double m_dedxMin

private

lower edge of dedxhit

Definition at line 252 of file CDCDedx1DCellAlgorithm.h.

◆ m_description

std::string m_description {""}

privateinherited

Description of the algorithm.

Definition at line 385 of file CalibrationAlgorithm.h.

385{""};

◆ m_eaB

int m_eaB

private

reset # of bins for entrance angle for each experiment

Definition at line 250 of file CDCDedx1DCellAlgorithm.h.

◆ m_eaBin

int m_eaBin

private

of bins for entrance angle

Definition at line 249 of file CDCDedx1DCellAlgorithm.h.

◆ m_eaBinLocal

std::vector<int> m_eaBinLocal

private

of var bins for enta angle

Definition at line 278 of file CDCDedx1DCellAlgorithm.h.

◆ m_eaBW

double m_eaBW

private

binwdith of entrance angle bin

Definition at line 248 of file CDCDedx1DCellAlgorithm.h.

◆ m_eaMax

double m_eaMax

private

upper edge of entrance angle

Definition at line 247 of file CDCDedx1DCellAlgorithm.h.

◆ m_eaMin

double m_eaMin

private

lower edge of entrance angle

Definition at line 246 of file CDCDedx1DCellAlgorithm.h.

◆ m_granularityOfData

std::string m_granularityOfData

privateinherited

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

Definition at line 379 of file CalibrationAlgorithm.h.

◆ m_inputFileNames

std::vector<std::string> m_inputFileNames

privateinherited

List of input files to the Algorithm, will initially be user defined but then gets the wildcards expanded during execute()

Definition at line 373 of file CalibrationAlgorithm.h.

◆ m_jsonExecutionInput

nlohmann::json m_jsonExecutionInput = nlohmann::json::object()

privateinherited

Optional input JSON object used to make decisions about how to execute the algorithm code.

Definition at line 397 of file CalibrationAlgorithm.h.

◆ m_jsonExecutionOutput

nlohmann::json m_jsonExecutionOutput = nlohmann::json::object()

privateinherited

Optional output JSON object that can be set during the execution by the underlying algorithm code.

Definition at line 403 of file CalibrationAlgorithm.h.

◆ m_kNGroups

int m_kNGroups = 3

staticconstexpr

SL grouping: inner (SL0), middle (SL1), outer (SL2–8)

Definition at line 32 of file CDCDedx1DCellAlgorithm.h.

◆ m_label

std::string m_label[m_kNGroups] = {"SL0", "SL1", "SL2-8"}

private

add inner/outer superlayer label

Definition at line 276 of file CDCDedx1DCellAlgorithm.h.

276{"SL0", "SL1", "SL2-8"};

◆ m_onedcors

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

private

final vectors of calibration

Definition at line 282 of file CDCDedx1DCellAlgorithm.h.

◆ m_prefix

std::string m_prefix {""}

privateinherited

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

Definition at line 388 of file CalibrationAlgorithm.h.

388{""};

◆ m_ptMax

double m_ptMax

private

a limit on transverse momentum

Definition at line 256 of file CDCDedx1DCellAlgorithm.h.

◆ m_runExp

std::string m_runExp

private

add run and exp to title of plot

Definition at line 275 of file CDCDedx1DCellAlgorithm.h.

◆ m_runsToInputFiles

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

privateinherited

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

Definition at line 376 of file CalibrationAlgorithm.h.

◆ m_suffix

std::string m_suffix

private

add suffix to all plot name

Definition at line 274 of file CDCDedx1DCellAlgorithm.h.

◆ m_truncMax

double m_truncMax

private

upper threshold on truncation

Definition at line 260 of file CDCDedx1DCellAlgorithm.h.

◆ m_truncMin

double m_truncMin

private

lower threshold on truncation

Definition at line 259 of file CDCDedx1DCellAlgorithm.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ EResult

Constructor & Destructor Documentation

◆ CDCDedx1DCellAlgorithm()

◆ ~CDCDedx1DCellAlgorithm()

Member Function Documentation

◆ boundaryFindingSetup()

◆ boundaryFindingTearDown()

◆ calibrate()

◆ checkPyExpRun()

◆ clearCalibrationData()

◆ commit() [1/2]

◆ commit() [2/2]

◆ convertPyExpRun()

◆ CreateBinMapping()

◆ createPayload()

◆ defineHisto()

◆ dumpOutputJson()

◆ enableExtraPlots()

◆ execute() [1/2]

◆ execute() [2/2]

◆ fillRunToInputFilesMap()

◆ findPayloadBoundaries()

◆ getAllGranularityExpRun()

◆ getCollectorName()

◆ getDescription()

◆ getExpRunInfo()

◆ getExpRunString()

◆ getFullObjectPath()

◆ getGranularity()

◆ getGranularityFromData()

◆ getInputFileNames()

◆ getInputJsonObject()

◆ getInputJsonValue()

◆ getIovFromAllData()

◆ getIteration()

◆ getObjectPtr()

◆ getOutputJsonValue()

◆ getPayloads()

◆ getPayloadValues()

◆ getPrefix()

◆ getRepresentativeLayer()

◆ getRunList()

◆ getRunListFromAllData()

◆ getRunRangeFromAllData()

◆ getTruncatedBins()

◆ getTruncationMean()

◆ getVecInputFileNames()

◆ inputJsonKeyExists()

◆ isBoundaryRequired()

◆ loadInputJson()

◆ plotConstants()

◆ plotdedxHist()

◆ plotEventStats()

◆ plotLayerDist()

◆ plotMergeFactor()

◆ plotQaPars()

◆ plotRelConst()

◆ resetInputJson()

◆ resetOutputJson()

◆ rotationalBin()

◆ saveCalibration() [1/6]

◆ saveCalibration() [2/6]

◆ saveCalibration() [3/6]

◆ saveCalibration() [4/6]

◆ saveCalibration() [5/6]

◆ saveCalibration() [6/6]

◆ setAdjustmentFactor()

◆ setBaselineFactor()