Belle II Software  release-08-01-10
eclee5x5Algorithm Class Reference

Calibrate ecl crystals using Bhabha events. More...

#include <eclee5x5Algorithm.h>

Inheritance diagram for eclee5x5Algorithm:
Collaboration diagram for eclee5x5Algorithm:

Public Types

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

Public Member Functions

 eclee5x5Algorithm ()
 ..Constructor More...
 
virtual ~eclee5x5Algorithm ()
 ..Destructor
 
void setOutputName (const std::string &outputName)
 Setter for m_outputName.
 
std::string getOutputName ()
 Getter for m_outputName.
 
void setMinEntries (int minEntries)
 Setter for m_minEntries.
 
int getMinEntries ()
 Getter for m_minEntries.
 
void setPayloadName (const std::string &payloadname)
 Setter for m_payloadName.
 
std::string getPayloadName ()
 Getter for m_payloadname.
 
void setStoreConst (bool storeConst)
 Setter for m_storeConst.
 
bool getStoreConst ()
 Getter for m_storeConst.
 
void setfracLo (double fracLo)
 Setter for m_fracLo.
 
double getfracLo ()
 Getter for m_fracLo.
 
void setfracHiSym (double fracHiSym)
 Setter for m_fracHiSym.
 
double getfracHiSym ()
 Getter for m_fracHiSym.
 
void setfracHiASym (double fracHiASym)
 Setter for m_fracHiASym.
 
double getfracHiASym ()
 Getter for m_fracHiASym.
 
void setnsigLo (double nsigLo)
 Setter for m_nsigLo.
 
double getnsigLo ()
 Getter for m_nsigLo.
 
void setnsigHiSym (double nsigHiSym)
 Setter for m_nsigHiSym.
 
double getnsigHiSym ()
 Getter for m_nsigHiSym.
 
void setnsigHiASym (double nsigHiASym)
 Setter for m_nsigHiASym.
 
double getnsigHiASym ()
 Getter for m_nsigHiASym.
 
void setlastLoThetaID (int lastLoThetaID)
 Setter for m_lastLoThetaID.
 
int getlastLoThetaID ()
 Getter for m_lastLoThetaID.
 
std::string getPrefix () const
 Get the prefix used for getting calibration data.
 
bool checkPyExpRun (PyObject *pyObj)
 Checks that a PyObject can be successfully converted to an ExpRun type. More...
 
Calibration::ExpRun convertPyExpRun (PyObject *pyObj)
 Performs the conversion of PyObject to ExpRun. More...
 
std::string getCollectorName () const
 Alias for prefix. More...
 
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. More...
 
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. More...
 
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::DBImportQuerygetPayloadValues ()
 Get constants (in TObjects) for database update from last execution but passed by VALUE.
 
bool commit ()
 Submit constants from last calibration into database.
 
bool commit (std::list< Database::DBImportQuery > payloads)
 Submit constants from a (potentially previous) set of payloads.
 
const std::string & getDescription () const
 Get the description of the algoithm (set by developers in constructor)
 
bool loadInputJson (const std::string &jsonString)
 Load the m_inputJson variable from a string (useful from Python interface). The rturn bool indicates success or failure.
 
const std::string dumpOutputJson () const
 Dump the JSON string of the output JSON object.
 
const std::vector< Calibration::ExpRun > findPayloadBoundaries (std::vector< Calibration::ExpRun > runs, int iteration=0)
 Used to discover the ExpRun boundaries that you want the Python CAF to execute on. This is optional and only used in some.
 
template<>
std::shared_ptr< TTree > getObjectPtr (const std::string &name, const std::vector< Calibration::ExpRun > &requestedRuns)
 Specialization of getObjectPtr<TTree>.
 

Protected Member Functions

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

Protected Attributes

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

Private Member Functions

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

Private Attributes

std::string m_outputName = "eclee5x5Algorithm.root"
 ..Parameters to control job to find energy calibration using Bhabhas More...
 
int m_minEntries = 150
 all crystals to be calibrated must have this many entries
 
std::string m_payloadName = "ECLCrystalEnergy5x5"
 Name of the payload to be stored. More...
 
bool m_storeConst = true
 write payload to localdb if true
 
ECL::ECLNeighboursm_eclNeighbours5x5 {nullptr}
 Neighbours, used to get nCrys per ring.
 
double m_fracLo = 0.2
 start dPhi fit where data is > fraclo*peak
 
double m_fracHiSym = 0.2
 end dPhi fit where data is > fracHiSym*peak
 
double m_fracHiASym = 0.4
 or fracHiASym*peak, at low values of thetaID
 
double m_nsigLo = 2.5
 dPhi region is mean - nsigLo*sigma
 
double m_nsigHiSym = 2.5
 to mean + nsigHiSym*sigma
 
double m_nsigHiASym = 2.0
 or mean+nsigHiASym*sigma at low thetaID
 
int m_lastLoThetaID = 4
 use asymmetric dPhi range for thetaID<= this value
 
std::vector< std::string > m_inputFileNames
 List of input files to the Algorithm, will initially be user defined but then gets the wildcards expanded during execute()
 
std::map< Calibration::ExpRun, std::vector< std::string > > m_runsToInputFiles
 Map of Runs to input files. Gets filled when you call getRunRangeFromAllData, gets cleared when setting input files again.
 
std::string m_granularityOfData
 Granularity of input data. This only changes when the input files change so it isn't specific to an execution.
 
ExecutionData m_data
 Data specific to a SINGLE execution of the algorithm. Gets reset at the beginning of execution.
 
std::string m_description {""}
 Description of the algorithm.
 
std::string m_prefix {""}
 The name of the TDirectory the collector objects are contained within.
 
nlohmann::json m_jsonExecutionInput = nlohmann::json::object()
 Optional input JSON object used to make decisions about how to execute the algorithm code.
 
nlohmann::json m_jsonExecutionOutput = nlohmann::json::object()
 Optional output JSON object that can be set during the execution by the underlying algorithm code.
 

Static Private Attributes

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

Detailed Description

Calibrate ecl crystals using Bhabha events.

Definition at line 25 of file eclee5x5Algorithm.h.

Member Enumeration Documentation

◆ EResult

enum EResult
inherited

The result of calibration.

Enumerator
c_OK 

Finished successfuly =0 in Python.

c_Iterate 

Needs iteration =1 in Python.

c_NotEnoughData 

Needs more data =2 in Python.

c_Failure 

Failed =3 in Python.

c_Undefined 

Not yet known (before execution) =4 in Python.

Definition at line 40 of file CalibrationAlgorithm.h.

Constructor & Destructor Documentation

◆ eclee5x5Algorithm()

..Constructor


Definition at line 30 of file eclee5x5Algorithm.cc.

30  : CalibrationAlgorithm("eclee5x5Collector")
31 {
33  "Perform energy calibration of ecl crystals by analyzing energy in 25-crystal sums from Bhabha events"
34  );
35 }
void setDescription(const std::string &description)
Set algorithm description (in constructor)
CalibrationAlgorithm(const std::string &collectorModuleName)
Constructor - sets the prefix for collected objects (won't be accesses until execute(....

Member Function Documentation

◆ calibrate()

CalibrationAlgorithm::EResult calibrate ( )
overrideprotectedvirtual

..Run algorithm on events


Clean up existing histograms if necessary

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


Write out the job parameters


Histograms containing the data collected by eclee5x5CollectorModule


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


Write out the basic histograms in all cases


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


Check that all crystals to be calibrated have enough statistics

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


need crystal per ring for the dPhi payloads


Ready to find new calibration constants


Expected energy payload


Single crystal energy calibration from matrix inversion


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

first thetaID with enough statistics

last thetaID with enough statistics

not equal to mean at low thetaID


Invalid payload specified


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


Set the return code appropriately

Implements CalibrationAlgorithm.

Definition at line 37 of file eclee5x5Algorithm.cc.

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

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

◆ execute()

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.

◆ getCollectorName()

std::string getCollectorName ( ) const
inlineinherited

Alias for prefix.

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

Definition at line 164 of file CalibrationAlgorithm.h.

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

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

Member Data Documentation

◆ m_outputName

std::string m_outputName = "eclee5x5Algorithm.root"
private

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

file name for histogram output

Definition at line 108 of file eclee5x5Algorithm.h.

◆ m_payloadName

std::string m_payloadName = "ECLCrystalEnergy5x5"
private

Name of the payload to be stored.

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

Definition at line 111 of file eclee5x5Algorithm.h.


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