KLMChannelStatusAlgorithm Class Reference

KLM channel status calibration algorithm. More...

#include <KLMChannelStatusAlgorithm.h>

Inheritance diagram for KLMChannelStatusAlgorithm:

Classes
class	Results
	Calibration results. More...

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

Public Member Functions
	KLMChannelStatusAlgorithm ()
	Constructor.
	~KLMChannelStatusAlgorithm ()
	Destructor.
CalibrationAlgorithm::EResult	calibrate () override
	Calibration.
void	setForcedCalibration (bool forcedCalibration)
	Set whether the calibration is forced (calibrate even for insufficient average number of hits).
void	setMinimalModuleHitNumber (unsigned int minimalModuleHitNumber)
	Set minimal number of hits per module for module-based calibration.
void	setMaximalLogSectorHitsRatio (double maximalLogSectorHitsRatio)
	Set maximal absolute value of the logarithm (base 10) of the ratio of the number of hits in this sector and the average number of hits.
void	setMinimalHitNumberSingleHotChannel (unsigned int minimalHitNumberSingleHotChannel)
	Set minimal number of hits in a single channel to mark it as hot.
void	setMinimalHitNumberHotChannel (unsigned int minimalHitNumberHotChannel)
	Set inimal number of hits to mark to mark the channel as hot.
void	setMinimalHitNumberRatioHotChannel (double minimalHitNumberRatioHotChannel)
	Minimal ratio of number of hits in this channel and average over other channels in this module to mark it as hot.
double	getMinimalAverageHitNumber () const
	Get minimal average number of hits per channel required for calibration.
void	setMinimalAverageHitNumber (double minimalAverageHitNumber)
	Set minimal average number of hits per channel required for calibration.
const Results *	getResults () const
	Get results.
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
void	calibrateSector (KLMSectorNumber sector, double averageHitsActiveSector)
	Caliobrate sector.
void	calibrateModule (KLMModuleNumber module)
	Calibrate module.
bool	markHotChannel (KLMChannelNumber channel, unsigned int moduleHits, int activeChannels)
	Mark hot channel.
void	calibrateChannel (KLMChannelNumber channel)
	Calibrate channel.
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
bool	m_ForcedCalibration = false
	Whether the calibration is forced (calibrate even for insufficient average number of hits).
unsigned int	m_MinimalModuleHitNumber = 1
	Minimal module hit number for module-based calibration.
double	m_MinimalAverageHitNumber = 25
	Minimal average number of hits per channel required for calibration.
double	m_MaximalLogSectorHitsRatio = 1
	Maximal absolute value of the logarithm (base 10) of the ratio of the number of hits in this sector and the average number of hits.
unsigned int	m_MinimalHitNumberSingleHotChannel = 1000
	Minimal number of hits in a single channel to mark it as hot.
unsigned int	m_MinimalHitNumberHotChannel = 100
	Minimal number of hits to mark to mark the channel as hot.
double	m_MinimalHitNumberRatioHotChannel = 50
	Minimal ratio of number of hits in this channel and average over other channels in this module to mark it as hot.
const KLMElementNumbers *	m_ElementNumbers
	Element numbers.
Results	m_Results
	Calibration results.
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< 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

KLM channel status calibration algorithm.

Definition at line 27 of file KLMChannelStatusAlgorithm.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

KLMChannelStatusAlgorithm()

KLMChannelStatusAlgorithm

(

)

Constructor.

Definition at line 49 of file KLMChannelStatusAlgorithm.cc.

                                                     :
  CalibrationAlgorithm("KLMChannelStatusCollector"),
  m_ElementNumbers(&(KLMElementNumbers::Instance()))
{
}

~KLMChannelStatusAlgorithm()

~KLMChannelStatusAlgorithm

(

)

Destructor.

Definition at line 55 of file KLMChannelStatusAlgorithm.cc.

{
}

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

overridevirtual

Calibration.

Implements CalibrationAlgorithm.

Definition at line 59 of file KLMChannelStatusAlgorithm.cc.

{
  KLMChannelNumber channel, module, sector;
  unsigned int hits, moduleHits, maxHits;
  /*
   * Fill channel hit map. Note that more than one entry can exist for the same
   * channel due to merging of collected data for several runs. Thus, the
   * number of hits is summed.
   */
  std::shared_ptr<TTree> calibrationData;
  calibrationData = getObjectPtr<TTree>("calibration_data");
  calibrationData->SetBranchAddress("channel", &channel);
  calibrationData->SetBranchAddress("hits", &hits);
  int n = calibrationData->GetEntries();
  m_Results.m_HitMapChannel.setDataAllChannels(0);
  m_Results.m_TotalHitNumber = 0;
  m_Results.m_HitNumberBKLM = 0;
  m_Results.m_HitNumberEKLM = 0;
  for (int i = 0; i < n; ++i) {
    calibrationData->GetEntry(i);
    m_Results.m_HitMapChannel.setChannelData(
      channel, m_Results.m_HitMapChannel.getChannelData(channel) + hits);
    m_Results.m_TotalHitNumber += hits;
    if (m_ElementNumbers->isBKLMChannel(channel))
      m_Results.m_HitNumberBKLM += hits;
    else
      m_Results.m_HitNumberEKLM += hits;
  }
  clearCalibrationData();
  /*
   * A new object is created, because saveCalibration() stores a pointer
   * to KLMChannelStatus, and it is necessary to save the payloads to commit
   * them at the end of calibration.
   */
  m_Results.m_ChannelStatus = new KLMChannelStatus();
  m_Results.m_ChannelStatus->setStatusAllChannels(KLMChannelStatus::c_Undetermined);
  /* If there are no hits, then mark all channels as dead. */
  KLMChannelIndex klmChannels;
  if (m_Results.m_TotalHitNumber == 0) {
    for (KLMChannelIndex& klmChannel : klmChannels) {
      channel = klmChannel.getKLMChannelNumber();
      m_Results.m_ChannelStatus->setChannelStatus(channel, KLMChannelStatus::c_Dead);
    }
    saveCalibration(m_Results.m_ChannelStatus, "KLMChannelStatus");
    return CalibrationAlgorithm::c_OK;
  }
  /* Fill module and sector hit maps. */
  KLMChannelIndex klmModules(KLMChannelIndex::c_IndexLevelLayer);
  for (KLMChannelIndex& klmModule : klmModules)
    m_Results.m_HitMapModule.setChannelData(klmModule.getKLMModuleNumber(), 0);
  KLMChannelIndex klmSectors(KLMChannelIndex::c_IndexLevelSector);
  for (KLMChannelIndex& klmSector : klmSectors)
    m_Results.m_HitMapSector.setChannelData(klmSector.getKLMSectorNumber(), 0);
  for (KLMChannelIndex& klmChannel : klmChannels) {
    channel = klmChannel.getKLMChannelNumber();
    module = klmChannel.getKLMModuleNumber();
    sector = klmChannel.getKLMSectorNumber();
    hits = m_Results.m_HitMapChannel.getChannelData(channel);
    m_Results.m_HitMapModule.setChannelData(
      module, m_Results.m_HitMapModule.getChannelData(module) + hits);
    m_Results.m_HitMapSector.setChannelData(
      sector, m_Results.m_HitMapSector.getChannelData(sector) + hits);
  }
  /*
   * Mark all channels in modules without hits as dead.
   * Search for hot channels.
   */
  for (KLMChannelIndex& klmModule : klmModules) {
    module = klmModule.getKLMModuleNumber();
    moduleHits = m_Results.m_HitMapModule.getChannelData(module);
    KLMChannelIndex klmNextModule(klmModule);
    ++klmNextModule;
    KLMChannelIndex klmChannel(klmModule);
    klmChannel.setIndexLevel(KLMChannelIndex::c_IndexLevelStrip);
    if (moduleHits == 0) {
      for (; klmChannel != klmNextModule; ++klmChannel) {
        channel = klmChannel.getKLMChannelNumber();
        m_Results.m_ChannelStatus->setChannelStatus(channel, KLMChannelStatus::c_Dead);
      }
      m_Results.m_ModuleActiveChannelMap.setChannelData(module, 0);
      continue;
    }
    unsigned int activeChannels = 0;
    for (; klmChannel != klmNextModule; ++klmChannel) {
      channel = klmChannel.getKLMChannelNumber();
      hits = m_Results.m_HitMapChannel.getChannelData(channel);
      if (hits > 0)
        activeChannels++;
    }
    m_Results.m_ModuleActiveChannelMap.setChannelData(module, activeChannels);
    KLMChannelIndex klmChannelMaxHits;
    while (1) {
      klmChannel = klmModule;
      klmChannel.setIndexLevel(KLMChannelIndex::c_IndexLevelStrip);
      maxHits = 0;
      for (; klmChannel != klmNextModule; ++klmChannel) {
        channel = klmChannel.getKLMChannelNumber();
        if (m_Results.m_ChannelStatus->getChannelStatus(channel) ==
            KLMChannelStatus::c_Hot)
          continue;
        hits = m_Results.m_HitMapChannel.getChannelData(channel);
        if (hits > maxHits) {
          klmChannelMaxHits = klmChannel;
          maxHits = hits;
        }
      }
      if (maxHits == 0)
        break;
      if (!markHotChannel(klmChannelMaxHits.getKLMChannelNumber(),
                          moduleHits, activeChannels))
        break;
      moduleHits -= maxHits;
      activeChannels--;
    }
  }
  /* Fill module and sector hit maps with hot channels subtracted. */
  for (KLMChannelIndex& klmModule : klmModules)
    m_Results.m_HitMapModuleNoHot.setChannelData(klmModule.getKLMModuleNumber(), 0);
  for (KLMChannelIndex& klmSector : klmSectors)
    m_Results.m_HitMapSectorNoHot.setChannelData(klmSector.getKLMSectorNumber(), 0);
  m_Results.m_HitNumberBKLMNoHot = 0;
  m_Results.m_HitNumberEKLMNoHot = 0;
  for (KLMChannelIndex& klmChannel : klmChannels) {
    channel = klmChannel.getKLMChannelNumber();
    if (m_Results.m_ChannelStatus->getChannelStatus(channel) == KLMChannelStatus::c_Hot)
      continue;
    module = klmChannel.getKLMModuleNumber();
    sector = klmChannel.getKLMSectorNumber();
    hits = m_Results.m_HitMapChannel.getChannelData(channel);
    m_Results.m_HitMapModuleNoHot.setChannelData(
      module, m_Results.m_HitMapModuleNoHot.getChannelData(module) + hits);
    m_Results.m_HitMapSectorNoHot.setChannelData(
      sector, m_Results.m_HitMapSectorNoHot.getChannelData(sector) + hits);
    if (m_ElementNumbers->isBKLMChannel(channel))
      m_Results.m_HitNumberBKLMNoHot += hits;
    else
      m_Results.m_HitNumberEKLMNoHot += hits;
  }
  /* Sector status. */
  int activeSectorsBKLM = 0;
  int activeSectorsEKLM = 0;
  for (KLMChannelIndex& klmSector : klmSectors) {
    sector = klmSector.getKLMSectorNumber();
    hits = m_Results.m_HitMapSectorNoHot.getChannelData(sector);
    if (hits > 0) {
      if (m_ElementNumbers->isBKLMChannel(sector))
        activeSectorsBKLM++;
      else
        activeSectorsEKLM++;
    }
  }
  double averageHitsActiveSector = 0;
  if (activeSectorsBKLM > 0) {
    averageHitsActiveSector = double(m_Results.m_HitNumberBKLMNoHot) /
                              activeSectorsBKLM;
  }
  for (KLMChannelIndex bklmSector = klmSectors.beginBKLM();
       bklmSector != klmSectors.endBKLM(); ++bklmSector) {
    sector = bklmSector.getKLMSectorNumber();
    calibrateSector(sector, averageHitsActiveSector);
  }
  if (activeSectorsEKLM > 0) {
    averageHitsActiveSector = double(m_Results.m_HitNumberEKLMNoHot) /
                              activeSectorsBKLM;
  }
  for (KLMChannelIndex eklmSector = klmSectors.beginEKLM();
       eklmSector != klmSectors.endEKLM(); ++eklmSector) {
    sector = eklmSector.getKLMSectorNumber();
    calibrateSector(sector, averageHitsActiveSector);
  }
  /* Module status. */
  if (m_Results.m_ModuleStatus == nullptr)
    m_Results.m_ModuleStatus = new KLMChannelStatus();
  for (KLMChannelIndex& klmModule : klmModules)
    calibrateModule(klmModule.getKLMModuleNumber());
  /* Channel-based calibration. */
  bool notEnoughData = false;
  for (KLMChannelIndex& klmModule : klmModules) {
    module = klmModule.getKLMModuleNumber();
    moduleHits = m_Results.m_HitMapModuleNoHot.getChannelData(module);
    KLMChannelIndex klmNextModule(klmModule);
    ++klmNextModule;
    KLMChannelIndex klmChannel(klmModule);
    klmChannel.setIndexLevel(KLMChannelIndex::c_IndexLevelStrip);
    if (moduleHits == 0)
      continue;
    unsigned int activeChannels = 0;
    for (; klmChannel != klmNextModule; ++klmChannel) {
      channel = klmChannel.getKLMChannelNumber();
      if (m_Results.m_ChannelStatus->getChannelStatus(channel) == KLMChannelStatus::c_Hot)
        continue;
      hits = m_Results.m_HitMapChannel.getChannelData(channel);
      if (hits > 0)
        activeChannels++;
    }
    double averageHits = double(moduleHits) / activeChannels;
    if (averageHits < m_MinimalAverageHitNumber && !m_ForcedCalibration) {
      if (!notEnoughData) {
        B2INFO("KLM module " << klmModule.getKLMModuleNumber() <<
               " (subdetector " << klmModule.getSubdetector() <<
               ", section " << klmModule.getSection() <<
               ", sector " << klmModule.getSector() <<
               ", layer " << klmModule.getLayer() <<
               "): " << moduleHits << " hits, average: " << averageHits << ".");
      }
      notEnoughData = true;
      continue;
    }
    klmChannel = klmModule;
    klmChannel.setIndexLevel(KLMChannelIndex::c_IndexLevelStrip);
    for (; klmChannel != klmNextModule; ++klmChannel)
      calibrateChannel(klmChannel.getKLMChannelNumber());
  }
  if (notEnoughData)
    return CalibrationAlgorithm::c_NotEnoughData;
  saveCalibration(m_Results.m_ChannelStatus, "KLMChannelStatus");
  return CalibrationAlgorithm::c_OK;
}

calibrateChannel()

void calibrateChannel ( KLMChannelNumber  channel )

protected

Calibrate channel.

Parameters

[in]

channel

Channel number.

Definition at line 327 of file KLMChannelStatusAlgorithm.cc.

{
  unsigned int hits = m_Results.m_HitMapChannel.getChannelData(channel);
  if (m_Results.m_ChannelStatus->getChannelStatus(channel) ==
      KLMChannelStatus::c_Hot)
    return;
  if (hits > 0) {
    m_Results.m_ChannelStatus->setChannelStatus(
      channel, KLMChannelStatus::c_Normal);
  } else {
    m_Results.m_ChannelStatus->setChannelStatus(
      channel, KLMChannelStatus::c_Dead);
  }
}

calibrateModule()

void calibrateModule ( KLMModuleNumber  module )

protected

Calibrate module.

Parameters

[in]

module

Module number.

Definition at line 293 of file KLMChannelStatusAlgorithm.cc.

{
  unsigned int hits = m_Results.m_HitMapModule.getChannelData(module);
  if (hits >= m_MinimalModuleHitNumber) {
    m_Results.m_ModuleStatus->setChannelStatus(
      module, KLMChannelStatus::c_Normal);
  } else {
    m_Results.m_ModuleStatus->setChannelStatus(
      module, KLMChannelStatus::c_Dead);
  }
}

calibrateSector()

void calibrateSector ( KLMSectorNumber  sector, double  averageHitsActiveSector  )

protected

Caliobrate sector.

Parameters

[in]	sector	sector number.
[in]	averageHitsActiveSector	Average number of hits per active sector.

Definition at line 278 of file KLMChannelStatusAlgorithm.cc.

{
  unsigned int hits = m_Results.m_HitMapSectorNoHot.getChannelData(sector);
  if (hits == 0)
    return;
  double r = log(hits / averageHitsActiveSector) / log(10.);
  if (fabs(r) > m_MaximalLogSectorHitsRatio) {
    B2WARNING("Number of hits in sector " << sector << " (" << hits <<
              ") strongly deviates from the average (" <<
              averageHitsActiveSector <<
              "), the 10-based logarithm of the ratio is " << r << ".");
  }
}

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

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

getMinimalAverageHitNumber()

double getMinimalAverageHitNumber ( ) const

inline

Get minimal average number of hits per channel required for calibration.

Definition at line 257 of file KLMChannelStatusAlgorithm.h.

    {
      return m_MinimalAverageHitNumber;
    }

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

getResults()

const Results * getResults ( ) const

inline

Get results.

Definition at line 274 of file KLMChannelStatusAlgorithm.h.

    {
      return &m_Results;
    }

getRunList()

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

inlineprotectedinherited

Get the list of runs for which calibration is called.

Definition at line 266 of file CalibrationAlgorithm.h.

{return m_data.getRequestedRuns();}

getRunListFromAllData()

vector< ExpRun > getRunListFromAllData ( ) const

inherited

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

Definition at line 318 of file CalibrationAlgorithm.cc.

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

getRunRangeFromAllData()

RunRange getRunRangeFromAllData ( ) const

inherited

Get the complete RunRange from inspection of collected data.

Definition at line 361 of file CalibrationAlgorithm.cc.

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

getVecInputFileNames()

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

inlineprotectedinherited

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

Definition at line 275 of file CalibrationAlgorithm.h.

{return m_inputFileNames;}

inputJsonKeyExists()

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

inlineprotectedinherited

Test for a key in the input JSON object.

Definition at line 360 of file CalibrationAlgorithm.h.

{return m_jsonExecutionInput.count(key);}

isBoundaryRequired()

virtual bool isBoundaryRequired ( const Calibration::ExpRun &  )

inlineprotectedvirtualinherited

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

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

Definition at line 243 of file CalibrationAlgorithm.h.

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

loadInputJson()

bool loadInputJson ( const std::string &  jsonString )

inherited

Load the m_inputJson variable from a string (useful from Python interface). The 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;
  }
}

markHotChannel()

bool markHotChannel ( KLMChannelNumber  channel, unsigned int  moduleHits, int  activeChannels  )

protected

Mark hot channel.

Parameters

[in]	channel	Channel number.
[in]	moduleHits	Number of hits in this module.
[in]	activeChannels	Number of active channels in this module.

Returns

True if the channel is marked as hot.

Definition at line 305 of file KLMChannelStatusAlgorithm.cc.

{
  unsigned int hits = m_Results.m_HitMapChannel.getChannelData(channel);
  if (activeChannels == 1) {
    if (hits >= m_MinimalHitNumberSingleHotChannel) {
      m_Results.m_ChannelStatus->setChannelStatus(
        channel, KLMChannelStatus::c_Hot);
      return true;
    }
  } else {
    double r = hits / (double(moduleHits - hits) / (activeChannels - 1));
    if (hits >= m_MinimalHitNumberHotChannel &&
        r > m_MinimalHitNumberRatioHotChannel) {
      m_Results.m_ChannelStatus->setChannelStatus(
        channel, KLMChannelStatus::c_Hot);
      return true;
    }
  }
  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;}

setForcedCalibration()

void setForcedCalibration ( bool  forcedCalibration )

inline

Set whether the calibration is forced (calibrate even for insufficient average number of hits).

Definition at line 205 of file KLMChannelStatusAlgorithm.h.

    {
      m_ForcedCalibration = forcedCalibration;
    }

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

setMaximalLogSectorHitsRatio()

void setMaximalLogSectorHitsRatio ( double  maximalLogSectorHitsRatio )

inline

Set maximal absolute value of the logarithm (base 10) of the ratio of the number of hits in this sector and the average number of hits.

Definition at line 222 of file KLMChannelStatusAlgorithm.h.

    {
      m_MaximalLogSectorHitsRatio = maximalLogSectorHitsRatio;
    }

setMinimalAverageHitNumber()

void setMinimalAverageHitNumber ( double  minimalAverageHitNumber )

inline

Set minimal average number of hits per channel required for calibration.

Definition at line 265 of file KLMChannelStatusAlgorithm.h.

    {
      m_MinimalAverageHitNumber = minimalAverageHitNumber;
    }

setMinimalHitNumberHotChannel()

void setMinimalHitNumberHotChannel ( unsigned int  minimalHitNumberHotChannel )

inline

Set inimal number of hits to mark to mark the channel as hot.

Definition at line 239 of file KLMChannelStatusAlgorithm.h.

    {
      m_MinimalHitNumberHotChannel = minimalHitNumberHotChannel;
    }

setMinimalHitNumberRatioHotChannel()

void setMinimalHitNumberRatioHotChannel ( double  minimalHitNumberRatioHotChannel )

inline

Minimal ratio of number of hits in this channel and average over other channels in this module to mark it as hot.

Definition at line 248 of file KLMChannelStatusAlgorithm.h.

    {
      m_MinimalHitNumberRatioHotChannel = minimalHitNumberRatioHotChannel;
    }

setMinimalHitNumberSingleHotChannel()

void setMinimalHitNumberSingleHotChannel ( unsigned int  minimalHitNumberSingleHotChannel )

inline

Set minimal number of hits in a single channel to mark it as hot.

Definition at line 230 of file KLMChannelStatusAlgorithm.h.

    {
      m_MinimalHitNumberSingleHotChannel = minimalHitNumberSingleHotChannel;
    }

setMinimalModuleHitNumber()

void setMinimalModuleHitNumber ( unsigned int  minimalModuleHitNumber )

inline

Set minimal number of hits per module for module-based calibration.

Definition at line 213 of file KLMChannelStatusAlgorithm.h.

    {
      m_MinimalModuleHitNumber = minimalModuleHitNumber;
    }

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

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_ElementNumbers

const KLMElementNumbers* m_ElementNumbers

protected

Element numbers.

Definition at line 346 of file KLMChannelStatusAlgorithm.h.

m_ForcedCalibration

bool m_ForcedCalibration = false

protected

Whether the calibration is forced (calibrate even for insufficient average number of hits).

Definition at line 319 of file KLMChannelStatusAlgorithm.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_MaximalLogSectorHitsRatio

double m_MaximalLogSectorHitsRatio = 1

protected

Maximal absolute value of the logarithm (base 10) of the ratio of the number of hits in this sector and the average number of hits.

Definition at line 331 of file KLMChannelStatusAlgorithm.h.

m_MinimalAverageHitNumber

double m_MinimalAverageHitNumber = 25

protected

Minimal average number of hits per channel required for calibration.

Definition at line 325 of file KLMChannelStatusAlgorithm.h.

m_MinimalHitNumberHotChannel

unsigned int m_MinimalHitNumberHotChannel = 100

protected

Minimal number of hits to mark to mark the channel as hot.

Definition at line 337 of file KLMChannelStatusAlgorithm.h.

m_MinimalHitNumberRatioHotChannel

double m_MinimalHitNumberRatioHotChannel = 50

protected

Minimal ratio of number of hits in this channel and average over other channels in this module to mark it as hot.

Definition at line 343 of file KLMChannelStatusAlgorithm.h.

m_MinimalHitNumberSingleHotChannel

unsigned int m_MinimalHitNumberSingleHotChannel = 1000

protected

Minimal number of hits in a single channel to mark it as hot.

Definition at line 334 of file KLMChannelStatusAlgorithm.h.

m_MinimalModuleHitNumber

unsigned int m_MinimalModuleHitNumber = 1

protected

Minimal module hit number for module-based calibration.

Definition at line 322 of file KLMChannelStatusAlgorithm.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_Results

Results m_Results

protected

Calibration results.

Definition at line 349 of file KLMChannelStatusAlgorithm.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.

---

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

• klm/calibration/include/KLMChannelStatusAlgorithm.h
• klm/calibration/src/KLMChannelStatusAlgorithm.cc