class eclCosmiEAlgorithm. More...

#include <eclCosmicEAlgorithm.h>

Inheritance diagram for eclCosmicEAlgorithm:

Collaboration diagram for eclCosmicEAlgorithm:

[legend]

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

Public Member Functions
	eclCosmicEAlgorithm ()
	Constructor.

virtual	~eclCosmicEAlgorithm ()
	Destructor.

std::string	getPrefix () const
	Get the prefix used for getting calibration data.

bool	checkPyExpRun (PyObject *pyObj)
	Checks that a PyObject can be successfully converted to an ExpRun type. 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::DBImportQuery >	getPayloadValues ()
	Get constants (in TObjects) for database update from last execution but passed by VALUE.

bool	commit ()
	Submit constants from last calibration into database.

bool	commit (std::list< Database::DBImportQuery > payloads)
	Submit constants from a (potentially previous) set of payloads.

const std::string &	getDescription () const
	Get the description of the algoithm (set by developers in constructor)

bool	loadInputJson (const std::string &jsonString)
	Load the m_inputJson variable from a string (useful from Python interface). The rturn bool indicates success or failure.

const std::string	dumpOutputJson () const
	Dump the JSON string of the output JSON object.

const std::vector< Calibration::ExpRun >	findPayloadBoundaries (std::vector< Calibration::ExpRun > runs, int iteration=0)
	Used to discover the ExpRun boundaries that you want the Python CAF to execute on. This is optional and only used in some.

template<>
std::shared_ptr< TTree >	getObjectPtr (const std::string &name, const std::vector< Calibration::ExpRun > &requestedRuns)
	Specialization of getObjectPtr<TTree>.

Public Attributes
int	cellIDLo
	Parameters to control Novosibirsk fit to signal measured in each crystal. More...

int	cellIDHi
	Last cellID to be fit.

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

int	maxIterations
	no more than maxIteration iterations

double	tRatioMin
	Fit range is adjusted so that fit at upper endpoint is between tRatioMin and tRatioMax of peak.

double	tRatioMax
	Fit range is adjusted so that fit at upper endpoint is between tRatioMin and tRatioMax of peak.

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

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

int	storeConst
	controls which values are written to the database. More...

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
int	fitOK = 16
	fit is OK

int	iterations = 8
	fit reached max number of iterations, but is useable

int	atLimit = 4
	a parameter is at the limit; fit not useable

int	poorFit = 3
	low chi square; fit not useable

int	noPeak = 2
	Novosibirsk component of fit is negligible; fit not useable.

int	notFit = -1
	no fit performed

std::vector< std::string >	m_inputFileNames
	List of input files to the Algorithm, will initially be user defined but then gets the wildcards expanded during execute()

std::map< Calibration::ExpRun, std::vector< std::string > >	m_runsToInputFiles
	Map of Runs to input files. Gets filled when you call getRunRangeFromAllData, gets cleared when setting input files again.

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

ExecutionData	m_data
	Data specific to a SINGLE execution of the algorithm. Gets reset at the beginning of execution.

std::string	m_description {""}
	Description of the algorithm.

std::string	m_prefix {""}
	The name of the TDirectory the collector objects are contained within.

nlohmann::json	m_jsonExecutionInput = nlohmann::json::object()
	Optional input JSON object used to make decisions about how to execute the algorithm code.

nlohmann::json	m_jsonExecutionOutput = nlohmann::json::object()
	Optional output JSON object that can be set during the execution by the underlying algorithm code.

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

Detailed Description

class eclCosmiEAlgorithm.

Analyze histograms of normalized energy for each ECL crystal from cosmic ray events. Code can either find most-likely energy deposit for each crystal using CRY MC or calibration constant for each crystal (data)

Definition at line 24 of file eclCosmicEAlgorithm.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.

Member Function Documentation

◆ calibrate()

CalibrationAlgorithm::EResult calibrate ( )

overrideprotectedvirtual

Run algorithm on events.

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

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

..Clean up existing histograms if necessary

..Histograms containing the data collected by eclCosmicECollectorModule

..Record the number of entries per crystal in each of the two normalized energy histograms and average the constants obtained from DB

..Write out the basic histograms in all cases

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

..Check that every crystal has enough entries. If we are finding calibration constants (normal data mode), at least 1 histogram must have sufficient statistics. If we are finding expected values (used with MC), both must have sufficient statistics.

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

..Some prep for the many fits about to follow

..1D summary histograms

..Histograms to store results for DB

..Loop over specified crystals and performs fits to the two normalized energy distributions

..Extract the 1D normalized energy distribution from the appropriate 2D histogram

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

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

..Fit range is histogram low edge plus a few bins to peak + 2.5*effective sigma

..Constant from lower edge of plot

..Eta is nominal

..parameters to control iterations. dIter checks if we are stuck in a loop

..Iterate from this point if needed

..Set the initial parameters

..Perform the fit and note the resulting parameters

..The upper fit range should correspond to 20-25% of the peak. Iterate if necessary.

..Check if we are oscillating between two end points

..Many iterations may mean we are stuck in a loop. Try a different end point.

..Set the constant term to 0 if we are close to the limit

..No more than specified number of iterations

..Calculate fit probability. Same as P option in fit, which cannot be used with L

..Fit status

No peak; normalization of Novo component is too small

..poor fit, or relatively poor fit with too many iterations

..parameter at limit

..Store the fit results

..Write out the fit distribution

..Find expected energies from MC, if requested

..Write out expected energies if status is adequate. Check that every crystal has at least one good fit

..Otherwise, find calibration constants

..Find calibration constant separately for the two normalized energy distributions for each crystal

..Peak and uncertainty; assume uncertainties on expected energy and elec calib are negligible

..Find the weighted average of the two constants and store in the histogram

..If both fits failed, use the negative of the initial "same" calibration constant

..Write output to DB if requested and successful

..Store expected energy for each crystal and neighbour type from CRY MC

..Store calibration constant for each crystal (nominally real data)

..Write out some diagnostic histograms

..Histograms containing values written to DB

..Clean up histograms in case Algorithm is called again

..Set the return code appropriately

Implements CalibrationAlgorithm.

Definition at line 64 of file eclCosmicEAlgorithm.cc.

 {
  
   double limitTol = 0.0005; /*< tolerance for checking if a parameter is at the limit */
   double minFitLimit = 1e-25; /*< cut off for labeling a fit as poor */
   double minFitProbIter = 1e-8; /*< cut off for labeling a fit as poor if it also has many iterations */
   double constRatio = 0.5; /*< Novosibirsk normalization must be greater than constRatio x constant term */
   double peakMin(0.5), peakMax(1.75); /*< range for peak of measured energy distribution */
   double peakTol = limitTol * (peakMax - peakMin); /*< fit is at limit if it is within peakTol of min or max */
   double effSigMin(0.08), effSigMax(0.5); /*< range for effective sigma of measured energy distribution */
   double effSigTol = limitTol * (effSigMax - effSigMin);
   double etaMin(-3.), etaMax(1.); /*< Novosibirsk tail parameter range */
   double etaNom(-0.41); /*< Nominal tail parameter */
   double etaTol = limitTol * (etaMax - etaMin);
   double constTol = 0.1; /*< if constant is less than constTol, it will be fixed to 0 */
  
   gROOT->SetBatch();
  
   TH1F* dummy;
   dummy = (TH1F*)gROOT->FindObject("EnvsCrysSameRing");
   if (dummy) {delete dummy;}
   dummy = (TH1F*)gROOT->FindObject("EnvsCrysDifferentRing");
   if (dummy) {delete dummy;}
   dummy = (TH1F*)gROOT->FindObject("IntegralVsCrysSame");
   if (dummy) {delete dummy;}
   dummy = (TH1F*)gROOT->FindObject("IntegralVsCrysDifferent");
   if (dummy) {delete dummy;}
   dummy = (TH1F*)gROOT->FindObject("AverageExpECrysSame");
   if (dummy) {delete dummy;}
   dummy = (TH1F*)gROOT->FindObject("AverageExpECrysDifferent");
   if (dummy) {delete dummy;}
   dummy = (TH1F*)gROOT->FindObject("AverageElecCalibSame");
   if (dummy) {delete dummy;}
   dummy = (TH1F*)gROOT->FindObject("AverageElecCalibDifferent");
   if (dummy) {delete dummy;}
   dummy = (TH1F*)gROOT->FindObject("AverageInitialCalibSame");
   if (dummy) {delete dummy;}
   dummy = (TH1F*)gROOT->FindObject("AverageInitialCalibDifferent");
   if (dummy) {delete dummy;}
  
   std::vector<std::shared_ptr<TH2F>> EnvsCrys;
   EnvsCrys.push_back(getObjectPtr<TH2F>("EnvsCrysSameRing"));
   EnvsCrys.push_back(getObjectPtr<TH2F>("EnvsCrysDifferentRing"));
  
   std::vector<std::shared_ptr<TH1F>> ExpEvsCrys;
   ExpEvsCrys.push_back(getObjectPtr<TH1F>("ExpEvsCrysSameRing"));
   ExpEvsCrys.push_back(getObjectPtr<TH1F>("ExpEvsCrysDifferentRing"));
  
   std::vector<std::shared_ptr<TH1F>> ElecCalibvsCrys;
   ElecCalibvsCrys.push_back(getObjectPtr<TH1F>("ElecCalibvsCrysSameRing"));
   ElecCalibvsCrys.push_back(getObjectPtr<TH1F>("ElecCalibvsCrysDifferentRing"));
  
   std::vector<std::shared_ptr<TH1F>> InitialCalibvsCrys;
   InitialCalibvsCrys.push_back(getObjectPtr<TH1F>("InitialCalibvsCrysSameRing"));
   InitialCalibvsCrys.push_back(getObjectPtr<TH1F>("InitialCalibvsCrysDifferentRing"));
  
   std::vector<std::shared_ptr<TH1F>> CalibEntriesvsCrys;
   CalibEntriesvsCrys.push_back(getObjectPtr<TH1F>("CalibEntriesvsCrysSameRing"));
   CalibEntriesvsCrys.push_back(getObjectPtr<TH1F>("CalibEntriesvsCrysDifferentRing"));
  
   auto RawDigitAmpvsCrys = getObjectPtr<TH2F>("RawDigitAmpvsCrys");
  
   TH1F* IntegralVsCrys[2];
   IntegralVsCrys[0] = new TH1F("IntegralVsCrysSame", "Integral of EnVsCrys for each crystal, same theta ring;Crystal ID",
                                ECLElementNumbers::c_NCrystals, 0,
                                ECLElementNumbers::c_NCrystals);
   IntegralVsCrys[1] = new TH1F("IntegralVsCrysDifferent", "Integral of EnVsCrys for each crystal, different theta rings;Crystal ID",
                                ECLElementNumbers::c_NCrystals, 0, ECLElementNumbers::c_NCrystals);
  
   TH1F* AverageExpECrys[2];
   AverageExpECrys[0] = new TH1F("AverageExpECrysSame",
                                 "Average expected E per crys from collector, same theta ring;Crystal ID;Energy (GeV)", ECLElementNumbers::c_NCrystals, 0,
                                 ECLElementNumbers::c_NCrystals);
   AverageExpECrys[1] = new TH1F("AverageExpECrysDifferent",
                                 "Average expected E per crys from collector, different theta ring;Crystal ID;Energy (GeV)", ECLElementNumbers::c_NCrystals, 0,
                                 ECLElementNumbers::c_NCrystals);
  
   TH1F* AverageElecCalib[2];
   AverageElecCalib[0] = new TH1F("AverageElecCalibSame",
                                  "Average electronics calib const vs crys, same theta ring;Crystal ID;Calibration constant", ECLElementNumbers::c_NCrystals, 0,
                                  ECLElementNumbers::c_NCrystals);
   AverageElecCalib[1] = new TH1F("AverageElecCalibDifferent",
                                  "Average electronics calib const vs crys, different theta rings;Crystal ID;Calibration constant", ECLElementNumbers::c_NCrystals, 0,
                                  ECLElementNumbers::c_NCrystals);
  
   TH1F* AverageInitialCalib[2];
   AverageInitialCalib[0] = new TH1F("AverageInitialCalibSame",
                                     "Average initial cosmic calib const vs crys, same theta ring;Crystal ID;Calibration constant", ECLElementNumbers::c_NCrystals, 0,
                                     ECLElementNumbers::c_NCrystals);
   AverageInitialCalib[1] = new TH1F("AverageInitialCalibDifferent",
                                     "Average initial cosmic calib const vs crys, different theta rings;Crystal ID;Calibration constant", ECLElementNumbers::c_NCrystals,
                                     0, ECLElementNumbers::c_NCrystals);
  
   for (int crysID = 0; crysID < ECLElementNumbers::c_NCrystals; crysID++) {
     int histbin = crysID + 1;
     for (int idir = 0; idir < 2; idir++) {
       TH1D* hEnergy = EnvsCrys[idir]->ProjectionY("hEnergy", histbin, histbin);
       int Integral = hEnergy->Integral();
       IntegralVsCrys[idir]->SetBinContent(histbin, Integral);
  
       double TotEntries = CalibEntriesvsCrys[idir]->GetBinContent(histbin);
  
       double expectedE = 0.;
       if (TotEntries > 0.) {expectedE = ExpEvsCrys[idir]->GetBinContent(histbin) / TotEntries;}
       AverageExpECrys[idir]->SetBinContent(histbin, expectedE);
       AverageExpECrys[idir]->SetBinError(histbin, 0.);
  
       double calibconst = 0.;
       if (TotEntries > 0.) {calibconst = ElecCalibvsCrys[idir]->GetBinContent(histbin) / TotEntries;}
       AverageElecCalib[idir]->SetBinContent(histbin, calibconst);
       AverageElecCalib[idir]->SetBinError(histbin, 0);
  
       calibconst = 0.;
       if (TotEntries > 0.) {calibconst = InitialCalibvsCrys[idir]->GetBinContent(histbin) / TotEntries;}
       AverageInitialCalib[idir]->SetBinContent(histbin, calibconst);
       AverageInitialCalib[idir]->SetBinError(histbin, 0);
     }
   }
  
   TFile* histfile = new TFile("eclCosmicEAlgorithm.root", "recreate");
   for (int idir = 0; idir < 2; idir++) {
     EnvsCrys[idir]->Write();
     IntegralVsCrys[idir]->Write();
     AverageExpECrys[idir]->Write();
     AverageElecCalib[idir]->Write();
     AverageInitialCalib[idir]->Write();
   }
   RawDigitAmpvsCrys->Write();
  
   if (!performFits) {
     B2INFO("eclCosmicEAlgorithm has not been asked to perform fits; copying input histograms and quitting");
     histfile->Close();
     return c_NotEnoughData;
   }
  
   bool sufficientData = true;
   for (int crysID = cellIDLo - 1; crysID < cellIDHi; crysID++) {
     int histbin = crysID + 1;
     bool SameLow = IntegralVsCrys[0]->GetBinContent(histbin) < minEntries;
     bool DifferentLow = IntegralVsCrys[1]->GetBinContent(histbin) < minEntries;
     if ((SameLow && DifferentLow) || (findExpValues && (SameLow || DifferentLow))) {
       if (storeConst == 1) {B2INFO("eclCosmicEAlgorithm: cellID " << histbin << " has insufficient statistics: " << IntegralVsCrys[0]->GetBinContent(histbin) << " and " << IntegralVsCrys[1]->GetBinContent(histbin) << ". Requirement is " << minEntries);}
       sufficientData = false;
       break;
     }
   }
  
   if (!sufficientData && storeConst == 1) {
     histfile->Close();
     return c_NotEnoughData;
   }
  
   const TString preName[2] = {"SameRing", "DifferentRing"};
  
   TH1F* PeakperCrys[2];
   PeakperCrys[0] = new TH1F("PeakperCrysSame", "Fit peak per crystal, same theta ring;Crystal ID;Peak normalized energy",
                             ECLElementNumbers::c_NCrystals, 0,
                             ECLElementNumbers::c_NCrystals);
   PeakperCrys[1] = new TH1F("PeakperCrysDifferent", "Fit peak per crystal, different theta ring;Crystal ID;Peak normalized energy",
                             ECLElementNumbers::c_NCrystals, 0, ECLElementNumbers::c_NCrystals);
  
   TH1F* SigmaperCrys[2];
   SigmaperCrys[0] = new TH1F("SigmaperCrysSame", "Fit sigma per crysal, same theta ring;Crystal ID;Sigma (ADC)",
                              ECLElementNumbers::c_NCrystals, 0, ECLElementNumbers::c_NCrystals);
   SigmaperCrys[1] = new TH1F("SigmaperCrysDifferent", "Fit sigma per crysal, different theta ring;Crystal ID;Sigma (ADC)",
                              ECLElementNumbers::c_NCrystals, 0,
                              ECLElementNumbers::c_NCrystals);
  
   TH1F* EtaperCrys[2];
   EtaperCrys[0] = new TH1F("EtaperCrysSame", "Fit eta per crysal, same theta ring;Crystal ID;Eta", ECLElementNumbers::c_NCrystals, 0,
                            ECLElementNumbers::c_NCrystals);
   EtaperCrys[1] = new TH1F("EtaperCrysDifferent", "Fit eta per crysal, different theta ring;Crystal ID;Eta",
                            ECLElementNumbers::c_NCrystals, 0, ECLElementNumbers::c_NCrystals);
  
   TH1F* ConstperCrys[2];
   ConstperCrys[0] = new TH1F("ConstperCrysSame", "Fit constant per crystal, same theta ring;Crystal ID;Constant",
                              ECLElementNumbers::c_NCrystals, 0, ECLElementNumbers::c_NCrystals);
   ConstperCrys[1] = new TH1F("ConstperCrysDifferent", "Fit constant per crystal, different theta ring;Crystal ID;Constant",
                              ECLElementNumbers::c_NCrystals, 0,
                              ECLElementNumbers::c_NCrystals);
  
   TH1F* StatusperCrys[2];
   StatusperCrys[0] = new TH1F("StatusperCrysSame", "Fit status, same theta ring;Crystal ID;Status", ECLElementNumbers::c_NCrystals, 0,
                               ECLElementNumbers::c_NCrystals);
   StatusperCrys[1] = new TH1F("StatusperCrysDifferent", "Fit status, different theta ring;Crystal ID;Status",
                               ECLElementNumbers::c_NCrystals, 0, ECLElementNumbers::c_NCrystals);
  
   TH1F* hStatus[2];
   hStatus[0] = new TH1F("StatusSame", "Fit status, same theta ring", 25, -5, 20);
   hStatus[1] = new TH1F("StatusDifferent", "Fit status, different theta ring", 25, -5, 20);
  
   TH1F* fracPeakUnc[2];
   fracPeakUnc[0] = new TH1F("fracPeakUncSame", "Fractional uncertainty on peak location, same theta ring", 100, 0, 0.1);
   fracPeakUnc[1] = new TH1F("fracPeakUncDifferent", "Fractional uncertainty on peak location, different theta ring", 100, 0, 0.1);
  
   TH1F* hfitProb[2];
   hfitProb[0] = new TH1F("fitProbSame", "Probability of fit, same theta ring", 200, 0, 0.02);
   hfitProb[1] = new TH1F("fitProbDifferent", "Probability of fit, different theta ring", 200, 0, 0.02);
  
   TH1F* ExpEnergyperCrys[2];
   ExpEnergyperCrys[0] = new TH1F("ExpEnergyperCrysSame", "Expected energy per crystal, same theta ring;Crystal ID;Peak energy (GeV)",
                                  ECLElementNumbers::c_NCrystals, 0, ECLElementNumbers::c_NCrystals);
   ExpEnergyperCrys[1] = new TH1F("ExpEnergyperCrysDifferent",
                                  "Expected energy per crystal, different theta ring;Crystal ID;Peak energy (GeV)", ECLElementNumbers::c_NCrystals, 0,
                                  ECLElementNumbers::c_NCrystals);
  
   TH1F* CalibvsCrys = new TH1F("CalibvsCrys", "Energy calibration constant from cosmics;Crystal ID;Calibration constant",
                                ECLElementNumbers::c_NCrystals, 0,
                                ECLElementNumbers::c_NCrystals);
  
   bool allFitsOK = true;
   for (int crysID = cellIDLo - 1; crysID < cellIDHi; crysID++) {
     int histbin = crysID + 1;
     for (int idir = 0; idir < 2; idir++) {
  
       TString hname = preName[idir];
       hname += "Enormalized";
       hname += crysID;
       TH1D* hEnergy = EnvsCrys[idir]->ProjectionY(hname, histbin, histbin);
  
       double histMin = hEnergy->GetXaxis()->GetXmin();
       double histMax = hEnergy->GetXaxis()->GetXmax();
       TF1* func = new TF1("eclCosmicNovoConst", eclCosmicNovoConst, histMin, histMax, 5);
       func->SetParNames("normalization", "peak", "effSigma", "eta", "const");
       func->SetParLimits(1, peakMin, peakMax);
       func->SetParLimits(2, effSigMin, effSigMax);
       func->SetParLimits(3, etaMin, etaMax);
  
       hEnergy->GetXaxis()->SetRangeUser(peakMin, peakMax);
       int maxBin = hEnergy->GetMaximumBin();
       double peakE = hEnergy->GetBinLowEdge(maxBin);
       double peakEUnc = 0.;
       double normalization = hEnergy->GetMaximum();
       double effSigma = hEnergy->GetRMS();
       double sigmaUnc = 0.;
       hEnergy->GetXaxis()->SetRangeUser(histMin, histMax);
  
       double fitlow = 0.25;
       double fithigh = peakE + 2.5 * effSigma;
  
       int il0 = hEnergy->GetXaxis()->FindBin(fitlow);
       int il1 = hEnergy->GetXaxis()->FindBin(fitlow + 0.1);
       double constant = hEnergy->Integral(il0, il1) / (1 + il1 - il0);
       double constUnc = 0.;
  
       double eta = etaNom;
       double etaUnc = 0.;
  
       double dIter = 0.1 * (histMax - histMin) / hEnergy->GetNbinsX();
       double highold(0.), higholdold(0.);
       double fitProb(0.);
       double fitProbDefault(0.);
       bool fitHist = IntegralVsCrys[idir]->GetBinContent(histbin) >= minEntries; /* fit only if enough events */
       bool fixConst = false;
       int nIter = 0;
  
       while (fitHist) {
         nIter++;
  
         func->SetParameters(normalization, peakE, effSigma, eta, constant);
         if (fixConst) { func->FixParameter(4, 0); }
  
         hEnergy->Fit(func, "LIQ", "", fitlow, fithigh);
         normalization = func->GetParameter(0);
         peakE = func->GetParameter(1);
         peakEUnc = func->GetParError(1);
         effSigma = func->GetParameter(2);
         sigmaUnc = func->GetParError(2);
         eta = func->GetParameter(3);
         etaUnc = func->GetParError(3);
         constant = func->GetParameter(4);
         constUnc = func->GetParError(4);
         fitProbDefault = func->GetProb();
  
         fitHist = false;
         double peak = func->Eval(peakE) - constant;
         double tRatio = (func->Eval(fithigh) - constant) / peak;
         if (tRatio < tRatioMin || tRatio > tRatioMax) {
           double targetY = constant + 0.5 * (tRatioMin + tRatioMax) * peak;
           higholdold = highold;
           highold = fithigh;
           fithigh = func->GetX(targetY, peakE, histMax);
           fitHist = true;
  
           if (abs(fithigh - higholdold) < dIter) {fithigh = 0.5 * (highold + higholdold); }
  
           if (nIter > maxIterations - 3) {fithigh = 0.33333 * (fithigh + highold + higholdold); }
         }
  
         if (constant < constTol && !fixConst) {
           constant = 0;
           fixConst = true;
           fitHist = true;
         }
  
         if (nIter == maxIterations) {fitHist = false;}
         B2DEBUG(200, "cellID = " << histbin << " " << nIter << " " << preName[idir] << " " << peakE << " " << constant << " " << tRatio <<
                 " " << fithigh);
  
       }
  
       fitProb = 0.;
       if (nIter > 0) {
         int lowbin = hEnergy->GetXaxis()->FindBin(fitlow);
         int highbin = hEnergy->GetXaxis()->FindBin(fithigh);
         int npar = 5;
         if (fixConst) {npar = 4;}
         int ndeg = (highbin - lowbin) + 1 - npar;
         double chisq = 0.;
         double halfbinwidth = 0.5 * hEnergy->GetBinWidth(1);
         for (int ib = lowbin; ib <= highbin; ib++) {
           double yexp = func->Eval(hEnergy->GetBinLowEdge(ib) + halfbinwidth);
           double yobs = hEnergy->GetBinContent(ib);
           double dchi2 = (yexp - yobs) * (yexp - yobs) / yexp;
           chisq += dchi2;
         }
         fitProb = 0.5 * (TMath::Prob(chisq, ndeg) + fitProbDefault);
       }
  
       int iStatus = fitOK; // success
       if (nIter == maxIterations) {iStatus = iterations;} // too many iterations
  
       if (normalization < constRatio * constant) {iStatus = noPeak;}
  
       if (fitProb <= minFitLimit || (fitProb < minFitProbIter && iStatus == iterations)) {iStatus = poorFit;}
  
       if ((peakE < peakMin + peakTol) || (peakE > peakMax - peakTol)) {iStatus = atLimit;}
       if ((effSigma < effSigMin + effSigTol) || (effSigma > effSigMax - effSigTol)) {iStatus = atLimit;}
       if ((eta < etaMin + etaTol) || (eta > etaMax - etaTol)) {iStatus = atLimit;}
  
       //**..No fit
       if (nIter == 0) {iStatus = notFit;} // not fit
  
       PeakperCrys[idir]->SetBinContent(histbin, peakE);
       PeakperCrys[idir]->SetBinError(histbin, peakEUnc);
       SigmaperCrys[idir]->SetBinContent(histbin, effSigma);
       SigmaperCrys[idir]->SetBinError(histbin, sigmaUnc);
       EtaperCrys[idir]->SetBinContent(histbin, eta);
       EtaperCrys[idir]->SetBinError(histbin, etaUnc);
       ConstperCrys[idir]->SetBinContent(histbin, constant);
       ConstperCrys[idir]->SetBinError(histbin, constUnc);
       StatusperCrys[idir]->SetBinContent(histbin, iStatus);
       hStatus[idir]->Fill(iStatus);
       fracPeakUnc[idir]->Fill(peakEUnc / peakE);
       hfitProb[idir]->Fill(fitProb);
  
       B2INFO("cellID " << histbin << " " << preName[idir] << " status = "  << iStatus << " fit probability = " << fitProb);
       histfile->cd();
       hEnergy->Write();
     }
   }
  
   if (findExpValues) {
  
     for (int crysID = 0; crysID < ECLElementNumbers::c_NCrystals; crysID++) {
       int histbin = crysID + 1;
       bool atLeastOneOK = false;
       for (int idir = 0; idir < 2; idir++) {
         double fitstatus = StatusperCrys[idir]->GetBinContent(histbin);
         double peakE = PeakperCrys[idir]->GetBinContent(histbin);
         double peakEUnc = PeakperCrys[idir]->GetBinError(histbin);
  
         //**..For failed fits, store the negative of the input expected energy */
         if (fitstatus < iterations) {
           if (histbin >= cellIDLo && histbin <= cellIDHi) {
             B2INFO("eclCosmicEAlgorithm: crystal " << crysID << " " << preName[idir] << " is not a successful fit. Status = " << fitstatus);
           }
           peakE = -1.;
           peakEUnc = 0.;
         } else {
           atLeastOneOK = true;
         }
         double inputExpE = abs(AverageExpECrys[idir]->GetBinContent(histbin));
         ExpEnergyperCrys[idir]->SetBinContent(histbin, inputExpE * peakE);
         ExpEnergyperCrys[idir]->SetBinError(histbin, inputExpE * peakEUnc / peakE);
       }
       if (!atLeastOneOK) {allFitsOK = false;}
     }
  
   } else {
  
     for (int crysID = 0; crysID < ECLElementNumbers::c_NCrystals; crysID++) {
       int histbin = crysID + 1;
       double calibConst[2] = {};
       double calibConstUnc[2] = {999999., 999999.};
       double weight[2] = {};
       bool bothFitsBad = true;
       for (int idir = 0; idir < 2; idir++) {
  
         double peakE = PeakperCrys[idir]->GetBinContent(histbin);
         double fracPeakEUnc = PeakperCrys[idir]->GetBinError(histbin) / peakE;
         double inputConst = AverageInitialCalib[idir]->GetBinContent(histbin);
         double fitstatus = StatusperCrys[idir]->GetBinContent(histbin);
         double inputExpE = AverageExpECrys[idir]->GetBinContent(histbin);
         if (fitstatus >= iterations && inputConst == 0) {B2FATAL("eclCosmicEAlgorithm: input calibration = 0 for idir = " << idir << " and crysID = " << crysID);}
  
         //** Find constant only if fit was successful and we have a value for the expected energy */
         if (fitstatus >= iterations && inputExpE > 0.) {
           calibConst[idir] = abs(inputConst) / peakE;
           calibConstUnc[idir] = calibConst[idir] * fracPeakEUnc / peakE;
           weight[idir] = 1. / (calibConstUnc[idir] * calibConstUnc[idir]);
           bothFitsBad = false;
         }
         if (fitstatus < iterations && histbin >= cellIDLo && histbin <= cellIDHi) {
           B2INFO("eclCosmicEAlgorithm: cellID " << histbin << " " << preName[idir] << " is not a successful fit. Status = " << fitstatus);
         } else if (inputExpE < 0. && histbin >= cellIDLo && histbin <= cellIDHi) {
           B2WARNING("eclCosmicEAlgorithm: cellID " << histbin << " " << preName[idir] << " has no expected energy. Status = " << fitstatus);
         }
       }
  
  
       double averageConst;
       double averageConstUnc;
  
       if (bothFitsBad) {
         if (histbin >= cellIDLo && histbin <= cellIDHi) {B2INFO("eclCosmicEAlgorithm: no constant found for cellID = " << histbin << " status = " << StatusperCrys[0]->GetBinContent(histbin) << " and " << StatusperCrys[1]->GetBinContent(histbin));}
         averageConst = -1.*abs(AverageInitialCalib[0]->GetBinContent(histbin));
         averageConstUnc = 0.;
       } else {
         averageConst = (calibConst[0] * weight[0] + calibConst[1] * weight[1]) / (weight[0] + weight[1]);
         averageConstUnc = 1. / sqrt(weight[0] + weight[1]);
       }
       CalibvsCrys->SetBinContent(histbin, averageConst);
       CalibvsCrys->SetBinError(histbin, averageConstUnc);
     }
   }
  
   bool DBsuccess = false;
   if (storeConst == 0 || (storeConst == 1 && allFitsOK)) {
     DBsuccess = true;
  
     if (findExpValues) {
       std::vector<std::string> DBname = {"ECLExpCosmicESame", "ECLExpCosmicEDifferent"};
       for (int idir = 0; idir < 2; idir++) {
         std::vector<float> tempE;
         std::vector<float> tempUnc;
         for (int crysID = 0; crysID < ECLElementNumbers::c_NCrystals; crysID++) {
           int histbin = crysID + 1;
           tempE.push_back(ExpEnergyperCrys[idir]->GetBinContent(histbin));
           tempUnc.push_back(ExpEnergyperCrys[idir]->GetBinError(histbin));
         }
         ECLCrystalCalib* ExpectedE = new ECLCrystalCalib();
         ExpectedE->setCalibVector(tempE, tempUnc);
         saveCalibration(ExpectedE, DBname[idir]);
         B2INFO("eclCosmicEAlgorithm: successfully stored expected values for " << DBname[idir]);
       }
  
     } else {
       std::vector<float> tempCalib;
       std::vector<float> tempCalibUnc;
       for (int crysID = 0; crysID < ECLElementNumbers::c_NCrystals; crysID++) {
         int histbin = crysID + 1;
         tempCalib.push_back(CalibvsCrys->GetBinContent(histbin));
         tempCalibUnc.push_back(CalibvsCrys->GetBinError(histbin));
       }
       ECLCrystalCalib* CosmicECalib = new ECLCrystalCalib();
       CosmicECalib->setCalibVector(tempCalib, tempCalibUnc);
       saveCalibration(CosmicECalib, "ECLCrystalEnergyCosmic");
       B2INFO("eclCosmicEAlgorithm: successfully stored calibration constants");
     }
   }
  
   for (int idir = 0; idir < 2; idir++) {
     PeakperCrys[idir]->Write();
     SigmaperCrys[idir]->Write();
     EtaperCrys[idir]->Write();
     ConstperCrys[idir]->Write();
     StatusperCrys[idir]->Write();
     hStatus[idir]->Write();
     fracPeakUnc[idir]->Write();
     hfitProb[idir]->Write();
   }
  
   if (findExpValues) {
     ExpEnergyperCrys[0]->Write();
     ExpEnergyperCrys[1]->Write();
   } else {
     CalibvsCrys->Write();
   }
   histfile->Close();
  
   dummy = (TH1F*)gROOT->FindObject("PeakperCrysSame"); delete dummy;
   dummy = (TH1F*)gROOT->FindObject("SigmaperCrysSame"); delete dummy;
   dummy = (TH1F*)gROOT->FindObject("EtaperCrysSame"); delete dummy;
   dummy = (TH1F*)gROOT->FindObject("ConstperCrysSame"); delete dummy;
   dummy = (TH1F*)gROOT->FindObject("StatusperCrysSame"); delete dummy;
   dummy = (TH1F*)gROOT->FindObject("StatusSame"); delete dummy;
   dummy = (TH1F*)gROOT->FindObject("fracPeakUncSame"); delete dummy;
   dummy = (TH1F*)gROOT->FindObject("fitProbSame"); delete dummy;
   dummy = (TH1F*)gROOT->FindObject("ExpEnergyperCrysSame"); delete dummy;
   dummy = (TH1F*)gROOT->FindObject("PeakperCrysDifferent"); delete dummy;
   dummy = (TH1F*)gROOT->FindObject("SigmaperCrysDifferent"); delete dummy;
   dummy = (TH1F*)gROOT->FindObject("EtaperCrysDifferent"); delete dummy;
   dummy = (TH1F*)gROOT->FindObject("ConstperCrysDifferent"); delete dummy;
   dummy = (TH1F*)gROOT->FindObject("StatusperCrysDifferent"); delete dummy;
   dummy = (TH1F*)gROOT->FindObject("StatusDifferent"); delete dummy;
   dummy = (TH1F*)gROOT->FindObject("fracPeakUncDifferent"); delete dummy;
   dummy = (TH1F*)gROOT->FindObject("fitProbDifferent"); delete dummy;
   dummy = (TH1F*)gROOT->FindObject("ExpEnergyperCrysDifferent"); delete dummy;
   dummy = (TH1F*)gROOT->FindObject("CalibvsCrys"); delete dummy;
  
   if (storeConst == -1) {
     B2INFO("eclCosmicEAlgorithm performed fits but was not asked to store contants");
     return c_Failure;
   } else if (!DBsuccess) {
     if (findExpValues) { B2INFO("eclCosmicEAlgorithm: failed to store expected values"); }
     else { B2INFO("eclCosmicEAlgorithm: failed to store calibration constants"); }
     return c_Failure;
   }
   return c_OK;
 }

◆ checkPyExpRun()

bool checkPyExpRun ( PyObject * pyObj )

inherited

Checks that a PyObject can be successfully converted to an ExpRun type.

Checks if the PyObject can be converted to ExpRun.

Definition at line 28 of file CalibrationAlgorithm.cc.

◆ 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

◆ cellIDLo

int cellIDLo

Parameters to control Novosibirsk fit to signal measured in each crystal.

First cellID to be fit

Definition at line 34 of file eclCosmicEAlgorithm.h.

◆ storeConst

int storeConst

controls which values are written to the database.

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

Definition at line 42 of file eclCosmicEAlgorithm.h.

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

ecl/calibration/include/eclCosmicEAlgorithm.h
ecl/calibration/src/eclCosmicEAlgorithm.cc

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ EResult

Member Function Documentation

◆ calibrate()

◆ checkPyExpRun()

◆ convertPyExpRun()

◆ execute()

◆ getCollectorName()

◆ setInputFileNames() [1/2]

◆ setInputFileNames() [2/2]

Member Data Documentation

◆ cellIDLo

◆ storeConst