PXDValidationAlgorithm Class Reference

Class implementing the PXD calibration validation algorithm. More...

#include <PXDValidationAlgorithm.h>

Inheritance diagram for PXDValidationAlgorithm:

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

Public Member Functions
	PXDValidationAlgorithm ()
	Constructor set the prefix to PXDValidationAlgorithm.
virtual	~PXDValidationAlgorithm () override
	Destructor.
void	setBoundaries (const std::vector< Calibration::ExpRun > &boundaries)
	Setter for boundaries.
std::vector< Calibration::ExpRun >	getBoundaries () const
	getter for current boundaries
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>.

Public Attributes
int	minTrackPoints
	Minimum number of track points per sensor.
bool	save2DHists
	Flag to save 2D histograms for efficiency;.
bool	saveD0Z0
	Flag to save delta d0 (z0) over sqrt(2) to TTree;.
int	binsD0Z0
	Bin size for d0/z0 histogram.

Protected Member Functions
virtual EResult	calibrate () override
	Run algo on data.
virtual bool	isBoundaryRequired (const Calibration::ExpRun &) override
	Decide if a run should be a payload boundary. Only used in certain Python Algorithm Starategies.
virtual void	boundaryFindingSetup (std::vector< Calibration::ExpRun >, int) override
	What we do before isBoundaryRequired gets called.
void	setInputFileNames (std::vector< std::string > inputFileNames)
	Set the input file names used for this algorithm.
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::vector< Calibration::ExpRun >	m_requestedBoundaries
	During findPayloadBoundaries and isBoundaryRequired this is used to define the boundaries we want.
std::shared_ptr< TFile >	m_file
	Pointer for TFile.
std::shared_ptr< TTree >	m_tree
	Pointer for TTree of the validation info.
int	m_exp
	Experiment number.
int	m_run
	Run number.
std::vector< unsigned short >	m_pxdid
	Vector of PXD module id (DHE id)
std::vector< unsigned short >	m_uBin
	Vector of uBin.
std::vector< unsigned short >	m_vBin
	Vector of vBin.
std::vector< unsigned long >	m_nTrackPoints
	Vector of number of track points.
std::vector< unsigned long >	m_nTrackClusters
	Vector of number of track matched clusters.
std::vector< unsigned long >	m_nSelTrackPoints
	Vector of number of track points outside of defective pixels.
std::vector< unsigned long >	m_nSelTrackClusters
	Vector of number of track clusters outside of defective pixels.
std::vector< float >	m_d0
	Vector of delta d0 over sqrt(2)
std::vector< float >	m_z0
	Vector of delta z0 over sqrt(2)
TH1F *	m_hD0
	Histogram of corrected d0 for each 2-track event.
TH1F *	m_hZ0
	Histogram of corrected z0 for each 2-track event.
TH2F *	m_hTrackPointsLayer1
	Histogram of intersection points for layer 1.
TH2F *	m_hTrackClustersLayer1
	Histogram of track matched clusters for layer 1.
TH2F *	m_hTrackPointsLayer2
	Histogram of intersection points for layer 2.
TH2F *	m_hTrackClustersLayer2
	Histogram of track matched clusters for layer 2.
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

Class implementing the PXD calibration validation algorithm.

Definition at line 26 of file PXDValidationAlgorithm.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

PXDValidationAlgorithm()

PXDValidationAlgorithm

(

)

Constructor set the prefix to PXDValidationAlgorithm.

Definition at line 89 of file PXDValidationAlgorithm.cc.

                                              :
  CalibrationAlgorithm("PXDCDSTCollector")
  , minTrackPoints(1000), save2DHists(false), saveD0Z0(false), binsD0Z0(600)
  , m_exp(-1), m_run(-1), m_hD0(nullptr), m_hZ0(nullptr)
  , m_hTrackPointsLayer1(nullptr), m_hTrackClustersLayer1(nullptr)
  , m_hTrackPointsLayer2(nullptr), m_hTrackClustersLayer2(nullptr)
{
  setDescription(
    " -------------------------- PXDValidationAlgorithm ---------------------------------\n"
    "                                                                                         \n"
    "  Algorithm for filling validation histograms. \n"
    " ----------------------------------------------------------------------------------------\n"
  );
 
 
}

~PXDValidationAlgorithm()

~PXDValidationAlgorithm ( )

overridevirtual

Destructor.

Definition at line 106 of file PXDValidationAlgorithm.cc.

{
}

Member Function Documentation

boundaryFindingSetup()

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

inlineoverrideprotectedvirtual

What we do before isBoundaryRequired gets called.

Reimplemented from CalibrationAlgorithm.

Definition at line 63 of file PXDValidationAlgorithm.h.

    {
      m_boundaries = m_requestedBoundaries;
    };

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 algo on data.

Implements CalibrationAlgorithm.

Definition at line 110 of file PXDValidationAlgorithm.cc.

{
  // Turn off ROOT GUI
  gROOT->SetBatch();
 
  // Current Exp No. and Run No.
  auto expRuns = getRunList();
  auto expRunsAll = getRunListFromAllData();
  // size should be 1
  if (!expRuns.size())
    return c_Failure;
 
  m_exp = expRuns.back().first;
  m_run = expRuns.back().second;
  B2INFO("Current ExpRuns: [("
         << expRuns.front().first << ", " << expRuns.front().second << "), ("
         << m_exp << ", " << m_run << ")]");
 
  // Get counter histograms and set pointers
  auto cluster_counter = getObjectPtr<TH1I>("PXDTrackClusterCounter");
  auto point_counter = getObjectPtr<TH1I>("PXDTrackPointCounter");
  auto selected_point_counter = getObjectPtr<TH1I>("PXDSelTrackPointCounter");  // can be empty
  auto selected_cluster_counter = getObjectPtr<TH1I>("PXDSelTrackClusterCounter");  // can be empty
  if (!cluster_counter) return c_NotEnoughData;
  if (!point_counter) return c_NotEnoughData;
 
  // Extract number of sensors from counter histograms
  auto nSensors = getNumberOfSensors(cluster_counter);
 
  // Extract the number of grid bins from counter histograms
  unsigned short nBinsU = 0;
  unsigned short nBinsV = 0;
  getNumberOfBins(cluster_counter, nBinsU, nBinsV);
 
 
  B2INFO("Start info collection using a " << nBinsU << "x" << nBinsV << " grid per sensor.");
  B2INFO("Number of collected track points is " << point_counter->GetEntries()
         << " in " << nSensors << " sensors.");
 
  if (point_counter->GetEntries() < minTrackPoints) {
    B2WARNING("Not enough Data: Only " <<  point_counter->GetEntries() << " hits were collected but " << minTrackPoints
              << " needed!");
    return c_NotEnoughData;
  }
 
 
  auto hPassedHitsLayer1 = getObjectPtr<TH2F>("hPassedHitsLayer1");
  auto hTotalHitsLayer1 = getObjectPtr<TH2F>("hTotalHitsLayer1");
  auto hPassedHitsLayer2 = getObjectPtr<TH2F>("hPassedHitsLayer2");
  auto hTotalHitsLayer2 = getObjectPtr<TH2F>("hTotalHitsLayer2");
  if (!hPassedHitsLayer1) return c_NotEnoughData;
  if (!hTotalHitsLayer1) return c_NotEnoughData;
  if (!hPassedHitsLayer2) return c_NotEnoughData;
  if (!hTotalHitsLayer2) return c_NotEnoughData;
 
  // Save the current directory to change back later
  TDirectory* currentDir = gDirectory;
  //if (!currentDir) currentDir = gDirectory;
 
  // Create TFile if not exist
  if (!m_file) {
    std::string fileName = (this->getPrefix()) + "Validation.root";
    B2INFO("Creating file " << fileName);
    m_file = std::make_shared<TFile>(fileName.c_str(), "RECREATE");
  }
 
  // Create TTree if not exist
  if (!m_tree) {
 
    B2INFO("Creating TTree.");
    m_tree = std::make_shared<TTree>("tree", "PXD validation data");
    // Define histograms out of m_file
    currentDir->cd();
    m_hD0 = new TH1F("hD0", "Corrected d0;#Delta d0/#sqrt{2} [cm];Counts", binsD0Z0, -0.03, 0.03);
    m_hZ0 = new TH1F("hZ0", "Corrected z0;#Delta z0/#sqrt{2} [cm];Counts", binsD0Z0, -0.03, 0.03);
    m_file->cd();
 
    m_tree->Branch<int>("exp", &m_exp);
    m_tree->Branch<int>("run", &m_run);
    m_tree->Branch("pxdid", &m_pxdid);
    m_tree->Branch("uBin", &m_uBin);
    m_tree->Branch("vBin", &m_vBin);
    m_tree->Branch("nTrackPoints", &m_nTrackPoints);
    m_tree->Branch("nTrackClusters", &m_nTrackClusters);
    m_tree->Branch("nSelTrackPoints", &m_nSelTrackPoints);
    m_tree->Branch("nSelTrackClusters", &m_nSelTrackClusters);
    m_tree->Branch<TH1F>("hD0", &m_hD0, 32000, 0);
    m_tree->Branch<TH1F>("hZ0", &m_hZ0, 32000, 0);
 
    if (saveD0Z0) {
      m_tree->Branch("d0", &m_d0);
      m_tree->Branch("z0", &m_z0);
    }
 
    if (save2DHists) {
      m_hTrackPointsLayer1   = (TH2F*)hTotalHitsLayer1->Clone();
      m_hTrackClustersLayer1 = (TH2F*)hPassedHitsLayer1->Clone();
      m_hTrackPointsLayer2   = (TH2F*)hTotalHitsLayer2->Clone();
      m_hTrackClustersLayer2 = (TH2F*)hPassedHitsLayer2->Clone();
 
      // associated histograms
      m_tree->Branch<TH2F>("hTrackPointsLayer1", &m_hTrackPointsLayer1, 32000, 0);
      m_tree->Branch<TH2F>("hTrackClustersLayer1", &m_hTrackClustersLayer1, 32000, 0);
      m_tree->Branch<TH2F>("hTrackPointsLayer2", &m_hTrackPointsLayer2, 32000, 0);
      m_tree->Branch<TH2F>("hTrackClustersLayer2", &m_hTrackClustersLayer2, 32000, 0);
    }
  }
 
  m_file->cd();
 
  if (save2DHists) {
    // Just update 2D histograms
    *m_hTrackPointsLayer1   = *hTotalHitsLayer1;
    *m_hTrackClustersLayer1 = *hPassedHitsLayer1;
    *m_hTrackPointsLayer2   = *hTotalHitsLayer2;
    *m_hTrackClustersLayer2 = *hPassedHitsLayer2;
 
  }
 
  // Clear
  m_pxdid.clear();
  m_uBin.clear();
  m_vBin.clear();
  m_nTrackClusters.clear();
  m_nTrackPoints.clear();
  m_nSelTrackPoints.clear();
  m_nSelTrackClusters.clear();
  m_d0.clear();
  m_z0.clear();
 
  // Get resolution trees and create histograms
  auto tree_d0z0 = getObjectPtr<TTree>("tree_d0z0");
  if (!tree_d0z0) return c_NotEnoughData;
  float d0, z0;
  tree_d0z0->SetBranchAddress("d0", &d0);
  tree_d0z0->SetBranchAddress("z0", &z0);
  m_hD0->Reset();
  m_hZ0->Reset();
 
  // Fill histograms from tree
  for (int i = 0; i < tree_d0z0->GetEntries(); i++) {
    tree_d0z0->GetEntry(i);
    if (saveD0Z0) {
      m_d0.emplace_back(d0);
      m_z0.emplace_back(z0);
    }
    if (fabs(d0) > 0.03 || fabs(z0) > 0.03)
      continue;
    m_hD0->Fill(d0);
    m_hZ0->Fill(z0);
  }
 
 
  // Loop over all bins of input histo
  for (auto histoBin = 1; histoBin <= cluster_counter->GetXaxis()->GetNbins(); histoBin++) {
    // The bin label contains the vxdid, uBin and vBin
    string label = cluster_counter->GetXaxis()->GetBinLabel(histoBin);
 
    // Parse label string format to read sensorID, uBin and vBin
    istringstream  stream(label);
    string token;
    getline(stream, token, '_');
    VxdID sensorID(token);
 
    getline(stream, token, '_');
    unsigned short uBin = std::stoi(token);
 
    getline(stream, token, '_');
    unsigned short vBin = std::stoi(token);
 
    // Read back the counters for number of collected clusters
    int numberOfClusters = cluster_counter->GetBinContent(histoBin);
    int numberOfPoints = point_counter->GetBinContent(histoBin);
 
    m_pxdid.emplace_back(sensorID.getLayerNumber() * 1000 + sensorID.getLadderNumber() * 10 + sensorID.getSensorNumber());
    m_uBin.emplace_back(uBin);
    m_vBin.emplace_back(vBin);
    m_nTrackPoints.emplace_back(numberOfPoints);
    m_nSelTrackPoints.push_back(selected_point_counter->GetBinContent(histoBin));
    m_nSelTrackClusters.push_back(selected_cluster_counter->GetBinContent(histoBin));
    m_nTrackClusters.emplace_back(numberOfClusters);
  }
 
  m_tree->Fill();
 
  // At the last run of the data
  if (m_exp == expRunsAll.back().first &&
      m_run == expRunsAll.back().second) {
    B2INFO("Reached Final ExpRun: (" << m_exp << ", " << m_run << ")");
    m_file->cd();
    m_tree->Write();
    B2INFO("Writing Successful.");
    //if (m_file) m_file->Close();// Don't do it! We are using shared_ptr!
    if (m_hD0) delete m_hD0;
    if (m_hZ0) delete m_hZ0;
    if (save2DHists) {
      if (m_hTrackPointsLayer1) delete m_hTrackPointsLayer1;
      if (m_hTrackClustersLayer1) delete m_hTrackClustersLayer1;
      if (m_hTrackPointsLayer2) delete m_hTrackPointsLayer2;
      if (m_hTrackClustersLayer2) delete m_hTrackClustersLayer2;
    }
    m_file->Close();
 
  }
  currentDir->cd();
 
  // Always return ok to have run-by-run info
  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;}

getBoundaries()

std::vector< Calibration::ExpRun > getBoundaries ( ) const

inline

getter for current boundaries

Definition at line 51 of file PXDValidationAlgorithm.h.

{return m_requestedBoundaries;}

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

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

bool isBoundaryRequired ( const Calibration::ExpRun &  )

overrideprotectedvirtual

Decide if a run should be a payload boundary. Only used in certain Python Algorithm Starategies.

Reimplemented from CalibrationAlgorithm.

Definition at line 321 of file PXDValidationAlgorithm.cc.

{
  // First run in data as we iterate, but our boundaries weren't set manually already?
  // Just set the first run to be a boundary and we are done.
  if (m_boundaries.empty()) {
    B2INFO("This is the first run encountered, let's say it is a boundary.");
    return true;
  } else {
    //return true;// -> simple run-by-run
    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);
}

setBoundaries()

void setBoundaries ( const std::vector< Calibration::ExpRun > &  boundaries )

inline

Setter for boundaries.

Definition at line 48 of file PXDValidationAlgorithm.h.

{m_requestedBoundaries = boundaries;}

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 internally 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 unnecessary...)
  DBStore::Instance().updateEvent(event);
}

Member Data Documentation

binsD0Z0

int binsD0Z0

Bin size for d0/z0 histogram.

Definition at line 45 of file PXDValidationAlgorithm.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_d0

std::vector<float> m_d0

private

Vector of delta d0 over sqrt(2)

Definition at line 107 of file PXDValidationAlgorithm.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_exp

int m_exp

private

Experiment number.

Definition at line 80 of file PXDValidationAlgorithm.h.

m_file

std::shared_ptr<TFile> m_file

private

Pointer for TFile.

Definition at line 74 of file PXDValidationAlgorithm.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_hD0

TH1F* m_hD0

private

Histogram of corrected d0 for each 2-track event.

Definition at line 113 of file PXDValidationAlgorithm.h.

m_hTrackClustersLayer1

TH2F* m_hTrackClustersLayer1

private

Histogram of track matched clusters for layer 1.

Definition at line 122 of file PXDValidationAlgorithm.h.

m_hTrackClustersLayer2

TH2F* m_hTrackClustersLayer2

private

Histogram of track matched clusters for layer 2.

Definition at line 128 of file PXDValidationAlgorithm.h.

m_hTrackPointsLayer1

TH2F* m_hTrackPointsLayer1

private

Histogram of intersection points for layer 1.

Definition at line 119 of file PXDValidationAlgorithm.h.

m_hTrackPointsLayer2

TH2F* m_hTrackPointsLayer2

private

Histogram of intersection points for layer 2.

Definition at line 125 of file PXDValidationAlgorithm.h.

m_hZ0

TH1F* m_hZ0

private

Histogram of corrected z0 for each 2-track event.

Definition at line 116 of file PXDValidationAlgorithm.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_nSelTrackClusters

std::vector<unsigned long> m_nSelTrackClusters

private

Vector of number of track clusters outside of defective pixels.

Definition at line 104 of file PXDValidationAlgorithm.h.

m_nSelTrackPoints

std::vector<unsigned long> m_nSelTrackPoints

private

Vector of number of track points outside of defective pixels.

Definition at line 101 of file PXDValidationAlgorithm.h.

m_nTrackClusters

std::vector<unsigned long> m_nTrackClusters

private

Vector of number of track matched clusters.

Definition at line 98 of file PXDValidationAlgorithm.h.

m_nTrackPoints

std::vector<unsigned long> m_nTrackPoints

private

Vector of number of track points.

Definition at line 95 of file PXDValidationAlgorithm.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_pxdid

std::vector<unsigned short> m_pxdid

private

Vector of PXD module id (DHE id)

Definition at line 86 of file PXDValidationAlgorithm.h.

m_requestedBoundaries

std::vector<Calibration::ExpRun> m_requestedBoundaries

private

During findPayloadBoundaries and isBoundaryRequired this is used to define the boundaries we want.

Definition at line 71 of file PXDValidationAlgorithm.h.

m_run

int m_run

private

Run number.

Definition at line 83 of file PXDValidationAlgorithm.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_tree

std::shared_ptr<TTree> m_tree

private

Pointer for TTree of the validation info.

Definition at line 77 of file PXDValidationAlgorithm.h.

m_uBin

std::vector<unsigned short> m_uBin

private

Vector of uBin.

Definition at line 89 of file PXDValidationAlgorithm.h.

m_vBin

std::vector<unsigned short> m_vBin

private

Vector of vBin.

Definition at line 92 of file PXDValidationAlgorithm.h.

m_z0

std::vector<float> m_z0

private

Vector of delta z0 over sqrt(2)

Definition at line 110 of file PXDValidationAlgorithm.h.

minTrackPoints

int minTrackPoints

Minimum number of track points per sensor.

Definition at line 36 of file PXDValidationAlgorithm.h.

save2DHists

bool save2DHists

Flag to save 2D histograms for efficiency;.

Definition at line 39 of file PXDValidationAlgorithm.h.

saveD0Z0

bool saveD0Z0

Flag to save delta d0 (z0) over sqrt(2) to TTree;.

Definition at line 42 of file PXDValidationAlgorithm.h.

---

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

• pxd/calibration/include/PXDValidationAlgorithm.h
• pxd/calibration/src/PXDValidationAlgorithm.cc