Merge pull request #24 from klendathu2k/STAR-REPO-AI

More minor cleanups...

Author: klendathu2k

.github/copilot-instructions.md

@@ -1,6 +1,36 @@
-# STAR Coding Standards
+# ROLE
 
-Supported: c++11, FORTRAN 77, python 2.7, perl 5, XML.
+Act as an expert code reviewer.  You will analyze the files which have been added and/or changed in this
+pull requst.  You will review the complete files, not just the changes committed in the pull request.
+You will consider correctness, best practice, and the Coding Standards provided below.  Where there are
+conflicts between best practice and the Coding Standards, you will use the Coding Standards.
+
+YOU WILL NOT NITPICK REASONABLE CHOICES MADE BY THE DEVELOPERS.
+
+The objective of the review is to identify changes that will make the code more readable, easier to understand,
+and easier to maintain for future maintainers of the code.  Some deviations with the Coding Standards are permissible,
+so long as that objective is maintained.
+
+# Completeness
+
+You will dilligently analyze each of the files which are touched by the pull request.  You will review each
+file in its entirety, not just the changes submitted since the last commit.
+
+You will consider every bullet point in the Coding Standards.  You will note all discrepancies in your review.
+You will provide the minimal set of changes which will bring the code into compliance with best practice and
+the Coding Standards.  Your proposed changes should conform to best practice and the Coding Standards.
+
+For each change you propose, you should explain why you are proposing that change.  Be concise in your reponse.
+
+You will create a table summarizing the code review.  For each file touched in the pull request, explicitly state the nature
+of the changes which were made, whether they conform to best practice, and whether they conform to the Coding
+Standards enumerated below.  Where they fail the coding standards, indicate each of the standards which were violated.
+
+# Coding Standards
+
+Applicable languages: c++11, C99, FORTRAN 77, python 2.7, perl 5, XML.
+
+Where guidance applies to a specific language, it will be noted in square brackets.  e.g. [c++].
 
 Follow best practices unless overridden below. Formatting style not mandated except for fixed-format (FORTRAN77, python). Unit tests may deviate.
 

AI/CONVENTIONS.md

@@ -2,10 +2,12 @@
 // 
 // $Id: StEEmcFastMaker.cxx,v 1.23 2010/08/05 21:23:45 stevens4 Exp $
 
+#include "StEEmcFastMaker.h"
+
 #include "St_DataSetIter.h"
 #include "StEventTypes.h"
 
-#include "StEEmcFastMaker.h"
+
 
 
 #include "StEEmcUtil/EEevent/EEeventDst.h"

StRoot/StBFChain/README.md

@@ -61,6 +61,8 @@ usage in bfc.C
 Example how to read back E-EMC data from StEvent:
 www.star.bnl.gov/STAR/eemc -->How To
 
+Minor code cleanups ...
+
 */
 
 #ifndef STAR_StEEmcFastMaker

StRoot/StChain/README.md

@@ -1,3 +1,8 @@
+
+#include "StEEmcSimulatorMaker/StEEmcFastMaker.h"
+#include "StEEmcSimulatorMaker/StEEmcSlowMaker.h"
+#include "StEEmcMixerMaker.h"
+
 #include <stdlib.h>
 #include <string.h>
 #include <TFile.h>
@@ -7,9 +12,7 @@
 #include <StEventTypes.h>
 #include <StEvent.h>
 
-#include "StEEmcSimulatorMaker/StEEmcFastMaker.h"
-#include "StEEmcSimulatorMaker/StEEmcSlowMaker.h"
-#include "StEEmcMixerMaker.h"
+
 #include "StEEmcUtil/database/EEmcDbItem.h"
 #include "StEEmcUtil/database/StEEmcDb.h"
 #include "StEEmcUtil/database/cstructs/eemcConstDB.hh" // def of status bits 

StRoot/StEEmcSimulatorMaker/StEEmcFastMaker.cxx

@@ -2,6 +2,9 @@
 // 
 // $Id: StEEmcSlowMaker.cxx,v 2.11 2010/09/07 22:24:52 stevens4 Exp $
 
+#include "StEEmcSlowMaker.h"
+#include "StEEmcFastMaker.h"
+
 #include <TFile.h>
 #include <TH2.h>
 #include <TRandom.h>
@@ -13,20 +16,20 @@
 #include "StEEmcUtil/database/EEmcDbItem.h"
 #include "StEEmcUtil/database/StEEmcDb.h"
 
-#include "StEEmcFastMaker.h"
-#include "StEEmcSlowMaker.h"
+
+
 
 //________________________________________________
 StEEmcSlowMaker::StEEmcSlowMaker(const Char_t *name, const Char_t*)
 : StMaker(name) {
-   mMip2ene = getMipdEdx()*0.7; // This is the SMD thickness of 7 mm
+   mMip2ene = mipdEdx()*0.7; // This is the SMD thickness of 7 mm
                             // times the minimum ionizing energy loss of
                             // 1.998 MeV/cm from the PDG book
    mSig1pe = 0.85;          // from info from S. Vigdor on MAPMT test results
    //set different thicknesses for pre and post layers (found in geometry debug by Jason et. al.)
-   mPmip2ene[0] = getMipdEdx()*0.475; // The pre-shower tiles are only 4.75 mm thick.
-   mPmip2ene[1] = getMipdEdx()*0.475; // The pre-shower tiles are only 4.75 mm thick.
-   mPmip2ene[2] = getMipdEdx()*0.5;   // The post-shower tiles are only 5 mm thick.
+   mPmip2ene[0] = mipdEdx()*0.475; // The pre-shower tiles are only 4.75 mm thick.
+   mPmip2ene[1] = mipdEdx()*0.475; // The pre-shower tiles are only 4.75 mm thick.
+   mPmip2ene[2] = mipdEdx()*0.5;   // The post-shower tiles are only 5 mm thick.
    mPmip2pe = 2.6*1.5;      // 2.6 mip/tower scint * 1.5 light yield
                             // in pre- and post-shower elements
    // loop to init  mMip2pe[] - this will eventually need to be
@@ -37,7 +40,7 @@ StEEmcSlowMaker::StEEmcSlowMaker(const Char_t *name, const Char_t*)
      mMip2pe[i] = avgNumPePerMip(i);
    }
 
-  mEeDb=0;
+  mEeDb=nullptr;
   mNInpEve=0; 
   memset(mHist,0,sizeof(mHist));
 
@@ -57,7 +60,7 @@ StEEmcSlowMaker::StEEmcSlowMaker(const Char_t *name, const Char_t*)
 
   mIsEmbeddingMode = false;
   /// By default, source is MuDst
-  mSource = kMuDst;
+  mSource = StSource::kMuDst;
 
   /// By default, truncate ped smearing at 3 sigma   
   mTruncatePedSmear = 3;
@@ -168,7 +171,9 @@ Int_t StEEmcSlowMaker::Init() {
     setOverwrite(1); // overwrite ADC values
     setSource("StEvent");             
   } else { //set defaults for running in analysis chain 
-    if (mSource == kMuDst) disableTower(); //don't change tower in analysis chain since only ADC is stored in MuDst  
+    if (mSource == StSource::kMuDst) {
+        disableTower(); //don't change tower in analysis chain since only ADC is stored in MuDst
+    }
   }                                   
 
   //print out full configuration in log file  
@@ -227,7 +232,7 @@ void StEEmcSlowMaker::InitHisto() {
   mHist[19]=new TH2F(tt1,tt2,60,0,300,100,0,200.);
 
   // add histos to the list (if provided)
-  for (Int_t i = 0; i < maxHist; ++i) {
+  for (Int_t i = 0; i < MAX_HIST; ++i) {
       if (mHist[i]) this->AddHist(mHist[i]);
   }
 }
@@ -239,7 +244,7 @@ Int_t StEEmcSlowMaker::Make() {
   LOG_DEBUG << "iEve " << mNInpEve << ", mSource = " << mSource << endm;
 
   switch (mSource) {
-  case kMuDst:
+  case StSource::kMuDst:
     /// Access to muDst .......................
     {
       if (!GetInputDS("MuDst")) {
@@ -264,14 +269,14 @@ Int_t StEEmcSlowMaker::Make() {
     }
     break;
 
-  case kStEvent:
+  case StSource::kStEvent:
     /// Acces to StEvent, automatic detection if in Embedding or BFC mode .....................
     {
 
-      StEmcCollection *emc =0; 
+      StEmcCollection *emc = nullptr; 
       if(mIsEmbeddingMode) {
 	StEEmcFastMaker *fast = (StEEmcFastMaker*)GetMakerInheritsFrom("StEEmcFastMaker");
-	if(fast==0) {
+	if(fast==nullptr) {
 	  LOG_WARN << GetName() << "::Make()  no EEmcFastSim in the chain, ignore Endcap"<< endm;
 	  return kStWarn;
 	}
@@ -348,7 +353,7 @@ Int_t StEEmcSlowMaker::MakeTower(StMuEmcCollection *emc) {
       Int_t sec,sub,eta,pre;
       StMuEmcHit *hit=emc->getEndcapPrsHit(i,sec,sub,eta,pre);
       // range check on returned values
-      if (!( sec >= 1 && sec <= 12) || !(sub >= 1 && sub <= 5) || !(eta >= 1 && eta <= 12) || !(pre >= 1 && pre <= 3)) {
+      if (!( sec >= 1 && sec <= 12) || !(sub >= 1 && sub <= 5) || !(eta >= 1 && eta <= 12) || !(pre >= 1 && pre <= kNumberOfPrepostLayers)) {
 	LOG_ERROR << "Indexing errors detected: EPRS hit " << i << ", sec = " << sec << ", sub = " << sub << ", eta = " << eta << ", pre = " << pre << endm;
 	setZeroAdc(emc);
 	return kStErr;
@@ -363,7 +368,7 @@ Int_t StEEmcSlowMaker::MakeTower(StMuEmcCollection *emc) {
       // difference in thickness between pre/post and normal
       // layers, the factor of 0.8 is introduced to prevent us
       // from double correcting.
-      const EEmcDbItem *tower = mEeDb ? mEeDb->getTile(sec,sub-1+'A', eta, 'T') : 0;
+      const EEmcDbItem *tower = mEeDb ? mEeDb->getTile(sec,sub-1+'A', eta, 'T') : nullptr;
       if (!tower) {
 	LOG_ERROR << "Cannot find DB entry for ETOW: sec = " << sec << ", sub = " << sub << ", eta = " << eta << endm;
 	continue;
@@ -449,20 +454,24 @@ Int_t StEEmcSlowMaker::MakePrePost(StMuEmcCollection *emc) {
     Int_t pre,sec,eta,sub;
     /// muDst ranges: sec:1-12, sub:1-5, eta:1-12 ,pre:1-3==>pre1/pre2/post
     StMuEmcHit *hit = emc->getEndcapPrsHit(i,sec,sub,eta,pre);
-    if (!hit) continue;
+    if (!hit) {
+        continue;
+    }
 
     // range check on returned values
-    if (!( sec >= 1 && sec <= 12) || !(sub >= 1 && sub <= 5) || !(eta >= 1 && eta <= 12) || !(pre >= 1 && pre <= 3)) {
+    if (!( sec >= 1 && sec <= 12) || !(sub >= 1 && sub <= 5) || !(eta >= 1 && eta <= 12) || !(pre >= 1 && pre <= kNumberOfPrepostLayers)) {
       LOG_ERROR << "Indexing errors detected: EPRS hit " << i << ", sec = " << sec << ", sub = " << sub << ", eta = " << eta << ", pre = " << pre << endm;
       setZeroAdc(emc);
       return kStErr;
     }
 
     /// tmp, for fasted analysis use only hits from sectors init in DB
-    if (mEeDb && (sec < mEeDb->getFirstSector() || sec > mEeDb->getLastSector())) continue;
+    if (mEeDb && (sec < mEeDb->getFirstSector() || sec > mEeDb->getLastSector())) {
+        continue;
+    }
 
     /// Db ranges: sec=1-12,sub=A-E,eta=1-12,type=T,P-R ; slow method
-    const EEmcDbItem *x = mEeDb ? mEeDb->getTile(sec,sub-1+'A', eta, pre-1+'P') : 0; 
+    const EEmcDbItem *x = mEeDb ? mEeDb->getTile(sec,sub-1+'A', eta, pre-1+'P') : nullptr; 
     if (!x) {
 	LOG_ERROR << "Cannot find DB entry for EPRS: sec = " << sec << ", sub = " << sub << ", eta = " << eta << ", pre = " << pre << endm;
 	continue;
@@ -513,7 +522,9 @@ Int_t StEEmcSlowMaker::MakePrePost(StMuEmcCollection *emc) {
     ///
     /// If we've made it here, overwrite the muDst
     ///
-    if (mOverwrite) hit->setAdc(NUadc);
+    if (mOverwrite) {
+        hit->setAdc(NUadc);
+    }
   }
   return kStOk;
 }
@@ -534,8 +545,10 @@ Int_t StEEmcSlowMaker::MakeSMD(StMuEmcCollection *emc) {
       }
 
       // tmp, for fasted analysis use only hits from sectors init in DB
-      if (mEeDb && (sec < mEeDb->getFirstSector() || sec > mEeDb->getLastSector())) continue;
-      const EEmcDbItem *x = mEeDb ? mEeDb->getByStrip(sec,uv,strip) : 0;
+      if (mEeDb && (sec < mEeDb->getFirstSector() || sec > mEeDb->getLastSector())) {
+          continue;
+      }
+      const EEmcDbItem *x = mEeDb ? mEeDb->getByStrip(sec,uv,strip) : nullptr;
       if (!x) {
 	LOG_ERROR << "Cannot find DB entry for ESMD: sec = " << sec << ", uv = " << uv << ", strip = " << strip << endm;
 	continue;
@@ -591,7 +604,9 @@ Int_t StEEmcSlowMaker::MakeSMD(StMuEmcCollection *emc) {
       ///
       /// If we've made it here, overwrite the muDst
       ///
-      if (mOverwrite) hit->setAdc(NUadc);
+      if (mOverwrite) {
+          hit->setAdc(NUadc);
+      }
     }// loop over 1 plane
   } // loop over U,V
   return kStOk;
@@ -600,9 +615,9 @@ Int_t StEEmcSlowMaker::MakeSMD(StMuEmcCollection *emc) {
 //________________________________________________
 void StEEmcSlowMaker::setSource(const Char_t* name) {
   if (strcmp(name, "MuDst") == 0) {
-    mSource = kMuDst;
+    mSource = StSource::kMuDst;
   } else if (strcmp(name, "StEvent") == 0) {
-    mSource = kStEvent;
+    mSource = StSource::kStEvent;
   } else {
     LOG_WARN<<"::setSource()"<<"Source must be \"MuDst\" or \"StEvent\""<<endm;
   }
@@ -633,7 +648,7 @@ Int_t StEEmcSlowMaker::MakeTower(StEmcCollection* emc) {
           const UInt_t eta = hit->eta();
           const UInt_t pre = (hit->sub()-1)/5+1;
           // range check on returned values
-	  if (!(sec >= 1 && sec <= 12) || !(sub >= 1 && sub <= 5) || !(eta >= 1 && eta <= 12) || !(pre >= 1 && pre <= 3)) {
+	  if (!(sec >= 1 && sec <= 12) || !(sub >= 1 && sub <= 5) || !(eta >= 1 && eta <= 12) || !(pre >= 1 && pre <= kNumberOfPrepostLayers)) {
 	    LOG_ERROR << "Indexing errors detected for EPRS: sec = " << sec << ", sub = " << sub << ", eta = " << eta << ", pre = " << pre << endm;
     	    setZeroAdc(emc); 
 	    return kStErr;
@@ -647,7 +662,7 @@ Int_t StEEmcSlowMaker::MakeTower(StEmcCollection* emc) {
 	  // difference in thickness between pre/post and normal
 	  // layers, the factor of 0.8 is introduced to prevent us
 	  // from double correcting.
-          const EEmcDbItem *tower = mEeDb ? mEeDb->getTile(sec,sub-1+'A', eta, 'T') : 0;
+          const EEmcDbItem *tower = mEeDb ? mEeDb->getTile(sec,sub-1+'A', eta, 'T') : nullptr;
           if (!tower) {
 	    LOG_ERROR << "Cannot find DB entry for ETOW: sec = " << sec << ", sub = " << sub << ", eta = " << eta << endm;
 	    continue;
@@ -670,7 +685,7 @@ Int_t StEEmcSlowMaker::MakeTower(StEmcCollection* emc) {
 	  }
 
           // get DB entry for this tower
-          const EEmcDbItem *tower = mEeDb ? mEeDb->getTile(sec,sub-1+'A', eta, 'T') : 0;
+          const EEmcDbItem *tower = mEeDb ? mEeDb->getTile(sec,sub-1+'A', eta, 'T') : nullptr;
           if (!tower) {
 	    LOG_ERROR << "Cannot find DB entry for ETOW: sec = " << sec << ", sub = " << sub << ", eta = " << eta << endm;
 	    continue;
@@ -739,14 +754,14 @@ Int_t StEEmcSlowMaker::MakePrePost(StEmcCollection* emc) {
       const UInt_t ieta = hit->eta();
       const UInt_t ipre = (hit->sub()-1)/5+1;
       // range check on returned values
-      if (!(sector >= 1 && sector <= 12) || !(isub >= 1 && isub <= 5) || !(ieta >= 1 && ieta <= 12) || !(ipre >= 1 && ipre <= 3)) {
+      if (!(sector >= 1 && sector <= 12) || !(isub >= 1 && isub <= 5) || !(ieta >= 1 && ieta <= 12) || !(ipre >= 1 && ipre <= kNumberOfPrepostLayers)) {
 	LOG_ERROR << "Indexing errors detected for EPRS: sec = " << sector << ", sub = " << isub << ", eta = " << ieta << ", pre = " << ipre << endm;
 	setZeroAdc(emc); 
 	return kStErr;
       }
 
       // Database ranges: sector=1-12, sub=A-E, eta=1-12, type=T,P-R; Slow method
-      const EEmcDbItem* x = mEeDb ? mEeDb->getTile(sector, sub, hit->eta(), layer) : 0;
+      const EEmcDbItem* x = mEeDb ? mEeDb->getTile(sector, sub, hit->eta(), layer) : nullptr;
       if (!x) {
         LOG_ERROR << "Cannot find DB entry for EPRS: sec = " << sector << ", sub = " << sub << ", eta = " << hit->eta() << ", pre = " << layer << endm;
 	continue;
@@ -797,7 +812,9 @@ Int_t StEEmcSlowMaker::MakePrePost(StEmcCollection* emc) {
       ///
       /// If we've made it here, overwrite the muDst
       ///
-      if (mOverwrite) hit->setAdc(NUadc);
+      if (mOverwrite) {
+          hit->setAdc(NUadc);
+      }
     }
   }
   return kStOk;
@@ -808,7 +825,7 @@ Int_t StEEmcSlowMaker::MakeSMD(StEmcCollection* emc) {
   Int_t iuv = 0;
   for (Char_t plane = 'U'; plane <= 'V'; ++plane) {
     iuv++;
-    StEmcDetector* det = 0;
+    StEmcDetector* det = nullptr;
     switch (plane) {
     case 'U':
       det = emc->detector(kEndcapSmdUStripId);
@@ -826,7 +843,9 @@ Int_t StEEmcSlowMaker::MakeSMD(StEmcCollection* emc) {
       break;
     }
 
-    if (!det) continue;
+    if (!det) {
+        continue;
+    }
 
     for (UInt_t sector = 1; sector <= det->numberOfModules();++sector) {
       StSPtrVecEmcRawHit& hits = det->module(sector)->hits();
@@ -842,7 +861,7 @@ Int_t StEEmcSlowMaker::MakeSMD(StEmcCollection* emc) {
 	}
 
 	// Database ranges: sector=1-12, plane=U-V, strip=1-288
-	const EEmcDbItem* x = mEeDb ? mEeDb->getByStrip(sector, plane, strip) : 0;
+	const EEmcDbItem* x = mEeDb ? mEeDb->getByStrip(sector, plane, strip) : nullptr;
 	if (!x) {
 	  LOG_ERROR << "Cannot find DB entry for ESMD: sec = " << sector << ", uv = " << iuv-1+'U' << ", strip = " << strip << endm;
 	  continue;
@@ -892,7 +911,9 @@ Int_t StEEmcSlowMaker::MakeSMD(StEmcCollection* emc) {
 	///
 	/// If we've made it here, overwrite the muDst
 	///
-	if (mOverwrite) hit->setAdc(NUadc);
+	if (mOverwrite) {
+	    hit->setAdc(NUadc);
+	}
       } // Loop over 1 plane
     }
   }
@@ -959,11 +980,13 @@ Float_t StEEmcSlowMaker::getPedSmear(Float_t sigPed) {
 //________________________________________________
 void StEEmcSlowMaker::setZeroAdc(StEmcCollection* emc) {
   StDetectorId detId[4]={kEndcapEmcTowerId,kEndcapEmcPreShowerId,kEndcapSmdUStripId,kEndcapSmdVStripId};
-  StEmcDetector *det=0;
+  StEmcDetector *det=nullptr;
 
   for(int i=0; i<4; i++) {
     det = emc->detector(detId[i]);
-    if (!det) continue;
+    if (!det) {
+        continue;
+    }
     for (UInt_t sec = 1;sec <= det->numberOfModules();sec++) {
       StSPtrVecEmcRawHit &det_hits = det->module(sec)->hits();
       for (UInt_t ihit = 0;ihit < det_hits.size();ihit++) {
@@ -996,7 +1019,7 @@ void StEEmcSlowMaker::setZeroAdc(StMuEmcCollection *emc) {
 }
 
 //________________________________________________
-Float_t StEEmcSlowMaker::getMipdEdx() {
+Float_t StEEmcSlowMaker::mipdEdx() {
   // Return MIP dE/dx = 1.998 MeV/cm from the PDG book
   // used to simulate SMD, Pre, Post ADC response
   return 0.001998;