eclMuMuEAlgorithm Class Reference

Calibrate ecl crystals using muon pair events. More...

#include <eclMuMuEAlgorithm.h>

Inheritance diagram for eclMuMuEAlgorithm:

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

Public Member Functions
	eclMuMuEAlgorithm ()
	..Constructor
virtual	~eclMuMuEAlgorithm ()
	..Destructor
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 algoithm (set by developers in constructor)
bool	loadInputJson (const std::string &jsonString)
	Load the m_inputJson variable from a string (useful from Python interface). The rturn bool indicates success or failure.
const std::string	dumpOutputJson () const
	Dump the JSON string of the output JSON object.
const std::vector< Calibration::ExpRun >	findPayloadBoundaries (std::vector< Calibration::ExpRun > runs, int iteration=0)
	Used to discover the ExpRun boundaries that you want the Python CAF to execute on. This is optional and only used in some.
template<>
std::shared_ptr< TTree >	getObjectPtr (const std::string &name, const std::vector< Calibration::ExpRun > &requestedRuns)
	Specialization of getObjectPtr<TTree>.

Public Attributes
int	cellIDLo
	..Parameters to control Novosibirsk fit to energy deposited in each crystal by mu+mu- events
int	cellIDHi
	Last cellID to be fit.
int	minEntries
	All crystals to be fit must have at least minEntries events in the fit range.
int	nToRebin
	If fewer entries than this, rebin and fix eta parameter.
double	tRatioMin
	entries/peak at low edge of fit must be greater than this
double	tRatioMax
	entries/peak at high edge of fit must be greater than this
double	lowerEdgeThresh
	Lower edge is where the fit = lowerEdgeThresh * peak value.
bool	performFits
	if false, input histograms are copied to output, but no fits are done.
bool	findExpValues
	if true, fits are used to find expected energy deposit for each crystal instead of the calibration constant
int	storeConst
	controls which values are written to the database.

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

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

Private Member Functions
std::string	getExpRunString (Calibration::ExpRun &expRun) const
	Gets the "exp.run" string repr. of (exp,run)
std::string	getFullObjectPath (const std::string &name, Calibration::ExpRun expRun) const
	constructs the full TDirectory + Key name of an object in a TFile based on its name and exprun

Private Attributes
int	fitOK = 16
	fit is OK
int	iterations = 8
	fit reached max number of iterations, but is useable
int	noLowerEdge = 5
	could not determine lower edge of fit
int	atLimit = 4
	a parameter is at the limit; fit not useable
int	poorFit = 3
	low chi square; fit not useable
int	notFit = -1
	no fit performed
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

Calibrate ecl crystals using muon pair events.

Definition at line 22 of file eclMuMuEAlgorithm.h.

Member Enumeration Documentation

EResult

enum EResult

inherited

The result of calibration.

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

Definition at line 40 of file CalibrationAlgorithm.h.

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

Constructor & Destructor Documentation

eclMuMuEAlgorithm()

eclMuMuEAlgorithm

(

)

..Constructor

Definition at line 56 of file eclMuMuEAlgorithm.cc.

                                    : CalibrationAlgorithm("eclMuMuECollector"), cellIDLo(1),
  cellIDHi(ECLElementNumbers::c_NCrystals), minEntries(150),
  nToRebin(1000), tRatioMin(0.05), tRatioMax(0.40), lowerEdgeThresh(0.10), performFits(true), findExpValues(false), storeConst(0)
{
  setDescription(
    "Perform energy calibration of ecl crystals by fitting a Novosibirsk function to energy deposited by muons"
  );
}

~eclMuMuEAlgorithm()

virtual ~eclMuMuEAlgorithm ( )

inlinevirtual

..Destructor

Definition at line 29 of file eclMuMuEAlgorithm.h.

{}

Member Function Documentation

boundaryFindingSetup()

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

inlineprotectedvirtualinherited

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

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

Definition at line 252 of file CalibrationAlgorithm.h.

{};

boundaryFindingTearDown()

virtual void boundaryFindingTearDown ( )

inlineprotectedvirtualinherited

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

Definition at line 257 of file CalibrationAlgorithm.h.

{};

calibrate()

CalibrationAlgorithm::EResult calibrate ( )

overrideprotectedvirtual

..Run algorithm on events

---

ranges of various fit parameters, and tolerance to determine that fit is at the limit

Put root into batch mode so that we don't try to open a graphics window

---

Write out the job parameters

---

Clean up existing histograms if necessary

---

Histograms containing the data collected by eclMuMuECollectorModule

---

Record the number of entries per crystal in the normalized energy histogram and calculate the average expected energy per crystal and calibration constants from Collector

---

Write out the basic histograms in all cases

---

If we have not been asked to do fits, we can quit now

---

Check that every crystal has enough entries.

Insufficient data. Quit if we are required to have a successful fit for every crystal

---

Some prep for the many fits about to follow

histograms to store results for database

Diagnostic histograms

1D summary histograms

---

Fits are requested and there is sufficient data. Loop over specified crystals and performs fits to the amplitude distributions

Project 1D histogram of energy in this crystal

Fit function (xmin, xmax, nparameters) for this histogram

Estimate initial parameters from the histogram. For peak, use maximum bin in the allowed range

eta is nominal values

---

Fit

Set the initial parameters

Fit

bins on either side of this value

look for the target value between these two points

---

Fit status

did not find lower edge

poor fit

parameter at limit

fill diagnostic histograms

1D summary histograms

Store histogram with fit

---

Interpret results of fit as expected energy or calibration constant

if the fit is not successful, set peakE and edge to -1, so that output calib = -1 * abs(input calib)

Find expected energies from MC, if requested

Otherwise, calibration constant

---

Write output to DB if requested and successful

Store expected energies

Store calibration constants

---

Write out diagnostic histograms

Histograms containing values written to DB

---

Clean up histograms in case Algorithm is called again

---

Set the return code appropriately

Implements CalibrationAlgorithm.

Definition at line 65 of file eclMuMuEAlgorithm.cc.

{
  double limitTol = 0.0005; /*< tolerance for checking if a parameter is at the limit */
  double minFitLimit = 1e-25; /*< cut off for labeling a fit as poor */
  double peakMin(0.4), peakMax(2.2); /*< range for peak of normalized energy distribution */
  double peakTol = limitTol * (peakMax - peakMin); /*< fit is at limit if it is within peakTol of min or max */
  double effSigMin(0.02), effSigMax(0.2); /*< range for effective sigma of normalized energy distribution */
  double effSigTol = limitTol * (effSigMax - effSigMin); /*< fit is at limit if it is within effSigTol of min or max */
  double etaNom(-0.41); /*< Nominal tail parameter; fixed to this value for low statistics fits */
  double etaMin(-1.), etaMax(0.); /*< Novosibirsk tail parameter range */
  double etaTol = limitTol * (etaMax - etaMin); /*< fit is at limit if it is within etaTol of min or max */
 
  gROOT->SetBatch();
 
  B2INFO("eclMuMuEAlgorithm parameters:");
  B2INFO("cellIDLo = " << cellIDLo);
  B2INFO("cellIDHi = " << cellIDHi);
  B2INFO("minEntries = " << minEntries);
  B2INFO("tRatioMin = " << tRatioMin);
  B2INFO("tRatioMax = " << tRatioMax);
  B2INFO("lowerEdgeThresh = " << lowerEdgeThresh);
  B2INFO("performFits = " << performFits);
  B2INFO("findExpValues = " << findExpValues);
  B2INFO("storeConst = " << storeConst);
 
  TH1F* dummy;
  dummy = (TH1F*)gROOT->FindObject("IntegralVsCrysID");
  if (dummy) {delete dummy;}
  dummy = (TH1F*)gROOT->FindObject("AverageExpECrys");
  if (dummy) {delete dummy;}
  dummy = (TH1F*)gROOT->FindObject("AverageElecCalib");
  if (dummy) {delete dummy;}
  dummy = (TH1F*)gROOT->FindObject("AverageInitCalib");
  if (dummy) {delete dummy;}
 
  auto TrkPerCrysID = getObjectPtr<TH1F>("TrkPerCrysID");
  auto EnVsCrysID = getObjectPtr<TH2F>("EnVsCrysID");
  auto ExpEvsCrys = getObjectPtr<TH1F>("ExpEvsCrys");
  auto ElecCalibvsCrys = getObjectPtr<TH1F>("ElecCalibvsCrys");
  auto InitialCalibvsCrys = getObjectPtr<TH1F>("InitialCalibvsCrys");
  auto CalibEntriesvsCrys = getObjectPtr<TH1F>("CalibEntriesvsCrys");
  auto RawDigitAmpvsCrys = getObjectPtr<TH2F>("RawDigitAmpvsCrys");
  auto RawDigitTimevsCrys = getObjectPtr<TH2F>("RawDigitTimevsCrys");
  auto hitCrysVsExtrapolatedCrys = getObjectPtr<TH2F>("hitCrysVsExtrapolatedCrys");
 
  TH1F* IntegralVsCrysID = new TH1F("IntegralVsCrysID", "Integral of EnVsCrysID for each crystal;crystal ID;Entries",
                                    ECLElementNumbers::c_NCrystals, 0, ECLElementNumbers::c_NCrystals);
  TH1F* AverageExpECrys = new TH1F("AverageExpECrys", "Average expected E per crys from collector;Crystal ID;Energy (GeV)",
                                   ECLElementNumbers::c_NCrystals, 0,
                                   ECLElementNumbers::c_NCrystals);
  TH1F* AverageElecCalib = new TH1F("AverageElecCalib", "Average electronics calib const vs crystal;Crystal ID;Calibration constant",
                                    ECLElementNumbers::c_NCrystals, 0, ECLElementNumbers::c_NCrystals);
  TH1F* AverageInitCalib = new TH1F("AverageInitCalib", "Average initial calib const vs crystal;Crystal ID;Calibration constant",
                                    ECLElementNumbers::c_NCrystals, 0, ECLElementNumbers::c_NCrystals);
 
  for (int crysID = 0; crysID < ECLElementNumbers::c_NCrystals; crysID++) {
    TH1D* hEnergy = EnVsCrysID->ProjectionY("hEnergy", crysID + 1, crysID + 1);
    int Integral = hEnergy->Integral();
    IntegralVsCrysID->SetBinContent(crysID + 1, Integral);
 
    double TotEntries = CalibEntriesvsCrys->GetBinContent(crysID + 1);
 
    double expectedE = 0.;
    if (TotEntries > 0.) {expectedE = ExpEvsCrys->GetBinContent(crysID + 1) / TotEntries;}
    AverageExpECrys->SetBinContent(crysID + 1, expectedE);
 
    double calibconst = 0.;
    if (TotEntries > 0.) {calibconst = ElecCalibvsCrys->GetBinContent(crysID + 1) / TotEntries;}
    AverageElecCalib->SetBinContent(crysID + 1, calibconst);
 
    calibconst = 0.;
    if (TotEntries > 0.) {calibconst = InitialCalibvsCrys->GetBinContent(crysID + 1) / TotEntries;}
    AverageInitCalib->SetBinContent(crysID + 1, calibconst);
  }
 
  TFile* histfile = new TFile("eclMuMuEAlgorithm.root", "recreate");
  TrkPerCrysID->Write();
  EnVsCrysID->Write();
  IntegralVsCrysID->Write();
  AverageExpECrys->Write();
  AverageElecCalib->Write();
  AverageInitCalib->Write();
  RawDigitAmpvsCrys->Write();
  RawDigitTimevsCrys->Write();
  hitCrysVsExtrapolatedCrys->Write();
 
  if (!performFits) {
    B2RESULT("eclMuMuEAlgorithm has not been asked to perform fits; copying input histograms and quitting");
    histfile->Close();
    return c_NotEnoughData;
  }
 
  bool sufficientData = true;
  for (int crysID = cellIDLo - 1; crysID < cellIDHi; crysID++) {
    if (IntegralVsCrysID->GetBinContent(crysID + 1) < minEntries) {
      if (storeConst == 1) {B2RESULT("eclMuMuEAlgorithm: crystal " << crysID << " has insufficient statistics: " << IntegralVsCrysID->GetBinContent(crysID + 1) << ". Requirement is " << minEntries);}
      sufficientData = false;
      break;
    }
  }
 
  if (!sufficientData && storeConst == 1) {
    histfile->Close();
    return c_NotEnoughData;
  }
 
  TH1F* CalibVsCrysID = new TH1F("CalibVsCrysID", "Calibration constant vs crystal ID;crystal ID;counts per GeV",
                                 ECLElementNumbers::c_NCrystals, 0, ECLElementNumbers::c_NCrystals);
  TH1F* ExpEnergyperCrys = new TH1F("ExpEnergyperCrys", "Expected energy per crystal;Crystal ID;Peak energy (GeV)",
                                    ECLElementNumbers::c_NCrystals, 0, ECLElementNumbers::c_NCrystals);
 
  TH1F* PeakVsCrysID = new TH1F("PeakVsCrysID", "Peak of Novo fit vs crystal ID;crystal ID;Peak normalized energy",
                                ECLElementNumbers::c_NCrystals, 0,
                                ECLElementNumbers::c_NCrystals);
  TH1F* EdgeVsCrysID = new TH1F("EdgeVsCrysID", "Lower edge of Novo fit vs crystal ID;crystal ID", ECLElementNumbers::c_NCrystals, 0,
                                ECLElementNumbers::c_NCrystals);
  TH1F* effSigVsCrysID = new TH1F("effSigVsCrysID", "effSigma vs crystal ID;crystal ID;sigma)", ECLElementNumbers::c_NCrystals, 0,
                                  ECLElementNumbers::c_NCrystals);
  TH1F* etaVsCrysID = new TH1F("etaVsCrysID", "eta vs crystal ID;crystal ID;Novo eta parameter", ECLElementNumbers::c_NCrystals, 0,
                               ECLElementNumbers::c_NCrystals);
  TH1F* normVsCrysID = new TH1F("normVsCrysID", "Novosibirsk normalization vs crystal ID;crystal ID;normalization",
                                ECLElementNumbers::c_NCrystals, 0, ECLElementNumbers::c_NCrystals);
  TH1F* lowerLimitVsCrysID = new TH1F("lowerLimitVsCrysID", "fit range lower limit vs crystal ID;crystal ID;lower fit limit",
                                      ECLElementNumbers::c_NCrystals, 0,
                                      ECLElementNumbers::c_NCrystals);
  TH1F* fitLimitVsCrysID = new TH1F("fitLimitVsCrysID", "fit range upper limit vs crystal ID;crystal ID;upper fit limit",
                                    ECLElementNumbers::c_NCrystals, 0,
                                    ECLElementNumbers::c_NCrystals);
  TH1F* StatusVsCrysID = new TH1F("StatusVsCrysID", "Fit status vs crystal ID;crystal ID;Fit status", ECLElementNumbers::c_NCrystals,
                                  0, ECLElementNumbers::c_NCrystals);
 
  TH1F* hStatus = new TH1F("hStatus", "Fit status", 25, -5, 20);
  TH1F* hPeak = new TH1F("hPeak", "Peaks of normalized energy distributions, successful fits;Peak of Novosibirsk fit", 200, 0.8, 1.2);
  TH1F* fracPeakUnc = new TH1F("fracPeakUnc", "Fractional uncertainty on peak uncertainty, successful fits;Uncertainty on peak", 100,
                               0, 0.1);
 
 
  bool allFitsOK = true;
  for (int crysID = cellIDLo - 1; crysID < cellIDHi; crysID++) {
 
    TString name = "Enormalized";
    name += crysID;
    TH1D* hEnergy = EnVsCrysID->ProjectionY(name, crysID + 1, crysID + 1);
 
    double histMin = hEnergy->GetXaxis()->GetXmin();
    double histMax = hEnergy->GetXaxis()->GetXmax();
    TF1* func = new TF1("eclNovoConst", eclNovoConst, histMin, histMax, 5);
    func->SetParNames("normalization", "peak", "effSigma", "eta", "const");
    func->SetParLimits(1, peakMin, peakMax);
    func->SetParLimits(2, effSigMin, effSigMax);
    func->SetParLimits(3, etaMin, etaMax);
 
    //..Currently not using the constant term
    double constant = 0.;
    func->FixParameter(4, constant);
 
    //..If low statistics, rebin, and fix eta
    if (hEnergy->GetEntries() < nToRebin) {
      hEnergy->Rebin(2);
      func->FixParameter(3, etaNom);
    }
 
    hEnergy->GetXaxis()->SetRangeUser(peakMin, peakMax);
    double peak = hEnergy->GetMaximum();
    int maxBin = hEnergy->GetMaximumBin();
    double peakE = hEnergy->GetBinLowEdge(maxBin);
    double peakEUnc = 0.;
    double normalization = hEnergy->GetMaximum();
    double normUnc = 0.;
    double effSigma = hEnergy->GetRMS();
    double sigmaUnc = 0.;
    hEnergy->GetXaxis()->SetRangeUser(histMin, histMax);
    double fitProb = 0.;
 
    double eta = etaNom;
    double etaUnc = 0.;
 
    //..Will find the lower edge of normalized energy at the end of the fit
    double lowerEnEdge = 0.;
 
    //..Fit range from set of bins with sufficient entries.
    double targetY = tRatioMin * peak;
    int iLow = maxBin;
    while (hEnergy->GetBinContent(iLow) > targetY) {iLow--;}
    double fitlow = hEnergy->GetBinLowEdge(iLow);
 
    targetY = tRatioMax * peak;
    int iHigh = maxBin;
    while (hEnergy->GetBinContent(iHigh) > targetY) {iHigh++;}
    double fithigh = hEnergy->GetBinLowEdge(iHigh + 1);
 
    bool fitHist = IntegralVsCrysID->GetBinContent(crysID + 1) >= minEntries; /* fit only if enough events */
    if (fitHist) {
 
      func->SetParameters(normalization, peakE, effSigma, eta, constant);
 
      hEnergy->Fit(func, "LIQ", "", fitlow, fithigh);
      normalization = func->GetParameter(0);
      normUnc = func->GetParError(0);
      peakE = func->GetParameter(1);
      peakEUnc = func->GetParError(1);
      effSigma = func->GetParameter(2);
      sigmaUnc = func->GetParError(2);
      eta = func->GetParameter(3);
      etaUnc = func->GetParError(3);
      fitProb = func->GetProb();
 
      //..Lower edge of the fit function is used to find the calibration constant.
      //  Can now use the peak of the fit, instead of the bin content.
      peak = func->Eval(peakE);
      targetY = lowerEdgeThresh * peak;
 
      iHigh = hEnergy->GetXaxis()->FindBin(peakE) + 1;
      iLow = hEnergy->GetXaxis()->FindBin(fitlow);
      int iLast = iHigh;
      for (int ibin = iHigh; ibin > iLow; ibin--) {
        double xc = hEnergy->GetBinCenter(ibin);
        if (func->Eval(xc) > targetY) {iLast = ibin;}
      }
      double xHigh = hEnergy->GetBinCenter(iLast);
      double xLow = hEnergy->GetBinCenter(iLast - 1);
 
      if (func->Eval(xLow) < targetY and func->Eval(xHigh) > targetY) {
        func->SetNpx(1000);
        lowerEnEdge = func->GetX(targetY, xLow, xHigh);
      }
    }
 
    int iStatus = fitOK; // success
 
    if (lowerEnEdge < 0.01) {iStatus = noLowerEdge;}
 
    if (fitProb <= minFitLimit) {iStatus = poorFit;}
 
    if ((peakE < peakMin + peakTol) || (peakE > peakMax - peakTol)) {iStatus = atLimit;}
    if ((effSigma < effSigMin + effSigTol) || (effSigma > effSigMax - effSigTol)) {iStatus = atLimit;}
    if ((eta < etaMin + etaTol) || (eta > etaMax - etaTol)) {iStatus = atLimit;}
 
    //** No fit
    if (!fitHist) {iStatus = notFit;} // not fit
 
    int histbin = crysID + 1;
    PeakVsCrysID->SetBinContent(histbin, peakE);
    PeakVsCrysID->SetBinError(histbin, peakEUnc);
    EdgeVsCrysID->SetBinContent(histbin, lowerEnEdge);
    EdgeVsCrysID->SetBinError(histbin, peakEUnc); // approximate
    effSigVsCrysID->SetBinContent(histbin, effSigma);
    effSigVsCrysID->SetBinError(histbin, sigmaUnc);
    etaVsCrysID->SetBinContent(histbin, eta);
    etaVsCrysID->SetBinError(histbin, etaUnc);
    normVsCrysID->SetBinContent(histbin, normalization);
    normVsCrysID->SetBinError(histbin, normUnc);
    lowerLimitVsCrysID->SetBinContent(histbin, fitlow);
    lowerLimitVsCrysID->SetBinError(histbin, 0);
    fitLimitVsCrysID->SetBinContent(histbin, fithigh);
    fitLimitVsCrysID->SetBinError(histbin, 0);
    StatusVsCrysID->SetBinContent(histbin, iStatus);
    StatusVsCrysID->SetBinError(histbin, 0);
 
    hStatus->Fill(iStatus);
    if (iStatus >= iterations) {
      hPeak->Fill(peakE);
      fracPeakUnc->Fill(peakEUnc / peakE);
    }
 
    B2INFO("cellID " << crysID + 1 << " status = "  << iStatus << " fit probability = " << fitProb);
    histfile->cd();
    hEnergy->Write();
 
  } /* end of loop over crystals */
 
  for (int crysID = 0; crysID < ECLElementNumbers::c_NCrystals; crysID++) {
    int histbin = crysID + 1;
    double fitstatus = StatusVsCrysID->GetBinContent(histbin);
    double peakE = PeakVsCrysID->GetBinContent(histbin);
    double edge = EdgeVsCrysID->GetBinContent(histbin);
    double fracpeakEUnc = PeakVsCrysID->GetBinError(histbin) / peakE;
 
    if (fitstatus < iterations) {
      peakE = -1.;
      edge = -1.;
      fracpeakEUnc = 0.;
      if (histbin >= cellIDLo && histbin <= cellIDHi) {
        B2RESULT("eclMuMuEAlgorithm: cellID " << histbin << " is not a successful fit. Status = " << fitstatus);
        allFitsOK = false;
      }
    }
 
    if (findExpValues) {
      double inputExpE = abs(AverageExpECrys->GetBinContent(histbin));
      ExpEnergyperCrys->SetBinContent(histbin, inputExpE * edge);
      ExpEnergyperCrys->SetBinError(histbin, fracpeakEUnc * inputExpE * peakE);
    } else {
 
      double inputCalib = abs(AverageInitCalib->GetBinContent(histbin));
      CalibVsCrysID->SetBinContent(histbin, inputCalib / edge);
      CalibVsCrysID->SetBinError(histbin, fracpeakEUnc * inputCalib / peakE);
    }
  }
 
  bool DBsuccess = false;
  if (storeConst == 0 || (storeConst == 1 && allFitsOK)) {
    DBsuccess = true;
    if (findExpValues) {
 
      std::vector<float> tempE;
      std::vector<float> tempUnc;
      for (int crysID = 0; crysID < ECLElementNumbers::c_NCrystals; crysID++) {
        tempE.push_back(ExpEnergyperCrys->GetBinContent(crysID + 1));
        tempUnc.push_back(ExpEnergyperCrys->GetBinError(crysID + 1));
      }
      ECLCrystalCalib* ExpectedE = new ECLCrystalCalib();
      ExpectedE->setCalibVector(tempE, tempUnc);
      saveCalibration(ExpectedE, "ECLExpMuMuE");
      B2RESULT("eclCosmicEAlgorithm: successfully stored expected energies ECLExpMuMuE");
 
    } else {
 
      std::vector<float> tempCalib;
      std::vector<float> tempCalibUnc;
      for (int crysID = 0; crysID < ECLElementNumbers::c_NCrystals; crysID++) {
        tempCalib.push_back(CalibVsCrysID->GetBinContent(crysID + 1));
        tempCalibUnc.push_back(CalibVsCrysID->GetBinError(crysID + 1));
      }
      ECLCrystalCalib* MuMuECalib = new ECLCrystalCalib();
      MuMuECalib->setCalibVector(tempCalib, tempCalibUnc);
      saveCalibration(MuMuECalib, "ECLCrystalEnergyMuMu");
      B2RESULT("eclMuMuEAlgorithm: successfully stored ECLCrystalEnergyMuMu calibration constants");
    }
  }
 
  PeakVsCrysID->Write();
  EdgeVsCrysID->Write();
  effSigVsCrysID->Write();
  etaVsCrysID->Write();
  normVsCrysID->Write();
  lowerLimitVsCrysID->Write();
  fitLimitVsCrysID->Write();
  StatusVsCrysID->Write();
  hPeak->Write();
  fracPeakUnc->Write();
  hStatus->Write();
 
  if (findExpValues) {
    ExpEnergyperCrys->Write();
  } else {
    CalibVsCrysID->Write();
  }
  histfile->Close();
 
  dummy = (TH1F*)gROOT->FindObject("PeakVsCrysID"); delete dummy;
  dummy = (TH1F*)gROOT->FindObject("EdgeVsCrysID"); delete dummy;
  dummy = (TH1F*)gROOT->FindObject("effSigVsCrysID"); delete dummy;
  dummy = (TH1F*)gROOT->FindObject("etaVsCrysID"); delete dummy;
  dummy = (TH1F*)gROOT->FindObject("normVsCrysID"); delete dummy;
  dummy = (TH1F*)gROOT->FindObject("lowerLimitVsCrysID"); delete dummy;
  dummy = (TH1F*)gROOT->FindObject("fitLimitVsCrysID"); delete dummy;
  dummy = (TH1F*)gROOT->FindObject("StatusVsCrysID"); delete dummy;
  dummy = (TH1F*)gROOT->FindObject("fitProbSame"); delete dummy;
  dummy = (TH1F*)gROOT->FindObject("fracPeakUnc"); delete dummy;
  dummy = (TH1F*)gROOT->FindObject("hStatus"); delete dummy;
  dummy = (TH1F*)gROOT->FindObject("ExpEnergyperCrys"); delete dummy;
  dummy = (TH1F*)gROOT->FindObject("CalibVsCrysID"); delete dummy;
 
 
  if (storeConst == -1) {
    B2RESULT("eclMuMuEAlgorithm performed fits but was not asked to store contants");
    return c_Failure;
  } else if (!DBsuccess) {
    if (findExpValues) { B2RESULT("eclMuMuEAlgorithm: failed to store expected values"); }
    else { B2RESULT("eclMuMuEAlgorithm: failed to store calibration constants"); }
    return c_Failure;
  }
  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.

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

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

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

Definition at line 164 of file CalibrationAlgorithm.h.

{return getPrefix();}

getDescription()

const std::string & getDescription ( ) const

inlineinherited

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

Definition at line 216 of file CalibrationAlgorithm.h.

{return m_description;}

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.

{return m_granularityOfData;};

getGranularityFromData()

string getGranularityFromData ( ) const

protectedinherited

Get the granularity of collected data.

Definition at line 383 of file CalibrationAlgorithm.cc.

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

getInputFileNames()

PyObject * getInputFileNames ( )

inherited

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

Definition at line 245 of file CalibrationAlgorithm.cc.

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

getInputJsonObject()

const nlohmann::json & getInputJsonObject ( ) const

inlineprotectedinherited

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

Definition at line 357 of file CalibrationAlgorithm.h.

{return m_jsonExecutionInput;}

getInputJsonValue()

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

inlineprotectedinherited

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

Definition at line 350 of file CalibrationAlgorithm.h.

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

{ return m_data.getIteration(); }

getObjectPtr()

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

inlineprotectedinherited

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

Definition at line 285 of file CalibrationAlgorithm.h.

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

getOutputJsonValue()

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

inlineprotectedinherited

Get a value using a key from the JSON output object, not sure why you would want to do this.

Definition at line 342 of file CalibrationAlgorithm.h.

    {
      return m_jsonExecutionOutput.at(key);
    }

getPayloads()

std::list< Database::DBImportQuery > & getPayloads ( )

inlineinherited

Get constants (in TObjects) for database update from last execution.

Definition at line 204 of file CalibrationAlgorithm.h.

{return m_data.getPayloads();}

getPayloadValues()

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

inlineinherited

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

Definition at line 207 of file CalibrationAlgorithm.h.

{return m_data.getPayloadValues();}

getPrefix()

std::string getPrefix ( ) const

inlineinherited

Get the prefix used for getting calibration data.

Definition at line 146 of file CalibrationAlgorithm.h.

{return m_prefix;}

getRunList()

const std::vector< Calibration::ExpRun > & getRunList ( ) const

inlineprotectedinherited

Get the list of runs for which calibration is called.

Definition at line 266 of file CalibrationAlgorithm.h.

{return m_data.getRequestedRuns();}

getRunListFromAllData()

vector< ExpRun > getRunListFromAllData ( ) const

inherited

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

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

{return m_inputFileNames;}

inputJsonKeyExists()

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

inlineprotectedinherited

Test for a key in the input JSON object.

Definition at line 360 of file CalibrationAlgorithm.h.

{return m_jsonExecutionInput.count(key);}

isBoundaryRequired()

virtual bool isBoundaryRequired ( const Calibration::ExpRun &  )

inlineprotectedvirtualinherited

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

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

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

resetInputJson()

void resetInputJson ( )

inlineprotectedinherited

Clears the m_inputJson member variable.

Definition at line 330 of file CalibrationAlgorithm.h.

{m_jsonExecutionInput.clear();}

resetOutputJson()

void resetOutputJson ( )

inlineprotectedinherited

Clears the m_outputJson member variable.

Definition at line 333 of file CalibrationAlgorithm.h.

{m_jsonExecutionOutput.clear();}

saveCalibration() [1/6]

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

protectedinherited

Store DBArray payload with given name with default IOV.

Definition at line 297 of file CalibrationAlgorithm.cc.

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

saveCalibration() [2/6]

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

protectedinherited

Store DBArray with given name and custom IOV.

Definition at line 276 of file CalibrationAlgorithm.cc.

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

saveCalibration() [3/6]

void saveCalibration ( TObject *  data )

protectedinherited

Store DB payload with default name and default IOV.

Definition at line 287 of file CalibrationAlgorithm.cc.

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

saveCalibration() [4/6]

void saveCalibration ( TObject *  data, const IntervalOfValidity &  iov  )

protectedinherited

Store DB payload with default name and custom IOV.

Definition at line 282 of file CalibrationAlgorithm.cc.

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

saveCalibration() [5/6]

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

protectedinherited

Store DB payload with given name with default IOV.

Definition at line 292 of file CalibrationAlgorithm.cc.

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

saveCalibration() [6/6]

void saveCalibration ( TObject *  data, const std::string &  name, const IntervalOfValidity &  iov  )

protectedinherited

Store DB payload with given name and custom IOV.

Definition at line 270 of file CalibrationAlgorithm.cc.

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

setDescription()

void setDescription ( const std::string &  description )

inlineprotectedinherited

Set algorithm description (in constructor)

Definition at line 321 of file CalibrationAlgorithm.h.

{m_description = description;}

setInputFileNames() [1/2]

void setInputFileNames ( PyObject *  inputFileNames )

inherited

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

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

Definition at line 166 of file CalibrationAlgorithm.cc.

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

setInputFileNames() [2/2]

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

protectedinherited

Set the input file names used for this algorithm.

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

Definition at line 194 of file CalibrationAlgorithm.cc.

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

setOutputJsonValue()

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

inlineprotectedinherited

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

Definition at line 337 of file CalibrationAlgorithm.h.

{m_jsonExecutionOutput[key] = value;}

setPrefix()

void setPrefix ( const std::string &  prefix )

inlineinherited

Set the prefix used to identify datastore objects.

Definition at line 167 of file CalibrationAlgorithm.h.

{m_prefix = prefix;}

updateDBObjPtrs()

void updateDBObjPtrs ( const unsigned int  event = 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 unnessary...)
  DBStore::Instance().updateEvent(event);
}

Member Data Documentation

atLimit

int atLimit = 4

private

a parameter is at the limit; fit not useable

Definition at line 55 of file eclMuMuEAlgorithm.h.

cellIDHi

int cellIDHi

Last cellID to be fit.

Definition at line 33 of file eclMuMuEAlgorithm.h.

cellIDLo

int cellIDLo

..Parameters to control Novosibirsk fit to energy deposited in each crystal by mu+mu- events

First cellID to be fit

Definition at line 32 of file eclMuMuEAlgorithm.h.

findExpValues

bool findExpValues

if true, fits are used to find expected energy deposit for each crystal instead of the calibration constant

Definition at line 40 of file eclMuMuEAlgorithm.h.

fitOK

int fitOK = 16

private

fit is OK

Definition at line 52 of file eclMuMuEAlgorithm.h.

iterations

int iterations = 8

private

fit reached max number of iterations, but is useable

Definition at line 53 of file eclMuMuEAlgorithm.h.

lowerEdgeThresh

double lowerEdgeThresh

Lower edge is where the fit = lowerEdgeThresh * peak value.

Definition at line 38 of file eclMuMuEAlgorithm.h.

m_allExpRun

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

staticprivateinherited

allExpRun

Definition at line 364 of file CalibrationAlgorithm.h.

m_boundaries

std::vector<Calibration::ExpRun> m_boundaries

protectedinherited

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

Definition at line 261 of file CalibrationAlgorithm.h.

m_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_description

std::string m_description {""}

privateinherited

Description of the algorithm.

Definition at line 385 of file CalibrationAlgorithm.h.

m_granularityOfData

std::string m_granularityOfData

privateinherited

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

Definition at line 379 of file CalibrationAlgorithm.h.

m_inputFileNames

std::vector<std::string> m_inputFileNames

privateinherited

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

Definition at line 373 of file CalibrationAlgorithm.h.

m_jsonExecutionInput

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

privateinherited

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

Definition at line 397 of file CalibrationAlgorithm.h.

m_jsonExecutionOutput

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

privateinherited

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

Definition at line 403 of file CalibrationAlgorithm.h.

m_prefix

std::string m_prefix {""}

privateinherited

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

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

minEntries

int minEntries

All crystals to be fit must have at least minEntries events in the fit range.

Definition at line 34 of file eclMuMuEAlgorithm.h.

noLowerEdge

int noLowerEdge = 5

private

could not determine lower edge of fit

Definition at line 54 of file eclMuMuEAlgorithm.h.

notFit

int notFit = -1

private

no fit performed

Definition at line 57 of file eclMuMuEAlgorithm.h.

nToRebin

int nToRebin

If fewer entries than this, rebin and fix eta parameter.

Definition at line 35 of file eclMuMuEAlgorithm.h.

performFits

bool performFits

if false, input histograms are copied to output, but no fits are done.

Definition at line 39 of file eclMuMuEAlgorithm.h.

poorFit

int poorFit = 3

private

low chi square; fit not useable

Definition at line 56 of file eclMuMuEAlgorithm.h.

storeConst

int storeConst

controls which values are written to the database.

0 (default): store value found by successful fits, or -|input value| otherwise; -1 : do not store values 1 : store values if every fit for [cellIDLo,cellIDHi] was successful

Definition at line 41 of file eclMuMuEAlgorithm.h.

tRatioMax

double tRatioMax

entries/peak at high edge of fit must be greater than this

Definition at line 37 of file eclMuMuEAlgorithm.h.

tRatioMin

double tRatioMin

entries/peak at low edge of fit must be greater than this

Definition at line 36 of file eclMuMuEAlgorithm.h.

---

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

• ecl/calibration/include/eclMuMuEAlgorithm.h
• ecl/calibration/src/eclMuMuEAlgorithm.cc