Merge pull request #300 from VERITAS-Observatory/v492-bookkeeping

GernotMaier · web-flow · commit e45083badded · 2025-06-01T18:39:23.000+02:00
v492 bookkeeping / maintenance
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -0,0 +1,41 @@
+---
+name: CI
+
+on:
+  workflow_dispatch:
+  pull_request:
+    types: [opened, synchronize]
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+
+  linting:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash -leo pipefail {0}
+
+    permissions:
+      contents: read
+      packages: read
+      statuses: write
+
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Check whether the citation metadata from CITATION.cff is valid
+        uses: citation-file-format/cffconvert-github-action@2.0.0
+        with:
+          args: "--validate"
+
+      - name: Pre-commit
+        run: |
+          pip install pre-commit
+          pre-commit run --all-files
diff --git a/CHANGELOG b/CHANGELOG
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to the Eventdisplay_v4 project will be documented in this file.
+Changes for upcoming releases can be found in the [docs/changes](docs/changes) directory.
+Note that changes before release v492.0 are not documented here, but can be found in the
+[GitHub repository](https://github.com/VERITAS-Observatory/VTS-SimPipe/releases).
+
+This changelog is generated using [Towncrier](https://towncrier.readthedocs.io/).
+
+<!-- towncrier release notes start -->
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2022, Eventdisplay Developers
+Copyright (c) 2022, 2023, 2024, 2025 Eventdisplay Developers
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
diff --git a/README.md b/README.md
@@ -9,13 +9,14 @@
 
 Eventdisplay is a reconstruction and analysis pipeline for data of
 Imaging Atmospheric Cherenkov Telescopes.
-It has been primarily developed for VERITAS and CTA analysis and publications.
-This repository contains the Eventdisplay version used for VERITAS analysis (see [here](https://github.com/Eventdisplay/Eventdisplay) for the CTA version).
+It has been primarily developed for the analysis of VERITAS and CTAO data to generate results for scientific publications.
+This repository contains the Eventdisplay version used for VERITAS analysis ([CTAO version](https://github.com/Eventdisplay/Eventdisplay))
 
 * Original developers: Gernot Maier and Jamie Holder
 * Authors and contributors: [CITATION.cff](CITATION.cff)
 * License: [LICENSE](LICENSE)
 * Contributing: [CONTRIBUTING.md](CONTRIBUTING.md)
+* Changelog: [CHANGELOG.md](CHANGELOG.md)
 
 In case Eventdisplay is used in a research project, please cite this repository using the [Zenodo entry](https://zenodo.org/badge/latestdoi/221041866) and the following publication:
 
@@ -57,7 +58,7 @@ Eventdisplay consists of the following main components:
 
 Additional components:
 
-* release test macros and results (see internal GitHub repository [Eventdisplay_ReleaseTests](https://github.com/VERITAS-Observatory/EventDisplay_ReleaseTests_code).
+* release test macros and results (see internal GitHub repository [Eventdisplay_ReleaseTests](https://github.com/VERITAS-Observatory/EventDisplay_ReleaseTests_code)).
 
 ## Documentation
 
diff --git a/docs/ANASUM.md b/docs/ANASUM.md
@@ -38,7 +38,7 @@ Lists and parameter files:
         see example $VERITAS_EVNDISP_AUX_DIR/ParameterFiles/ANASUM.runlist
 
    definition of gamma/hadron cuts:
-	
+
 	see example $VERITAS_EVNDISP_AUX_DIR/ParameterFiles/ANASUM.GammaHadron.dat
 
 	Please check VERITAS analysis wiki for the standard cut files
@@ -56,7 +56,7 @@ Required instrument response function files:
    effective areas, see $VERITAS_EVNDISP_AUX_DIR/EffectiveAreas
 
    radial acceptances, see $VERITAS_EVNDISP_AUX_DIR/RadialAcceptances
-	
+
 --------------------------------------------------------
 
 use the plotting tools in the shared library to plot the results:
diff --git a/docs/EFFECTIVEAREA.md b/docs/EFFECTIVEAREA.md
@@ -24,4 +24,3 @@ Required auxiliary files:
 for efficient usage, see scripts for typical usage:
 
 [VTS] $EVNDISPSYS/scripts/VTS/VTS.EFFAREA.sub_analyse.sh and $EVNDISPSYS/scripts/VTS/VTS.EFFAREA.qsub_analyse.sh
-
diff --git a/docs/EVNDISP.commandline.md b/docs/EVNDISP.commandline.md
@@ -15,7 +15,7 @@ Plot VTS data:
 Quick plotting of VTS data, ignoring all calibration data:
 ./bin/evndisp -plotraw -nocalibnoproblem -display=1 -sourcefile <your vbf data file>
 
-For analysis, use the ANALYSIS.evndisp.sh script. 
+For analysis, use the ANALYSIS.evndisp.sh script.
 To run the calibration steps only, use the ANALYSIS.evndisp.sh with calibration option set to 5.
 
 General:
@@ -40,7 +40,7 @@ General:
                                  7=DST (MC) file
      -runnumber=INT              set runnumber (default: get run number from sourcefile name)
      -useDBinfo                  get run info (target, wobble offsets, etc.) from database
-                                 (attention, this might overwrite some of the given command line parameters, 
+                                 (attention, this might overwrite some of the given command line parameters,
                                  default: on, switch of with -donotusedbinfo )
      -nevents=NEVENTS            loop over NEVENTS events in display=0 mode (<0 = no limit) (default=-10000)
      -firstevent=EVENTNUMBER     start analysis at event EVENTNUMBER (default=-10000)
@@ -57,12 +57,12 @@ Output:
      -writeallMC                 write all events, even those without array trigger, to showerpars and
                                  tpars trees (MC only, default: off)
      -writenoMCTree              do not write MC event tree to output file (MC only, default: 1)
-     -printdeadpixelinfo         print list of the telescope, gain, and channel number of all disabled 
-                                 channels to <runnumber>.evndisp.log 
-                                 each line will contain the word DEADCHAN for easy grep-ability, 
+     -printdeadpixelinfo         print list of the telescope, gain, and channel number of all disabled
+                                 channels to <runnumber>.evndisp.log
+                                 each line will contain the word DEADCHAN for easy grep-ability,
                                  and the reason(s) the channel was disabled
-     -writeextracalibtree        In gain calculating mode: Write additional tree into gain.root file 
-                                 containing channel charge, tzero, and monitor charge for all flasher events. 
+     -writeextracalibtree        In gain calculating mode: Write additional tree into gain.root file
+                                 containing channel charge, tzero, and monitor charge for all flasher events.
 
 Detector definition:
 --------------------
@@ -77,7 +77,7 @@ Calibration:
 ------------
      -readcalibdb                read relative gains and time offsets from offline DB (switch off with -nocalibnoproblem)
      -calibrationfile FILENAME   file with names of pedestal/gain/toffset/pixel status files (assume path $EVNDATA/calibration/)
-     -lowgaincalibrationfile FILENAME    file with names for pedestals and high/low gain multiplier files 
+     -lowgaincalibrationfile FILENAME    file with names for pedestals and high/low gain multiplier files
                                              (assume path $EVNDATA/calibration/)
      -gaincorrection=FLOAT       apply correction to gains (default=1)
      -usepeds                    use only true pedestal events (event type=2; use -donotusepeds to switch it off)
@@ -92,10 +92,10 @@ Calibration:
      -PedestalsLengthOfTimeSlice=FLOAT   length of time slices for pedestal variations (default=180s)
      -deadchannelfile FILE       read this file with dead channel definitions (default=deadChannelDefinition.dat)
 
-Pointing: 
+Pointing:
 ---------
      -elevation                  telescope elevation
-     -azimuth                    telescope azimuth 
+     -azimuth                    telescope azimuth
      -target TARGET              telescope is pointed to this target (use -print targets to print available targets)
      -printtargets               print available targets
      -declination=DEC            target is at this declination (J2000)
@@ -106,20 +106,20 @@ Pointing:
      -wobbleeast=FLOAT           wobble offset EAST (degrees) (this does not overwrite the DB value)
      -overwriteDB_wobblenorth=FLOAT      wobble offset NORTH (degrees) (this does overwrite the DB value)
      -overwriteDB_wobbleeast=FLOAT       wobble offset EAST (degrees) (this does overwrite the DB value)
-     -checkpointing=FLOAT        abort of difference between calculated pointing direction and vbf pointing direction 
+     -checkpointing=FLOAT        abort of difference between calculated pointing direction and vbf pointing direction
                                  is larger than this value ([deg], default=999 deg)
      -pointingErrorX=INT:FLOAT   take pointing error in array reconstruction into account
-                                 (camera x-direction [deg], default 0, 
+                                 (camera x-direction [deg], default 0,
                                  usage: for telescope 1 do for example: -pointingErrorX=1:0.05)
                                  (NOTE: experts only; option disables reading of pointing values from the DB)
      -pointingErrorY=INT:FLOAT   take pointing error in array reconstruction into account
-                                 (camera y-direction [deg], default 0, 
+                                 (camera y-direction [deg], default 0,
                                  usage: for telescope 1 do for example: -pointingErrorY=1:0.05)
                                  (NOTE: experts only; option disables reading of pointing values from the DB)
      -useDBtracking              use database to calculate pointing errors (default: on, switch off with -usenodbtracking )
      -useTCorrectionfrom SQL-DATE        use pointing calculated with T-point correction valid for this data
                                          (default: not applied, example: -useTCorrectionfrom "2007-10-10"
-     -pointingmonitortxt DIRECTORY       find pointing monitor text files in this directory 
+     -pointingmonitortxt DIRECTORY       find pointing monitor text files in this directory
                                          (default: not applied, expect filename as pointing_VPM.37195.t1.dat)
      -usedbvpm                   use calibrated pointing monitor data from DB (usenodbvpm to switch it off)
      -dstfile FILENAME           name of dst output file (root file, default: dstfile.root)
@@ -144,7 +144,7 @@ Display options:
      -starcatalogue Hipparcos_MAG8_1997.dat  plot stars into the display
      -starbrightness=float       plot stars brighter than the given B magnitude
 
-Simulations: 
+Simulations:
 -------------
      -isMC=0/1/2                 source data is MC (not/write all MC events/only triggered MC events, default=0)
      -fillmchisto                fill MC histograms (default 1)
@@ -161,7 +161,7 @@ Simulations:
      -pedestalnoiselevel=int     noise level used for external pedestal file (default=250)
      -pedestalDefaultPedestal=float      default pedestals used in simulations (default=15.)
      -lowgainpedestallevel=float pedestal level to be used for low-gain channels in MC (default=off)
-     -printGrisuHeader=0/1/2     0 (default)=nothing,   
+     -printGrisuHeader=0/1/2     0 (default)=nothing,
                                  1=Reproduce full grisu simulation header including detector config file (from VBF header).
                                  2=Print config file name that was used for detector simulation, if available.
 
diff --git a/docs/GETRUNLIST.md b/docs/GETRUNLIST.md
@@ -1,8 +1,8 @@
 VTS.getRunListFromDB
 
-./VTS.getRunListFromDB 
+./VTS.getRunListFromDB
 
-Examples: 
+Examples:
 
 VTS.getRunListFromDB -b 2009-09-01 -e 2009-10-01  -s Crab -z 60. -d 1200. -g -x
 VTS.getRunListFromDB -l runlist.dat -t -x -v -g
diff --git a/docs/HILOANALYSIS.md b/docs/HILOANALYSIS.md
@@ -1,4 +1,4 @@
-hiloAnalysis 
+hiloAnalysis
 
 	-a	Inner HiLo Run Number
 	-b	Outer HiLo Run Number
@@ -35,8 +35,6 @@ VTS.EVNDISP.sub_make_DST.sh <runlist> [pedestal calculation (default=1=on)] [Sum
 
 5. Then put these files into: $VERITAS_EVNDISP_AUX_DIR/Calibration/Tel_X/
 
-For example: 
+For example:
 	if you are looking at runs 12345 and 12346 give them the filename 1234546.lmult.root
 	and add the file to $VERITAS_EVNDISP_AUX_DIR/Calibration/calibrationlist.LowGain.dat
-
-
diff --git a/docs/MSCW_ENERGY.md b/docs/MSCW_ENERGY.md
@@ -3,15 +3,15 @@ mscw_energy: calculation of mean scaled width and length, and energy with lookup
 ---------------------------------------------------------------------------------------
 
 Input data must be in form of evndisp result files (ROOT files produced by evndisp)
-Output is 
+Output is
    i)  for filling table mode: a lookup table
    ii) for analyzing mode:     a ROOT file with MSCW/MSCL/Energy, etc per event ( .mscw.root )
 
 --------------------------------------------
 
 command line parameters:
 
-general parameters: 
+general parameters:
 	 -arrayrecid=0/1/... 	 choose eventdisplay array reconstruction record (default 0)
 	 -inputfile FILE 	 evndisp root file as input (wildcards possible use, -inputfile "YOUR_DATA_DIRECTORY/*.root")
 	 -inputfilelist FILELIST list of evndisp root file as input (wildcards possible use, -inputfile "YOUR_DATA_DIRECTORY/*.root")
@@ -36,13 +36,13 @@ For additional optional options, see further below.
 --------------------------------------------
 
 Lookup table files:
-	
-	lookup table files are expected to be in 
+
+	lookup table files are expected to be in
 	$VERITAS_EVNDISP_AUX_DIR/Tables/
 
 --------------------------------------------
 
-EXAMPLES: 
+EXAMPLES:
 
  i) using a eventdisplay output file called 33072.root and a table file called table_ID00.root
 
@@ -57,7 +57,7 @@ EXAMPLES:
       this produces an output file called 33072.mscw.root with mscw, mscl, and energy assign for each event
 
  iii) using a bunch of simulations files (say runnumbers 521000 to 5210010)
-     (with size cut, but no distance cut applied in eventdisplay array analysis): 
+     (with size cut, but no distance cut applied in eventdisplay array analysis):
 
       mscw_energy -tablefile table.root -inputfile "52100[0-1].root" -outputfile simu.mscw.root
 
@@ -94,4 +94,4 @@ Additional options for table reading:
 
 print run parameters for an existing mscw file
 
-	 -printrunparameters FILE 	 
+	 -printrunparameters FILE
diff --git a/docs/changes/.gitkeep b/docs/changes/.gitkeep
diff --git a/docs/changes/281.feature.md b/docs/changes/281.feature.md
@@ -0,0 +1 @@
+Introduction of average zenith angle calculation per run in VTMVAEvaluator (fAverageZenithPerRun, calculate_average_zenith_angle()).
diff --git a/docs/changes/284.maintenance.md b/docs/changes/284.maintenance.md
@@ -0,0 +1 @@
+Update SOFA to version 2023-10-11.
diff --git a/docs/changes/286.bugfix.md b/docs/changes/286.bugfix.md
@@ -0,0 +1 @@
+Fix segmentation fault when exiting on error due to an empty tree in anasum.
diff --git a/docs/changes/287.docs.md b/docs/changes/287.docs.md
@@ -0,0 +1 @@
+Add libtool compile instructions to readme.
diff --git a/docs/changes/288.maintenance.md b/docs/changes/288.maintenance.md
@@ -0,0 +1 @@
+Changes in tree structure and variable types to reduce size of output trees.
diff --git a/docs/changes/289.feature.md b/docs/changes/289.feature.md
@@ -0,0 +1,4 @@
+Introduced new functionality for reconstructing events using any three telescopes out of four (primarily for Monte Carlo data and effective area calculations).
+Added new class: `VMeanScaledVariables` for mean scaled variable calculations.
+Updated VDispAnalyzer and VSimpleStereoReconstructor to support new reconstruction modes and calculation methods.
+Updated VInstrumentResponseFunctionRunParameter and related code to include new parameters for 3-telescope reconstruction.
diff --git a/docs/changes/289.maintenance.md b/docs/changes/289.maintenance.md
@@ -0,0 +1,6 @@
+Replaced many ROOT auto-generated header/source files (e.g., CData.h, CEffArea.h, CRunSummary.h, Cshowerpars.h, Ctpars.h, Ctelconfig.h) with hand-edited or cleaner C++ code, improving maintainability and readability. Moved implementation code from `.C` files to `.cpp` files, and deleted the old `.C` files.
+Adjusted several functions and constructors to reflect changes in how data and reconstruction methods are handled (e.g., CData and related classes now use cleaner, more explicit constructors).
+Functions that previously accepted "version" or "short" flags via integers now use explicit booleans for clarity.
+Removed the CEffFit class and related files.
+Pruned unused variables and methods, including some internal variables in VTMVAEvaluator, VTableLookupDataHandler, and others.
+Removed outdated warnings, TODO comments, and deprecated features.
diff --git a/docs/changes/292.docs.md b/docs/changes/292.docs.md
@@ -0,0 +1 @@
+Improved description of docker image building.
diff --git a/docs/changes/300.maintenance.md b/docs/changes/300.maintenance.md
@@ -0,0 +1 @@
+Introduce towncrier for changelogs.
diff --git a/inc/VImageAnalyzer.h b/inc/VImageAnalyzer.h
@@ -58,7 +58,7 @@ class VImageAnalyzer : public VImageBaseAnalyzer
         }
         void initAnalysis();                      //!< set the data vectors, read the calibration data (called once at the beginning of the analysis)
         void initOutput();                        //!< open outputfile
-        void initTrees();                         //!  intitalize output tree
+        void initTrees();                         //!  initialize output tree
         void shutdown();                          //!< close outputfile
         void terminate( bool iDebug_IO = false );            //!< write results to disk
 };
diff --git a/setObservatory.sh b/setObservatory.sh
@@ -5,13 +5,13 @@
 
 if [ ! -n "$1" ] || [ "$1" = "-h" ] || [ "$1" = "-help" ]
 then
-   echo 
+   echo
    echo "set the environmental variables for EVNDISP"
-   echo 
+   echo
    echo "   source ./setObservatory.sh <observatory = CTA or VERITAS/VTS> [-q for no output if successful]"
-   echo 
+   echo
    echo "    (this is needed to find e.g. the parameter or lookup table files)"
-   echo 
+   echo
    if [[ "${BASH_SOURCE[0]}" != "${0}" ]]
    then
       kill -INT $$
@@ -33,29 +33,29 @@ fi
 
 # root LD_LIBRARY_PATH
 if [ -z "${LD_LIBRARY_PATH}" ]; then
-   LD_LIBRARY_PATH=$ROOTSYS/lib; export LD_LIBRARY_PATH 
+   LD_LIBRARY_PATH=$ROOTSYS/lib; export LD_LIBRARY_PATH
 else
    LD_LIBRARY_PATH=$ROOTSYS/lib:$LD_LIBRARY_PATH; export LD_LIBRARY_PATH
 fi
 
 # GSL LIBRARIES
-LD_LIBRARY_PATH=/opt/products/gsl/1.9/lib64/:$LD_LIBRARY_PATH; export LD_LIBRARY_PATH 
+LD_LIBRARY_PATH=/opt/products/gsl/1.9/lib64/:$LD_LIBRARY_PATH; export LD_LIBRARY_PATH
 
 # VBF
 if [ ! -z "$VBFSYS" ]; then
-   LD_LIBRARY_PATH=$VBFSYS/lib:$LD_LIBRARY_PATH; export LD_LIBRARY_PATH 
+   LD_LIBRARY_PATH=$VBFSYS/lib:$LD_LIBRARY_PATH; export LD_LIBRARY_PATH
 fi
 
 # HESSIOSYS needed for reading of CTA sim_telarray files
 if [ $OBSERVATORY = "CTA" ]
 then
-   LD_LIBRARY_PATH=$HESSIOSYS/lib:$LD_LIBRARY_PATH; export LD_LIBRARY_PATH 
+   LD_LIBRARY_PATH=$HESSIOSYS/lib:$LD_LIBRARY_PATH; export LD_LIBRARY_PATH
 fi
 
 # SOFASYS
 export SOFASYS=$EVNDISPSYS/sofa
 
 ######################################################
-## EVNDISP libraries 
+## EVNDISP libraries
 LD_LIBRARY_PATH=$EVNDISPSYS/lib/:$EVNDISPSYS/obj/:$LD_LIBRARY_PATH; export LD_LIBRARY_PATH
 ######################################################
diff --git a/setObservatory.tcsh b/setObservatory.tcsh
diff --git a/src/VCameraRead.cpp b/src/VCameraRead.cpp
diff --git a/src/VDisplay.cpp b/src/VDisplay.cpp
diff --git a/src/VTableLookupDataHandler.cpp b/src/VTableLookupDataHandler.cpp
diff --git a/src/VTraceHandler.cpp b/src/VTraceHandler.cpp
diff --git a/towncrier.toml b/towncrier.toml

Original file line number	Diff line number	Diff line change
`@@ -24,4 +24,3 @@ Required auxiliary files:`
`24`	`24`	`for efficient usage, see scripts for typical usage:`
`25`	`25`
`26`	`26`	`[VTS] $EVNDISPSYS/scripts/VTS/VTS.EFFAREA.sub_analyse.sh and $EVNDISPSYS/scripts/VTS/VTS.EFFAREA.qsub_analyse.sh`
`27`		`-`