eclee5x5Algorithm Class Reference

Calibrate ecl crystals using Bhabha events. More...

#include <eclee5x5Algorithm.h>

Inheritance diagram for eclee5x5Algorithm:

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

Public Member Functions
	eclee5x5Algorithm ()
	..Constructor
virtual	~eclee5x5Algorithm ()
	..Destructor
void	setOutputName (const std::string &outputName)
	Setter for m_outputName.
std::string	getOutputName ()
	Getter for m_outputName.
void	setMinEntries (int minEntries)
	Setter for m_minEntries.
int	getMinEntries ()
	Getter for m_minEntries.
void	setPayloadName (const std::string &payloadname)
	Setter for m_payloadName.
std::string	getPayloadName ()
	Getter for m_payloadname.
void	setStoreConst (bool storeConst)
	Setter for m_storeConst.
bool	getStoreConst ()
	Getter for m_storeConst.
void	setfracLo (double fracLo)
	Setter for m_fracLo.
double	getfracLo ()
	Getter for m_fracLo.
void	setfracHiSym (double fracHiSym)
	Setter for m_fracHiSym.
double	getfracHiSym ()
	Getter for m_fracHiSym.
void	setfracHiASym (double fracHiASym)
	Setter for m_fracHiASym.
double	getfracHiASym ()
	Getter for m_fracHiASym.
void	setnsigLo (double nsigLo)
	Setter for m_nsigLo.
double	getnsigLo ()
	Getter for m_nsigLo.
void	setnsigHiSym (double nsigHiSym)
	Setter for m_nsigHiSym.
double	getnsigHiSym ()
	Getter for m_nsigHiSym.
void	setnsigHiASym (double nsigHiASym)
	Setter for m_nsigHiASym.
double	getnsigHiASym ()
	Getter for m_nsigHiASym.
void	setlastLoThetaID (int lastLoThetaID)
	Setter for m_lastLoThetaID.
int	getlastLoThetaID ()
	Getter for m_lastLoThetaID.
std::string	getPrefix () const
	Get the prefix used for getting calibration data.
bool	checkPyExpRun (PyObject *pyObj)
	Checks that a PyObject can be successfully converted to an ExpRun type.
Calibration::ExpRun	convertPyExpRun (PyObject *pyObj)
	Performs the conversion of PyObject to ExpRun.
std::string	getCollectorName () const
	Alias for prefix.
void	setPrefix (const std::string &prefix)
	Set the prefix used to identify datastore objects.
void	setInputFileNames (PyObject *inputFileNames)
	Set the input file names used for this algorithm from a Python list.
PyObject *	getInputFileNames ()
	Get the input file names used for this algorithm and pass them out as a Python list of unicode strings.
std::vector< Calibration::ExpRun >	getRunListFromAllData () const
	Get the complete list of runs from inspection of collected data.
RunRange	getRunRangeFromAllData () const
	Get the complete RunRange from inspection of collected data.
IntervalOfValidity	getIovFromAllData () const
	Get the complete IoV from inspection of collected data.
void	fillRunToInputFilesMap ()
	Fill the mapping of ExpRun -> Files.
std::string	getGranularity () const
	Get the granularity of collected data.
EResult	execute (std::vector< Calibration::ExpRun > runs={}, int iteration=0, IntervalOfValidity iov=IntervalOfValidity())
	Runs calibration over vector of runs for a given iteration.
EResult	execute (PyObject *runs, int iteration=0, IntervalOfValidity iov=IntervalOfValidity())
	Runs calibration over Python list of runs. Converts to C++ and then calls the other execute() function.
std::list< Database::DBImportQuery > &	getPayloads ()
	Get constants (in TObjects) for database update from last execution.
std::list< Database::DBImportQuery >	getPayloadValues ()
	Get constants (in TObjects) for database update from last execution but passed by VALUE.
bool	commit ()
	Submit constants from last calibration into database.
bool	commit (std::list< Database::DBImportQuery > payloads)
	Submit constants from a (potentially previous) set of payloads.
const std::string &	getDescription () const
	Get the description of the algorithm (set by developers in constructor)
bool	loadInputJson (const std::string &jsonString)
	Load the m_inputJson variable from a string (useful from Python interface). The return bool indicates success or failure.
const std::string	dumpOutputJson () const
	Dump the JSON string of the output JSON object.
const std::vector< Calibration::ExpRun >	findPayloadBoundaries (std::vector< Calibration::ExpRun > runs, int iteration=0)
	Used to discover the ExpRun boundaries that you want the Python CAF to execute on. This is optional and only used in some.
template<>
std::shared_ptr< TTree >	getObjectPtr (const std::string &name, const std::vector< Calibration::ExpRun > &requestedRuns)
	Specialization of getObjectPtr<TTree>.

Protected Member Functions
virtual EResult	calibrate () override
	..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 internally during calibrate()
template<class T >
const T	getOutputJsonValue (const std::string &key) const
	Get a value using a key from the JSON output object, not sure why you would want to do this.
template<class T >
const T	getInputJsonValue (const std::string &key) const
	Get an input JSON value using a key. The normal exceptions are raised when the key doesn't exist.
const nlohmann::json &	getInputJsonObject () const
	Get the entire top level JSON object. We explicitly say this must be of object type so that we might pick.
bool	inputJsonKeyExists (const std::string &key) const
	Test for a key in the input JSON object.

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

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

Private Attributes
std::string	m_outputName = "eclee5x5Algorithm.root"
	..Parameters to control job to find energy calibration using Bhabhas
int	m_minEntries = 150
	all crystals to be calibrated must have this many entries
std::string	m_payloadName = "ECLCrystalEnergy5x5"
	Name of the payload to be stored.
bool	m_storeConst = true
	write payload to localdb if true
ECL::ECLNeighbours *	m_eclNeighbours5x5 {nullptr}
	Neighbours, used to get nCrys per ring.
double	m_fracLo = 0.2
	start dPhi fit where data is > fraclo*peak
double	m_fracHiSym = 0.2
	end dPhi fit where data is > fracHiSym*peak
double	m_fracHiASym = 0.4
	or fracHiASym*peak, at low values of thetaID
double	m_nsigLo = 2.5
	dPhi region is mean - nsigLo*sigma
double	m_nsigHiSym = 2.5
	to mean + nsigHiSym*sigma
double	m_nsigHiASym = 2.0
	or mean+nsigHiASym*sigma at low thetaID
int	m_lastLoThetaID = 4
	use asymmetric dPhi range for thetaID<= this value
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 Bhabha events.

Definition at line 25 of file eclee5x5Algorithm.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

eclee5x5Algorithm()

eclee5x5Algorithm

(

)

..Constructor

---

Definition at line 30 of file eclee5x5Algorithm.cc.

                                    : CalibrationAlgorithm("eclee5x5Collector")
{
  setDescription(
    "Perform energy calibration of ecl crystals by analyzing energy in 25-crystal sums from Bhabha events"
  );
}

~eclee5x5Algorithm()

virtual ~eclee5x5Algorithm ( )

inlinevirtual

..Destructor

Definition at line 32 of file eclee5x5Algorithm.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

---

Clean up existing histograms if necessary

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

---

Write out the job parameters

---

Histograms containing the data collected by eclee5x5CollectorModule

---

Calculate the average expected energy per crystal and calibration constants from Collector, and mean normalized energy

---

Write out the basic histograms in all cases

---

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

---

Check that all crystals to be calibrated have enough statistics

Only crystals with initial calib>0 are going to be calibrated

---

need crystal per ring for the dPhi payloads

---

Ready to find new calibration constants

---

Expected energy payload

---

Single crystal energy calibration from matrix inversion

---

Obtain new values for dPhi* selection, either data or mc

first thetaID with enough statistics

last thetaID with enough statistics

not equal to mean at low thetaID

---

Invalid payload specified

---

Write out appropriate histograms, then delete in case algorithm is called again

---

Set the return code appropriately

Implements CalibrationAlgorithm.

Definition at line 37 of file eclee5x5Algorithm.cc.

{
  TH1F* 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;}
  dummy = (TH1F*)gROOT->FindObject("meanEnvsCrysID");
  if (dummy) {delete dummy;}
 
  gROOT->SetBatch();
 
  B2INFO("eclee5x5Algorithm parameters:");
  B2INFO("outputName = " << m_outputName);
  B2INFO("minEntries = " << m_minEntries);
  B2INFO("payloadName = " << m_payloadName);
  B2INFO("storeConst = " << m_storeConst);
  if (m_payloadName == "ECLeedPhiData" or m_payloadName == "ECLeedPhiMC" or m_payloadName == "None") {
    B2INFO("fracLo = " << m_fracLo);
    B2INFO("fracHiSym = " << m_fracHiSym);
    B2INFO("fracHiASym = " << m_fracHiASym);
    B2INFO("nsigLo = " << m_nsigLo);
    B2INFO("nsigHiSym = " << m_nsigHiSym);
    B2INFO("nsigHiASym = " << m_nsigHiASym);
  }
 
  auto EnVsCrysID = getObjectPtr<TH2F>("EnVsCrysID");
  auto RvsCrysID = getObjectPtr<TH1F>("RvsCrysID");
  auto NRvsCrysID = getObjectPtr<TH1F>("NRvsCrysID");
  auto Qmatrix = getObjectPtr<TH2F>("Qmatrix");
  auto ElecCalibvsCrys = getObjectPtr<TH1F>("ElecCalibvsCrys");
  auto ExpEvsCrys = getObjectPtr<TH1F>("ExpEvsCrys");
  auto InitialCalibvsCrys = getObjectPtr<TH1F>("InitialCalibvsCrys");
  auto CalibEntriesvsCrys = getObjectPtr<TH1F>("CalibEntriesvsCrys");
  auto EntriesvsCrys = getObjectPtr<TH1F>("EntriesvsCrys");
  auto dPhivsThetaID = getObjectPtr<TH2F>("dPhivsThetaID");
 
  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);
  TH1F* meanEnvsCrysID = new TH1F("meanEnvsCrysID", "Mean normalized energy vs crystal;CrystalID;E/Eexp",
                                  ECLElementNumbers::c_NCrystals, 0, ECLElementNumbers::c_NCrystals);
 
  for (int cellID = 1; cellID <= ECLElementNumbers::c_NCrystals; cellID++) {
    double TotEntries = CalibEntriesvsCrys->GetBinContent(cellID);
    if (TotEntries > 0.) {
      AverageElecCalib->SetBinContent(cellID, ElecCalibvsCrys->GetBinContent(cellID) / TotEntries);
      AverageExpECrys->SetBinContent(cellID, ExpEvsCrys->GetBinContent(cellID) / TotEntries);
      AverageInitCalib->SetBinContent(cellID, InitialCalibvsCrys->GetBinContent(cellID) / TotEntries);
    }
 
    TH1D* En = EnVsCrysID->ProjectionY("En", cellID, cellID);
    meanEnvsCrysID->SetBinContent(cellID, En->GetMean());
    meanEnvsCrysID->SetBinError(cellID, En->GetStdDev());
  }
 
  TString fName = m_outputName;
  TFile* histfile = new TFile(fName, "recreate");
  EnVsCrysID->Write();
  RvsCrysID->Write();
  NRvsCrysID->Write();
  Qmatrix->Write();
  AverageElecCalib->Write();
  AverageExpECrys->Write();
  AverageInitCalib->Write();
  EntriesvsCrys->Write();
  dPhivsThetaID->Write();
  meanEnvsCrysID->Write();
 
  if (m_payloadName == "None") {
    B2INFO("eclee5x5Algorithm has not been asked to find constants; copying input histograms and quitting");
    histfile->Close();
    return c_NotEnoughData;
  }
 
  for (int cellID = 1; cellID <= ECLElementNumbers::c_NCrystals; cellID++) {
 
    if (AverageInitCalib->GetBinContent(cellID) > 0.) {
      if (EntriesvsCrys->GetBinContent(cellID) < m_minEntries) {
        histfile->Close();
        B2INFO("eclee5x5Algorithm: insufficient data for cellID = " << cellID << " " << EntriesvsCrys->GetBinContent(cellID) << " entries");
        return c_NotEnoughData;
      }
    }
  }
 
 
  m_eclNeighbours5x5 = new ECL::ECLNeighbours("N", 2);
 
 
  bool foundConst = false;
  TH1F* gVsCrysID = new TH1F("gVsCrysID", "Ratio of new to old calibration vs crystal ID;crystal ID;vector g",
                             ECLElementNumbers::c_NCrystals, 0, ECLElementNumbers::c_NCrystals);
  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;Energy in 25 crystal sum (GeV)",
                                    ECLElementNumbers::c_NCrystals,
                                    0, ECLElementNumbers::c_NCrystals);
  TString title = "dPhi cut per crystal " + m_payloadName + ";Crystal ID;dPhi requirement (deg)";
  TH1F* dPhiperCrys = new TH1F("dPhiperCrys", title, ECLElementNumbers::c_NCrystals, 0, ECLElementNumbers::c_NCrystals);
 
  if (m_payloadName == "ECLExpee5x5E") {
    for (int cellID = 1; cellID <= ECLElementNumbers::c_NCrystals; cellID++) {
      float mean = meanEnvsCrysID->GetBinContent(cellID);
      float stdDev = meanEnvsCrysID->GetBinError(cellID);
      float inputE = AverageExpECrys->GetBinContent(cellID);
      if (mean > 0. and stdDev > 0.) {
        ExpEnergyperCrys->SetBinContent(cellID, mean * abs(inputE));
        ExpEnergyperCrys->SetBinError(cellID, stdDev * abs(inputE));
      } else {
        ExpEnergyperCrys->SetBinContent(cellID, inputE);
        ExpEnergyperCrys->SetBinError(cellID, 0.05 * inputE);
      }
    }
 
    //..Generate the payload, if requested
    foundConst = true;
    if (m_storeConst) {
      std::vector<float> tempCalib;
      std::vector<float> tempCalibStdDev;
 
      for (int cellID = 1; cellID <= ECLElementNumbers::c_NCrystals; cellID++) {
        tempCalib.push_back(ExpEnergyperCrys->GetBinContent(cellID));
        tempCalibStdDev.push_back(ExpEnergyperCrys->GetBinError(cellID));
      }
      ECLCrystalCalib* ExpectedE = new ECLCrystalCalib();
      ExpectedE->setCalibVector(tempCalib, tempCalibStdDev);
      saveCalibration(ExpectedE, "ECLExpee5x5E");
      B2INFO("eclee5x5Algorithm: successfully stored expected energies ECLExpee5x5E");
    }
 
  } else if (m_payloadName == "ECLCrystalEnergy5x5") {
 
    //..Create the Q matrix and the R vector
    TMatrixDSym matrixQ(ECLElementNumbers::c_NCrystals);
    TVectorD vectorR(ECLElementNumbers::c_NCrystals);
    for (int ix = 1; ix <= ECLElementNumbers::c_NCrystals; ix++) {
      vectorR[ix - 1] = RvsCrysID->GetBinContent(ix);
      for (int iy = 1; iy <= ECLElementNumbers::c_NCrystals; iy++) {
        matrixQ[ix - 1][iy - 1] = Qmatrix->GetBinContent(ix, iy);
      }
    }
 
    //..Crystals that are not being calibrated have no entries in NR. Adjust R and Q to get g=-1
    int nNotCalibrated = 0;
    for (int cellID = 1; cellID <= ECLElementNumbers::c_NCrystals; cellID++) {
      if (NRvsCrysID->GetBinContent(cellID) < 0.5) {
        for (int othercell = 1; othercell <= ECLElementNumbers::c_NCrystals; othercell++) {
          matrixQ[cellID - 1][othercell - 1] = 0.;
          matrixQ[othercell - 1][cellID - 1] = 0.;
        }
        matrixQ[cellID - 1][cellID - 1] = 1.;
        vectorR[cellID - 1] = -1.;
        nNotCalibrated++;
      }
    }
    B2INFO("eclee5x5Algorithm: " << nNotCalibrated << " crystals will not be calibrated. ");
 
    //..Invert to solve Q g = R
    TDecompLU lu(matrixQ);
    bool solved;
    TVectorD vectorg = lu.Solve(vectorR, solved);
 
    //..Fill histograms and check that there are no unexpected negative output values
    if (solved) {
      foundConst = true;
      for (int cellID = 1; cellID <= ECLElementNumbers::c_NCrystals; cellID++) {
        gVsCrysID->SetBinContent(cellID, vectorg[cellID - 1]);
        gVsCrysID->SetBinError(cellID, 0.);
        float newCalib = vectorg[cellID - 1] * abs(AverageInitCalib->GetBinContent(cellID));
        CalibVsCrysID->SetBinContent(cellID, newCalib);
        CalibVsCrysID->SetBinError(cellID, 0.);
 
        if (vectorg[cellID - 1] < 0. and NRvsCrysID->GetBinContent(cellID) > 0.) {foundConst = false;}
      }
    }
 
    //..Generate the payload if requested, and if the matrix inversion worked
    if (m_storeConst and foundConst) {
      std::vector<float> tempCalib;
      std::vector<float> tempCalibStdDev;
 
      for (int cellID = 1; cellID <= ECLElementNumbers::c_NCrystals; cellID++) {
        tempCalib.push_back(CalibVsCrysID->GetBinContent(cellID));
        tempCalibStdDev.push_back(CalibVsCrysID->GetBinError(cellID));
      }
      ECLCrystalCalib* e5x5ECalib = new ECLCrystalCalib();
      e5x5ECalib->setCalibVector(tempCalib, tempCalibStdDev);
      saveCalibration(e5x5ECalib, "ECLCrystalEnergyee5x5");
      B2INFO("eclee5x5Algorithm: successfully stored calibration ECLCrystalEnergyee5x5");
    }
 
  } else if (m_payloadName == "ECLeedPhiData" or m_payloadName == "ECLeedPhiMC") {
 
    //..Find mean and sigma of Gaussian fit to ThetaID projections with sufficient statistics
    float dPhiCenter[69] = {};
    float dPhiHalfWidth[69] = {};
    int firstID = 0; 
    int lastID = 0; 
    const int nbins = dPhivsThetaID->GetNbinsX();
    for (int ib = 1; ib <= nbins; ib++) {
      TH1D* proj = dPhivsThetaID->ProjectionY("proj", ib, ib);
      if (proj->Integral() < 100) {continue;}
      int thetaID = (int)dPhivsThetaID->GetXaxis()->GetBinCenter(ib);
      if (firstID == 0) { firstID = thetaID; }
      lastID = thetaID;
 
      //..Find the fit limits
      double fracHi = m_fracHiSym;
      double nsigHi = m_nsigHiSym;
      if (thetaID <= m_lastLoThetaID) {
        fracHi = m_fracHiASym;
        nsigHi = m_nsigHiASym;
      }
 
      //..Fit range includes all bins with entries>m_fracLo*peak on the low side of the
      //  peak, and entries>m_fracHi*peak on the high side.
      //  i.e. low edge of bin on low side, high edge on high side = low edge of bin+1
      double peak = proj->GetMaximum();
      int nPhiBins = proj->GetNbinsX();
      int binLo = 1;
      do  {
        binLo++;
      } while (proj->GetBinContent(binLo) < m_fracLo * peak and binLo < nPhiBins);
      double xfitLo = proj->GetBinLowEdge(binLo);
 
      //..Start search for the upper edge of the fit range at 175 deg to avoid gamma gamma
      // and e gamma peaks
      int binHi = proj->GetXaxis()->FindBin(175.01);
      do {
        binHi--;
      } while (proj->GetBinContent(binHi)<fracHi* peak and binHi>1);
      double xfitHi = proj->GetBinLowEdge(binHi + 1);
 
      //..Check that the fit region is sensible
      int peakBin = proj->GetMaximumBin();
      if (binLo >= peakBin or binHi <= peakBin) {
        B2ERROR("Flawed dPhi fit range for thetaID = " << thetaID << " peakBin = " << peakBin << " binLo = " << binLo << "binHi = " <<
                binHi);
      }
 
      //..Now fit a Gaussian to the selected region
      proj->Fit("gaus", "", "", xfitLo, xfitHi);
 
      //..Find mean, sigma, and selection range. Record center and half-width of range.
      TF1* fitGaus = proj->GetFunction("gaus");
      float mean = fitGaus->GetParameter(1);
      float sigma = fitGaus->GetParameter(2);
      float dPhiLo = mean - m_nsigLo * sigma;
      float dPhiHi = mean + nsigHi * sigma;
      dPhiCenter[thetaID] = 0.5 * (dPhiLo + dPhiHi); 
      dPhiHalfWidth[thetaID] = 0.5 * (dPhiHi - dPhiLo);
    }
 
    //..Pad the thetaID's without fits with the first or last thetaID values
    for (int thetaID = 0; thetaID < firstID; thetaID++) {
      dPhiCenter[thetaID] = dPhiCenter[firstID];
      dPhiHalfWidth[thetaID] = dPhiHalfWidth[firstID];
    }
    for (int thetaID = lastID + 1; thetaID < 69; thetaID++) {
      dPhiCenter[thetaID] = dPhiCenter[lastID];
      dPhiHalfWidth[thetaID] = dPhiHalfWidth[lastID];
    }
 
    //..Now copy these to each crystal to generate the payload and fill the output histogram.
    //  We will use ECLNeighours to get the number of crystals in each theta ring
    m_eclNeighbours5x5 = new ECL::ECLNeighbours("N", 2);
    std::vector<float> tempCalib;
    std::vector<float> tempCalibWidth;
    tempCalib.resize(ECLElementNumbers::c_NCrystals);
    tempCalibWidth.resize(ECLElementNumbers::c_NCrystals);
    int crysID = 0;
    for (int thetaID = 0; thetaID < 69; thetaID++) {
      for (int ic = 0; ic < m_eclNeighbours5x5->getCrystalsPerRing(thetaID); ic++) {
        tempCalib.at(crysID) = dPhiCenter[thetaID];
        tempCalibWidth.at(crysID) = dPhiHalfWidth[thetaID];
        dPhiperCrys->SetBinContent(crysID + 1, dPhiCenter[thetaID]);
        dPhiperCrys->SetBinError(crysID + 1, dPhiHalfWidth[thetaID]);
        crysID++;
      }
    }
 
    //..Store the payload, if requested
    foundConst = true;
    if (m_storeConst) {
      ECLCrystalCalib* eedPhi = new ECLCrystalCalib();
      eedPhi->setCalibVector(tempCalib, tempCalibWidth);
      saveCalibration(eedPhi, m_payloadName);
      B2INFO("eclee5x5Algorithm: successfully stored calibration " << m_payloadName);
    }
 
  } else {
    B2ERROR("eclee5x5Algorithm: invalid payload name: m_payloadName = " << m_payloadName);
  }
 
  histfile->cd();
  if (m_payloadName == "ECLExpee5x5E") {
    ExpEnergyperCrys->Write();
  } else if (m_payloadName == "ECLCrystalEnergy5x5") {
    gVsCrysID->Write();
    CalibVsCrysID->Write();
  } else if (m_payloadName == "ECLeedPhiData" or m_payloadName == "ECLeedPhiMC") {
    dPhiperCrys->Write();
  }
  histfile->Close();
 
  dummy = (TH1F*)gROOT->FindObject("gVsCrysID"); delete dummy;
  dummy = (TH1F*)gROOT->FindObject("CalibVsCrysID"); delete dummy;
  dummy = (TH1F*)gROOT->FindObject("ExpEnergyperCrys"); delete dummy;
  dummy = (TH1F*)gROOT->FindObject("dPhiperCrys"); delete dummy;
 
  if (!m_storeConst) {
    if (foundConst) {
      B2INFO("eclee5x5Algorithm successfully found constants but was not asked to store them");
    } else {
      B2INFO("eclee5x5Algorithm was not asked to store constants, and did not succeed in finding them");
    }
    return c_Failure;
  } else if (!foundConst) {
    if (m_payloadName == "ECLExpee5x5E") {
      B2INFO("eclee5x5Algorithm: failed to store expected values");
    } else if (m_payloadName == "ECLCrystalEnergy5x5") {
      B2INFO("eclee5x5Algorithm: failed to store calibration constants");
    } else if (m_payloadName == "ECLeedPhiData" or m_payloadName == "ECLeedPhiMC") {
      B2INFO("eclee5x5Algorithm: failed to find dPhi* selection criteria");
    }
    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 algorithm.

Definition at line 164 of file CalibrationAlgorithm.h.

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

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

getfracHiASym()

double getfracHiASym ( )

inline

Getter for m_fracHiASym.

Definition at line 74 of file eclee5x5Algorithm.h.

{return m_fracHiASym;}

getfracHiSym()

double getfracHiSym ( )

inline

Getter for m_fracHiSym.

Definition at line 68 of file eclee5x5Algorithm.h.

{return m_fracHiSym;}

getfracLo()

double getfracLo ( )

inline

Getter for m_fracLo.

Definition at line 62 of file eclee5x5Algorithm.h.

{return m_fracLo;}

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

getlastLoThetaID()

int getlastLoThetaID ( )

inline

Getter for m_lastLoThetaID.

Definition at line 98 of file eclee5x5Algorithm.h.

{return m_lastLoThetaID;}

getMinEntries()

int getMinEntries ( )

inline

Getter for m_minEntries.

Definition at line 44 of file eclee5x5Algorithm.h.

{return m_minEntries;}

getnsigHiASym()

double getnsigHiASym ( )

inline

Getter for m_nsigHiASym.

Definition at line 92 of file eclee5x5Algorithm.h.

{return m_nsigHiASym;}

getnsigHiSym()

double getnsigHiSym ( )

inline

Getter for m_nsigHiSym.

Definition at line 86 of file eclee5x5Algorithm.h.

{return m_nsigHiSym;}

getnsigLo()

double getnsigLo ( )

inline

Getter for m_nsigLo.

Definition at line 80 of file eclee5x5Algorithm.h.

{return m_nsigLo;}

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

getOutputName()

std::string getOutputName ( )

inline

Getter for m_outputName.

Definition at line 38 of file eclee5x5Algorithm.h.

{return m_outputName;}

getPayloadName()

std::string getPayloadName ( )

inline

Getter for m_payloadname.

Definition at line 50 of file eclee5x5Algorithm.h.

{return m_payloadName;}

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

getStoreConst()

bool getStoreConst ( )

inline

Getter for m_storeConst.

Definition at line 56 of file eclee5x5Algorithm.h.

{return m_storeConst;}

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 return bool indicates success or failure.

Definition at line 502 of file CalibrationAlgorithm.cc.

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

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

setfracHiASym()

void setfracHiASym ( double  fracHiASym )

inline

Setter for m_fracHiASym.

Definition at line 71 of file eclee5x5Algorithm.h.

{m_fracHiASym = fracHiASym;}

setfracHiSym()

void setfracHiSym ( double  fracHiSym )

inline

Setter for m_fracHiSym.

Definition at line 65 of file eclee5x5Algorithm.h.

{m_fracHiSym = fracHiSym;}

setfracLo()

void setfracLo ( double  fracLo )

inline

Setter for m_fracLo.

Definition at line 59 of file eclee5x5Algorithm.h.

{m_fracLo = fracLo;}

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

setlastLoThetaID()

void setlastLoThetaID ( int  lastLoThetaID )

inline

Setter for m_lastLoThetaID.

Definition at line 95 of file eclee5x5Algorithm.h.

{m_lastLoThetaID = lastLoThetaID;}

setMinEntries()

void setMinEntries ( int  minEntries )

inline

Setter for m_minEntries.

Definition at line 41 of file eclee5x5Algorithm.h.

{m_minEntries = minEntries;}

setnsigHiASym()

void setnsigHiASym ( double  nsigHiASym )

inline

Setter for m_nsigHiASym.

Definition at line 89 of file eclee5x5Algorithm.h.

{m_nsigHiASym = nsigHiASym;}

setnsigHiSym()

void setnsigHiSym ( double  nsigHiSym )

inline

Setter for m_nsigHiSym.

Definition at line 83 of file eclee5x5Algorithm.h.

{m_nsigHiSym = nsigHiSym;}

setnsigLo()

void setnsigLo ( double  nsigLo )

inline

Setter for m_nsigLo.

Definition at line 77 of file eclee5x5Algorithm.h.

{m_nsigLo = nsigLo;}

setOutputJsonValue()

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

inlineprotectedinherited

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

Definition at line 337 of file CalibrationAlgorithm.h.

{m_jsonExecutionOutput[key] = value;}

setOutputName()

void setOutputName ( const std::string &  outputName )

inline

Setter for m_outputName.

Definition at line 35 of file eclee5x5Algorithm.h.

{m_outputName = outputName;}

setPayloadName()

void setPayloadName ( const std::string &  payloadname )

inline

Setter for m_payloadName.

Definition at line 47 of file eclee5x5Algorithm.h.

{m_payloadName = payloadname;}

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

setStoreConst()

void setStoreConst ( bool  storeConst )

inline

Setter for m_storeConst.

Definition at line 53 of file eclee5x5Algorithm.h.

{m_storeConst = storeConst;}

updateDBObjPtrs()

void updateDBObjPtrs ( const unsigned int  event = 1, const int  run = 0, const int  experiment = 0  )

protectedinherited

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

Definition at line 404 of file CalibrationAlgorithm.cc.

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

Member Data Documentation

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_eclNeighbours5x5

ECL::ECLNeighbours* m_eclNeighbours5x5 {nullptr}

private

Neighbours, used to get nCrys per ring.

Definition at line 113 of file eclee5x5Algorithm.h.

m_fracHiASym

double m_fracHiASym = 0.4

private

or fracHiASym*peak, at low values of thetaID

Definition at line 116 of file eclee5x5Algorithm.h.

m_fracHiSym

double m_fracHiSym = 0.2

private

end dPhi fit where data is > fracHiSym*peak

Definition at line 115 of file eclee5x5Algorithm.h.

m_fracLo

double m_fracLo = 0.2

private

start dPhi fit where data is > fraclo*peak

Definition at line 114 of file eclee5x5Algorithm.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_lastLoThetaID

int m_lastLoThetaID = 4

private

use asymmetric dPhi range for thetaID<= this value

Definition at line 120 of file eclee5x5Algorithm.h.

m_minEntries

int m_minEntries = 150

private

all crystals to be calibrated must have this many entries

Definition at line 109 of file eclee5x5Algorithm.h.

m_nsigHiASym

double m_nsigHiASym = 2.0

private

or mean+nsigHiASym*sigma at low thetaID

Definition at line 119 of file eclee5x5Algorithm.h.

m_nsigHiSym

double m_nsigHiSym = 2.5

private

to mean + nsigHiSym*sigma

Definition at line 118 of file eclee5x5Algorithm.h.

m_nsigLo

double m_nsigLo = 2.5

private

dPhi region is mean - nsigLo*sigma

Definition at line 117 of file eclee5x5Algorithm.h.

m_outputName

std::string m_outputName = "eclee5x5Algorithm.root"

private

..Parameters to control job to find energy calibration using Bhabhas

file name for histogram output

Definition at line 108 of file eclee5x5Algorithm.h.

m_payloadName

std::string m_payloadName = "ECLCrystalEnergy5x5"

private

Name of the payload to be stored.

options: ECLCrystalEnergy5x5, ECLExpee5x5E, ECLeedPhiData, ECLeedPhiMC, or None

Definition at line 111 of file eclee5x5Algorithm.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.

m_storeConst

bool m_storeConst = true

private

write payload to localdb if true

Definition at line 112 of file eclee5x5Algorithm.h.

---

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

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