Merge branch 'feature/10955-fix-typos-in-the-background-package' into 'main'

Resolve "Fix typos in the background package"

Closes #10955

See merge request belle2/software/basf2!4171

Author: Belle II Software

background/doc/index.rst

@@ -5,9 +5,9 @@ In the following we describe the ``background`` package (documentation still und
 The background package is how we introduce beam background hit rates in MC samples. 
 Things users should consider when using this package are the following: 
 
-* Run conditions (i.e. indepedent vs dependent MC samples): 
+* Run conditions (i.e. independent vs dependent MC samples): 
 
-  * Run Indepedent or Simulated Beam Backgrounds: The experiment number used for "Exp: 100X" (ex. 1002 for phase 2, 1003 for phase 3 Run 1, and 1004 for Run 2). 
+  * Run Independent or Simulated Beam Backgrounds: The experiment number used for "Exp: 100X" (ex. 1002 for phase 2, 1003 for phase 3 Run 1, and 1004 for Run 2). 
     The files produced from these 'experiments' are in coordination with the background group and are used in run-independent MC proudction.
   * Run Dependent or Random Trigger Events: These files are used to produce BG overlay files for use in run-dependent MC production. 
     Essentially, a random trigger is used to collect events that don't contain physic signals and therefore represent the effect of beam backgrounds and detector noise.

background/examples/beamBkgMixer.py

@@ -31,15 +31,15 @@
     sys.exit()
 
 # define background (collision) files
-#    glob.glob is the prefered way to get the list of files:
+#    glob.glob is the preferred way to get the list of files:
 #    (the directory must include only BG files!)
 
 bg = glob.glob(os.environ['BELLE2_BACKGROUND_MIXING_DIR'] + '/*.root')
 if len(bg) == 0:
     b2.B2ERROR('No files found in ', os.environ['BELLE2_BACKGROUND_MIXING_DIR'])
     sys.exit()
 
-# alternative: you can specify files explicitely
+# alternative: you can specify files explicitly
 #
 # dir = '/sw/belle2/bkg/'  # change the directory name if you don't run on KEKCC
 # bg = [

background/examples/genericBBbarWithBGMixing.py

@@ -20,7 +20,7 @@
 # Example of simulation/reconstruction of generic BBbar events with beam background.
 #
 # This example generates BBbar events using EvtGenInput module, runs full simulation
-# with BG mixing using BeamBkgMixer module, then runs full reconstruction and finaly
+# with BG mixing using BeamBkgMixer module, then runs full reconstruction and finally
 # writes the results to mdst file.
 # ----------------------------------------------------------------------------------
 

background/examples/genericBBbarWithBGOverlay.py

@@ -22,7 +22,7 @@
 # This example generates BBbar events using EvtGenInput module,
 # runs full simulation and digitization,
 # then adds measured BG to simulated data using BGOverlayExecutor module,
-# runs full reconstruction and finaly writes the results to mdst file.
+# runs full reconstruction and finally writes the results to mdst file.
 # ----------------------------------------------------------------------------------
 
 b2.set_log_level(b2.LogLevel.ERROR)

background/examples/onlyBGMixing.py

@@ -20,7 +20,7 @@
 # Example of simulation/reconstruction of events with beam background only.
 #
 # This example runs full simulation of beam BG only events using BeamBkgMixer module,
-# then runs full reconstruction and finaly writes the results to mdst file.
+# then runs full reconstruction and finally writes the results to mdst file.
 # ----------------------------------------------------------------------------------
 
 b2.set_log_level(b2.LogLevel.ERROR)

background/examples/onlyBGOverlay.py

@@ -20,7 +20,7 @@
 # Example of simulation/reconstruction of events with beam background only.
 #
 # This example runs full simulation of beam BG only events using BGOverlayExecutor,
-# then runs full reconstruction and finaly writes the results to mdst file.
+# then runs full reconstruction and finally writes the results to mdst file.
 # ---------------------------------------------------------------------------------
 
 b2.set_log_level(b2.LogLevel.ERROR)

background/modules/BGOverlayExecutor/src/BGOverlayExecutorModule.cc

@@ -118,6 +118,6 @@ void BGOverlayExecutorModule::event()
   if (m_addCDC) addBGDigits<CDCHit>(m_CDCHitsName);
   if (m_addTOP) addBGDigits<TOPDigit>(m_TOPDigitsName);
   if (m_addARICH) addBGDigits<ARICHDigit>(m_ARICHDigitsName);
-  //Compressed waveforms are loaded to the datastore by BGOverlayInputModule and unpacked and overlayed in ECLDigitizerModule
+  //Compressed waveforms are loaded to the datastore by BGOverlayInputModule and unpacked and overlaid in ECLDigitizerModule
   if (m_addKLM) addBGDigits<KLMDigit>(m_KLMDigitsName);
 }

background/modules/BGOverlayInput/include/BGOverlayInputModule.h

@@ -95,7 +95,7 @@ namespace Belle2 {
     TChain* m_tree = 0;            /**< tree pointer */
     unsigned m_numEvents = 0;      /**< number of events (tree entries) in the sample */
     unsigned m_eventCount = 0;     /**< current event (tree entry) */
-    unsigned m_firstEvent = 0;     /**< randomly choosen first event (tree entry) */
+    unsigned m_firstEvent = 0;     /**< randomly chosen first event (tree entry) */
     bool m_start = true;           /**< flag denoting first call of event function (of each run if overlay is run-dependent) */
     std::vector<DataStore::StoreEntry*> m_storeEntries;  /**< store entries of registered branches */
     std::vector<std::string> m_branchNames; /**< names of registered branches */

background/modules/BGOverlayInput/src/BGOverlayInputModule.cc

@@ -71,7 +71,7 @@ void BGOverlayInputModule::initialize()
   if (m_skipExperimentCheck) {
     B2WARNING(R"RAW(The BGOverlayInput module will skip the check on the experiment number
     consistency between the basf2 process and the beam background files.
-    It will also ingnore run numbers in case of run-dependent MC.
+    It will also ignore run numbers in case of run-dependent MC.
 
     This should be done only if you are extremely sure about what you are doing.
 
@@ -208,7 +208,7 @@ void BGOverlayInputModule::event()
   }
 
   if (m_eventCount == m_firstEvent and !m_start) {
-    B2INFO("BGOverlayInput: events for BG overlay will be re-used");
+    B2INFO("BGOverlayInput: events for BG overlay will be reused");
     bkgInfo->incrementReusedCounter(m_index);
   }
   m_start = false;

background/modules/BeamBkgHitRateMonitor/include/CDCHitRateCounter.h

@@ -118,7 +118,7 @@ namespace Belle2 {
       {
         if (m_timeWindowUpperEdge_smallCell  - m_timeWindowLowerEdge_smallCell  <= 0 ||
             m_timeWindowUpperEdge_normalCell - m_timeWindowLowerEdge_normalCell <= 0) {
-          B2FATAL("invalid seting of CDC time window");
+          B2FATAL("invalid setting of CDC time window");
         }
       }
       /**

background/modules/BeamBkgHitRateMonitor/include/ECLHitRateCounter.h

@@ -93,7 +93,7 @@ namespace Belle2 {
        * Segment 1 contains crystals with 135deg < phi < 225deg,
        * Segment 2 contains crystals with 225deg < phi < 315deg,
        * Segment 3 contains crystals with phi < 45deg or phi > 315deg,
-       * With the same angular patter continuing for barrel and BWD encap segments
+       * With the same angular pattern continuing for barrel and BWD encap segments
        */
       void segmentECL();
 
@@ -128,7 +128,7 @@ namespace Belle2 {
       // other
       Belle2::ECL::ECLGeometryPar* m_geometry{nullptr}; /**< pointer to ECLGeometryPar */
       std::map<int, int> m_segmentMap; /**< map with keys containing ECL CellID and values containing segment number */
-      int m_crystalsInSegment[16] = {0}; /**< array cotaining the number of crystals in given segment */
+      int m_crystalsInSegment[16] = {0}; /**< array containing the number of crystals in given segment */
     };
   }
 }

background/modules/BeamBkgHitRateMonitor/include/PXDHitRateCounter.h

@@ -110,7 +110,7 @@ namespace Belle2 {
       // other
       double m_activePixels[40] = {0}; /**< number  of active pixels in sensor */
       double m_activeAreas[40] = {0}; /**< area of active pixels in sensor */
-      double m_segmentActivePixels[240] = {0}; /**< number of active pixels in v segements */
+      double m_segmentActivePixels[240] = {0}; /**< number of active pixels in v segments */
       double m_segmentActiveAreas[240] = {0}; /**< area of active pixels in v segments */
     };
 

background/modules/BeamBkgHitRateMonitor/include/SVDHitRateCounter.h

@@ -143,14 +143,14 @@ namespace Belle2 {
 
       /**
        * Returns the (active) mass of the given sensor in Kg.
-       * @param layer tha layer number (starting from 0, not 3)
+       * @param layer the layer number (starting from 0, not 3)
        * @param ladder the ladder number (starting from 0, not 1)
        * @param sensor the sensor number (starting from 0, not 1)
        */
       double massOfSensor(int layer, int ladder, int sensor);
 
       /**
-       * Returns wether a strips is active (neither hot nor masked),
+       * Returns whether a strips is active (neither hot nor masked),
        * taking into account the ignoreHotStrips and ignoreMaskedStrips
        * settings.
        * @param sensorID The VxdID of the sensor

background/modules/BeamBkgHitRateMonitor/src/ARICHHitRateCounter.cc

@@ -57,7 +57,7 @@ namespace Belle2 {
       // increment event counter
       rates.numEvents++;
 
-      // count and weight hits accoring to channel efficiecny
+      // count and weight hits according to channel efficiecny
       for (const auto& hit : m_hits) {
         if (hit.getModule() < 1 || hit.getModule() > 420) continue;
         auto effi = m_modulesInfo->getChannelQE(hit.getModule(), hit.getChannel());

background/modules/BeamBkgHitRateMonitor/src/PXDHitRateCounter.cc

@@ -156,7 +156,7 @@ namespace Belle2 {
           m_rates.hardPhotonFluxes[index] *= (1.0 / currentSensorArea) * (1.0 / (currentComponentTime / Unit::s));
           m_rates.chargedFluxes[index] *= (1.0 / currentSensorArea) * (1.0 / (currentComponentTime / Unit::s));
 
-          // Loop over v segements
+          // Loop over v segments
           for (int vBin = 0; vBin < 6; ++vBin)  {
             double currentSegmentMass = m_segmentActiveAreas[vBin + index * 6] * info.getThickness() * c_densitySi;
             double currentSegmentArea = m_segmentActiveAreas[vBin + index * 6];
@@ -187,7 +187,7 @@ namespace Belle2 {
         // Compute nominal area of sensor
         m_activeAreas[index] = info.getWidth() * info.getLength();
 
-        // Loop over v segements
+        // Loop over v segments
         for (int vBin = 0; vBin < 6; ++vBin)  {
           // Compute nominal number of pixel per segment
           // Sgements have same number of rows, but due to pitch change a different length

background/modules/BeamBkgHitRateMonitor/src/SVDHitRateCounter.cc

@@ -162,7 +162,7 @@ namespace Belle2 {
 
         // accumulate hits
         for (const auto& digit : m_digits) {
-          // select digits to count (usualy only good ones)
+          // select digits to count (usually only good ones)
           VxdID sensorID = digit.getSensorID();
           int layer = sensorID.getLayerNumber() - 3;
           int ladder = sensorID.getLadderNumber() - 1;

background/modules/BeamBkgMixer/include/BeamBkgMixerModule.h

@@ -116,7 +116,7 @@ namespace Belle2 {
         tree(nullptr), numFiles(0), numEvents(0), eventCount(0), rate(0.0), index(0)
       {}
       /**
-       * usefull constructor
+       * useful constructor
        * @param bkgTag background tag
        * @param bkgType background type
        * @param fileName file name
@@ -279,7 +279,7 @@ namespace Belle2 {
 
     std::map<std::string, int> m_rejected; /**< messages: rejected events */
     std::map<std::string, int> m_reused;  /**< messages: rejused events */
-    int m_rejectedCount = 0;  /**< counter for suppresing "rejected event" messages */
+    int m_rejectedCount = 0;  /**< counter for suppressing "rejected event" messages */
 
   };
 

background/modules/BeamBkgMixer/src/BeamBkgMixerModule.cc

@@ -148,7 +148,7 @@ void BeamBkgMixerModule::initialize()
       continue;
     }
 
-    // check the file existance
+    // check the file existence
     TFile* f = TFile::Open(file.c_str(), "READ");
     if (!f) {
       B2ERROR(file << ": file not found");
@@ -388,7 +388,7 @@ void BeamBkgMixerModule::event()
       bkg.eventCount++;
       if (bkg.eventCount >= bkg.numEvents) {
         bkg.eventCount = 0;
-        std::string message = "BeamBkgMixer: events of " + bkg.type + " will be re-used";
+        std::string message = "BeamBkgMixer: events of " + bkg.type + " will be reused";
         m_reused[message] += 1;
         if (m_reused[message] == 1) B2INFO(message);
         bkgInfo->incrementReusedCounter(bkg.index);
@@ -435,7 +435,7 @@ void BeamBkgMixerModule::event()
       bkg.eventCount++;
       if (bkg.eventCount >= bkg.numEvents) {
         bkg.eventCount = 0;
-        std::string message = "BeamBkgMixer: events of " + bkg.type + " will be re-used";
+        std::string message = "BeamBkgMixer: events of " + bkg.type + " will be reused";
         m_reused[message] += 1;
         if (m_reused[message] == 1) B2INFO(message);
         bkgInfo->incrementReusedCounter(bkg.index);
@@ -469,7 +469,7 @@ void BeamBkgMixerModule::event()
       bkg.eventCount++;
       if (bkg.eventCount >= bkg.numEvents) {
         bkg.eventCount = 0;
-        std::string message = "BeamBkgMixer: events of " + bkg.type + " will be re-used";
+        std::string message = "BeamBkgMixer: events of " + bkg.type + " will be reused";
         m_reused[message] += 1;
         if (m_reused[message] == 1) B2INFO(message);
         bkgInfo->incrementReusedCounter(bkg.index);
@@ -490,11 +490,11 @@ void BeamBkgMixerModule::terminate()
 
   B2INFO("BeamBkgMixer - reused samples:");
   for (const auto& message : m_reused) {
-    B2INFO(message.first << "(occured " << message.second << " times)");
+    B2INFO(message.first << "(occurred " << message.second << " times)");
   }
   B2INFO("BeamBkgMixer - rejected events:");
   for (const auto& message : m_rejected) {
-    B2INFO(message.first << "(occured " << message.second << " times)");
+    B2INFO(message.first << "(occurred " << message.second << " times)");
   }
 
   for (auto& bkg : m_backgrounds) {

background/scripts/background.py

@@ -37,7 +37,7 @@ def get_background_files(folder=None, output_file_info=True):
 
     if folder is None:
         if env_name not in os.environ:
-            raise RuntimeError("Environment variable {} for backgound files not set. Terminanting this script.".format(env_name))
+            raise RuntimeError("Environment variable {} for background files not set. Terminanting this script.".format(env_name))
         folder = os.environ[env_name]
 
     bg = glob.glob(folder + '/*.root')

background/steering_tools/backgroundInfo.py

@@ -36,7 +36,7 @@ def event(self):
             i = 0
             for bgInfo in bgInfos:
                 print("===========================")
-                print("* Backgroud info: entry", str(i))
+                print("* Background info: entry", str(i))
                 print("===========================")
                 bgInfo.print()
                 i += 1

background/validation/validateOverlay.py

@@ -62,7 +62,7 @@ def initialize(self):
         self.hist2.append(TH1F('CDCOuterHitRate', 'CDC Hit Rate per wire for the Outer layers', 100, 0, 1000))
         self.hist2.append(TH1F('CDCHitRate', 'CDC Hit Rate per wire', 100, 0, 1000))
         self.hist2.append(TH1F("TOPHitTime", "TOP Hit Time Distribution; time [ns]", 300, -150, 150))
-        #: numnber of events
+        #: number of events
         self.nTOPev = 0
         #: min TOP hit time
         self.minTOPTime = None

dqm/analysis/modules/include/DQMHistAnalysisSVDOnMiraBelle.h

@@ -64,7 +64,6 @@ namespace Belle2 {
 
     /**
      * Calculate avg offline occupancy for one specific sensor, especially
-     * @param iLayer index of layer
      * @param hU, hV pointers to histograms
      * @param layer layer index
      * @param ladder ladder index