feat: use auto-generated schema enums in detector hit readers

.gitignore

@@ -6,6 +6,7 @@ target
 /docs/javadoc/*
 /clara-home
 tmp
+/common-tools/clas-io/src/main/java/org/jlab/io/banks
 
 # deployment
 /myLocalMvnRepo

common-tools/clas-detector/src/main/java/org/jlab/detector/banks/FilteredBank.java

@@ -35,7 +35,6 @@ public FilteredBank(Schema schema, int allocate, String variableName){
         filterVar = variableName;
     }
 
-
     /**
      * @param schema schema for the bank to filter
      * @param variableName name of the variable to filter on 
@@ -99,6 +98,16 @@ public int getByte(String varName, int index ){
         return bank.getByte(varName, indexList.get(index));
     }
 
+    /**
+     * 
+     * @param column
+     * @param index
+     * @return 
+     */
+    public int getByte(int column, int index ){
+        return bank.getByte(column, indexList.get(index));
+    }
+
     /**
      * @param varName name of the bank variable
      * @param index filtered index to retrieve
@@ -108,6 +117,16 @@ public int getShort(String varName, int index ){
         return bank.getShort(varName, indexList.get(index));
     }
 
+    /**
+     * 
+     * @param column
+     * @param index
+     * @return 
+     */
+    public int getShort(int column, int index ){
+        return bank.getShort(column, indexList.get(index));
+    }
+
     /**
      * @param varName name of the bank variable
      * @param index filtered index to retrieve
@@ -116,6 +135,16 @@ public int getShort(String varName, int index ){
     public int getInt(String varName, int index ){
         return bank.getInt(varName, indexList.get(index));
     }
+
+    /**
+     * 
+     * @param column
+     * @param index
+     * @return 
+     */
+    public int getInt(int column, int index) {
+        return bank.getInt(column, indexList.get(index));
+    }
 
     /**
      * @param varName name of the bank variable
@@ -126,6 +155,16 @@ public long getLong(String varName, int index ){
         return bank.getLong(varName, indexList.get(index));
     }
 
+    /**
+     * 
+     * @param column
+     * @param index
+     * @return 
+     */
+    public long getLong(int column, int index ){
+        return bank.getLong(column, indexList.get(index));
+    }
+
     /**
      * @param varName name of the bank variable
      * @param index filtered index to retrieve
@@ -135,6 +174,16 @@ public float getFloat(String varName, int index ){
         return bank.getFloat(varName, indexList.get(index));
     }
 
+    /**
+     * 
+     * @param column
+     * @param index
+     * @return 
+     */
+    public float getFloat(int column, int index ){
+        return bank.getFloat(column, indexList.get(index));
+    }
+
     /**
      * @param index filtered index to retrieve
      * @return true bank row index corresponding to the filtered index

libexec/bank-schema-enums

@@ -0,0 +1,16 @@
+#!/usr/bin/env python3
+import os,glob,json
+idir = 'etc/bankdefs/hipo4'
+odir = 'common-tools/clas-io/src/main/java/org/jlab/io/banks'
+os.makedirs(odir, exist_ok=True)
+for x in glob.glob(f'{idir}/*.json'):
+    for bank in json.load(open(x,'r')):
+        class_name = bank['name'].replace(':','_');
+        with open(f'{odir}/{class_name}.java','w') as f:
+            f.write('package org.jlab.io.banks;\n')
+            f.write(f'public class {class_name} {{\n')
+            for i,entry in enumerate(bank['entries']):
+                var_name = entry['name']
+                f.write(f'    public static final short {var_name} = {i};\n')
+            f.write('}\n')
+            f.close()

pom.xml

@@ -263,6 +263,30 @@
 
     <plugins> <!-- plugins inherited by all child POMs -->
 
+      <!-- generate bank shcema enums --> 
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-antrun-plugin</artifactId>
+        <version>3.1.0</version>
+        <executions>
+          <execution>
+            <id>bank-schema-enums</id>
+            <phase>validate</phase>
+            <goals>
+              <goal>run</goal>
+            </goals>
+            <inherited>false</inherited> <!-- make this one NOT inherited -->
+            <configuration>
+              <target>
+                <exec executable="python3">
+                  <arg value="libexec/bank-schema-enums"/>
+                </exec>
+              </target>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
+
       <!-- static analysis -->
       <plugin>
         <groupId>com.github.spotbugs</groupId>
@@ -428,6 +452,22 @@
     <pluginManagement>
       <plugins> <!-- plugin configurations (unused in child POMs unless declared) -->
 
+        <!-- delete auto-generated bank schema enums during clean phase -->
+        <plugin>
+          <artifactId>maven-clean-plugin</artifactId>
+          <version>3.4.0</version>
+          <configuration>
+            <filesets>
+              <fileset>
+                <directory>common-tools/clas-io/src/main/java/org/jlab/io/banks</directory>
+                <includes>
+                  <include>**/*.java</include>
+                </includes>
+              </fileset>
+            </filesets>
+          </configuration>
+        </plugin>
+
         <!-- generate minimal POM files for deployment, containing GAV (groupID, artifactId, version) -->
         <plugin>
           <groupId>org.codehaus.mojo</groupId>

reconstruction/ai/src/main/java/org/jlab/service/ai/DCClsComboEngine.java

@@ -24,6 +24,7 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import org.jlab.clas.reco.ReconstructionEngine;
+import org.jlab.io.banks.HitBasedTrkg__Clusters;
 import org.jlab.io.base.DataBank;
 import org.jlab.io.base.DataEvent;
 import org.jlab.utils.system.ClasUtilsFile;
@@ -128,11 +129,11 @@ public boolean processDataEvent(DataEvent event) {
         int rows = bank.rows();
         for (int r = 0; r < rows; r++) {
 
-            int id          = bank.getInt("id", r);
-            int sector      = bank.getByte("sector", r);
-            int superlayer  = bank.getByte("superlayer", r);
-            float avgWire   = bank.getFloat("avgWire", r);
-            float fitSlope  = bank.getFloat("fitSlope", r);
+            int id          = bank.getInt(HitBasedTrkg__Clusters.id, r);
+            int sector      = bank.getByte(HitBasedTrkg__Clusters.sector, r);
+            int superlayer  = bank.getByte(HitBasedTrkg__Clusters.superlayer, r);
+            float avgWire   = bank.getFloat(HitBasedTrkg__Clusters.avgWire, r);
+            float fitSlope  = bank.getFloat(HitBasedTrkg__Clusters.fitSlope, r);
 
             DCCluster cls = new DCCluster(id, sector, superlayer, avgWire, fitSlope);
             allClusterList.add(cls);

reconstruction/cvt/src/main/java/org/jlab/rec/cvt/banks/HitReader.java

@@ -9,6 +9,8 @@
 import org.jlab.detector.banks.RawDataBank;
 import org.jlab.detector.base.DetectorDescriptor;
 import org.jlab.detector.base.DetectorType;
+import org.jlab.io.banks.BMT__adc;
+import org.jlab.io.banks.BST__adc;
 import org.jlab.io.base.DataEvent;
 import org.jlab.rec.cvt.Constants;
 import org.jlab.rec.cvt.Geometry;
@@ -112,11 +114,11 @@ public void fetch_BMTHits(DataEvent event, Swim swim, IndexedTable status,
                 //if (bankDGTZ.getInt("ADC", i) < 1) {
                     //continue; // gemc assigns strip value -1 for inefficiencies, we only consider strips with values between 1 to the maximum strip number for a given detector
                 //}                
-                int sector  = bankDGTZ.getByte("sector", i);
-                int layer   = bankDGTZ.getByte("layer", i);
-                int strip   = bankDGTZ.getShort("component", i);
-                double ADCtoEdep = bankDGTZ.getInt("ADC", i);
-                double time = bankDGTZ.getFloat("time", i);
+                int sector  = bankDGTZ.getByte(BMT__adc.sector, i);
+                int layer   = bankDGTZ.getByte(BMT__adc.layer, i);
+                int strip   = bankDGTZ.getShort(BMT__adc.component, i);
+                double ADCtoEdep = bankDGTZ.getInt(BMT__adc.ADC, i);
+                double time = bankDGTZ.getFloat(BMT__adc.time, i);
                 int order   = bankDGTZ.trueOrder(i);
                 //if (order == 1) {
                 //    continue;
@@ -248,8 +250,8 @@ public void fetch_SVTHits(DataEvent event, int omitLayer, int omitHemisphere,
             //The value adcStatus in ccdb is 1 for runs where ADC=-1 is not permitted and 0 for runs where ADC=-1 is permitted
 
             int adcStat = adcStatus.getIntValue("adcstatus", 0, 0, 0);
-            for (int i = 0; i < rows; i++) {     
-                int ADC = bankDGTZ.getInt("ADC", i);
+            for (int i = 0; i < rows; i++) {
+                int ADC = bankDGTZ.getInt(BST__adc.ADC, i);
                 if(ADCConvertor.isEventUnCorrupted(ADC, adcStat)==false) {
                     return;
                 }
@@ -259,11 +261,11 @@ public void fetch_SVTHits(DataEvent event, int omitLayer, int omitHemisphere,
             // first get tdcs
             Map<Integer, Double> tdcs = new HashMap<>();
             for (int i = 0; i < rows; i++) {                
-                if(bankDGTZ.getInt("ADC", i) < 0) {
-                    int sector = bankDGTZ.getByte("sector", i);
-                    int layer  = bankDGTZ.getByte("layer", i);
-                    int strip = bankDGTZ.getShort("component", i);
-                    double time = bankDGTZ.getFloat("time", i);
+                if(bankDGTZ.getInt(BST__adc.ADC, i) < 0) {
+                    int sector = bankDGTZ.getByte(BST__adc.sector, i);
+                    int layer  = bankDGTZ.getByte(BST__adc.layer, i);
+                    int strip = bankDGTZ.getShort(BST__adc.component, i);
+                    double time = bankDGTZ.getFloat(BST__adc.time, i);
 
                     //if (order == 1) {
                     //    continue;
@@ -283,15 +285,15 @@ public void fetch_SVTHits(DataEvent event, int omitLayer, int omitHemisphere,
 
             // then get real hits
             for (int i = 0; i < rows; i++) {
-                if (bankDGTZ.getInt("ADC", i) < 0) {
+                if (bankDGTZ.getInt(BST__adc.ADC, i) < 0) {
                     continue; // ignore hits TDC hits with ADC==-1 
                 }
-                int order   = bankDGTZ.getByte("order", i);
+                int order   = bankDGTZ.getByte(BST__adc.order, i);
+                int sector  = bankDGTZ.getByte(BST__adc.sector, i);
+                int layer   = bankDGTZ.getByte(BST__adc.layer, i);
+                int strip   = bankDGTZ.getShort(BST__adc.component, i);
+                int ADC     = bankDGTZ.getInt(BST__adc.ADC, i);
                 int id      = i + 1;
-                int sector  = bankDGTZ.getByte("sector", i);
-                int layer   = bankDGTZ.getByte("layer", i);
-                int strip   = bankDGTZ.getShort("component", i);
-                int ADC     = bankDGTZ.getInt("ADC", i);
                 double time = 0;//bankDGTZ.getFloat("time", i);
                 int tdcstrip = 1;
                 if(strip>128) tdcstrip = 129;

reconstruction/dc/src/main/java/org/jlab/rec/dc/banks/HitReader.java

@@ -17,6 +17,10 @@
 import org.jlab.detector.banks.RawDataBank;
 import org.jlab.detector.calib.utils.ConstantsManager;
 import org.jlab.detector.geant4.v2.DCGeant4Factory;
+import org.jlab.io.banks.DC__jitter;
+import org.jlab.io.banks.DC__tdc;
+import org.jlab.io.banks.HitBasedTrkg__HBHitTrkId;
+import org.jlab.io.banks.HitBasedTrkg__Hits;
 import org.jlab.rec.dc.Constants;
 import org.jlab.utils.groups.IndexedTable;
 
@@ -128,9 +132,9 @@ private void getDCRBJitters(boolean swapBits) {
 
             DataBank bankTS = event.getBank(bankNames.getTimeStampBank());
             for(int i=0; i<bankTS.rows(); i++) {
-                int  crate     = bankTS.getByte("crate", i);
-                int  slot      = bankTS.getByte("slot", i);
-                long timestamp = bankTS.getLong("timestamp", i);
+                int  crate     = bankTS.getByte(DC__jitter.crate, i);
+                int  slot      = bankTS.getByte(DC__jitter.slot, i);
+                long timestamp = bankTS.getLong(DC__jitter.timestamp, i);
                 if(swapBits) {
                     timestamp = (Long) (((timestamp&0x0000ffffff000000L)>>24)|((timestamp&0x0000000000ffffffL)<<24));
                 }
@@ -186,13 +190,13 @@ public void fetch_DCHits(DataEvent event) {
 
         this.set_NumTDCBankRows(bankFiltered.rows());
         for (int i = 0; i < bankFiltered.rows(); i++) {
-            int sector     = bankFiltered.getByte("sector", i);
-            int layer      = (bankFiltered.getByte("layer", i)-1)%6 + 1;
-            int superlayer = (bankFiltered.getByte("layer", i)-1)/6 + 1;
-            int wire       = bankFiltered.getShort("component", i);
+            int sector     = bankFiltered.getByte(DC__tdc.sector, i);
+            int layer      = (bankFiltered.getByte(DC__tdc.layer, i)-1)%6 + 1;
+            int superlayer = (bankFiltered.getByte(DC__tdc.layer, i)-1)/6 + 1;
+            int wire       = bankFiltered.getShort(DC__tdc.component, i);
             int order      = bankFiltered.trueOrder(i);
-            int jitter     = this.getJitter(sector, bankFiltered.getByte("layer", i), wire, order);
-            int tdc        = bankFiltered.getInt("TDC", i) - jitter;
+            int jitter     = this.getJitter(sector, bankFiltered.getByte(DC__tdc.layer, i), wire, order);
+            int tdc        = bankFiltered.getInt(DC__tdc.TDC, i) - jitter;
             int index      = bankFiltered.trueIndex(i);
 
             boolean passHit = true;
@@ -246,15 +250,15 @@ private Map<Integer, ArrayList<FittedHit>> read_Hits() {
 
         List<FittedHit> hits = new ArrayList<>();
         for (int i = 0; i < rows; i++) {
-            int id          = bank.getShort("id", i);
-            int sector      = bank.getByte("sector", i);
-            int slayer      = bank.getByte("superlayer", i);
-            int layer       = bank.getByte("layer", i);
-            int wire        = bank.getShort("wire", i);
-            int tdc         = bank.getInt("TDC", i);
-            int jitter      = bank.getByte("jitter", i);
-            int LR          = bank.getByte("LR", i);
-            int clusterID   = bank.getShort("clusterID", i);
+            int id          = bank.getShort(HitBasedTrkg__Hits.id, i);
+            int sector      = bank.getByte(HitBasedTrkg__Hits.sector, i);
+            int slayer      = bank.getByte(HitBasedTrkg__Hits.superlayer, i);
+            int layer       = bank.getByte(HitBasedTrkg__Hits.layer, i);
+            int wire        = bank.getShort(HitBasedTrkg__Hits.wire, i);
+            int tdc         = bank.getInt(HitBasedTrkg__Hits.TDC, i);
+            int jitter      = bank.getByte(HitBasedTrkg__Hits.jitter, i);
+            int LR          = bank.getByte(HitBasedTrkg__Hits.LR, i);
+            int clusterID   = bank.getShort(HitBasedTrkg__Hits.clusterID, i);
 
             //use only hits that have been fit to a track
             if (clusterID == -1) {
@@ -331,10 +335,10 @@ private void read_HBHits(TimeToDistanceEstimator tde) {
 
         DataBank pbank = event.getBank(pointName);
         for (int i = 0; i < pbank.rows(); i++) {
-            id2tid.put((int)pbank.getShort("id", i), (int)pbank.getShort("tid", i));
-            id2tidB.put((int)pbank.getShort("id", i), (double)pbank.getFloat("B", i));
-            id2tidtFlight.put((int)pbank.getShort("id", i), (double)pbank.getFloat("TFlight", i));
-            id2tidtProp.put((int)pbank.getShort("id", i), (double)pbank.getFloat("TProp", i));
+            id2tid.put((int)pbank.getShort(HitBasedTrkg__HBHitTrkId.id, i), (int)pbank.getShort(HitBasedTrkg__HBHitTrkId.tid, i));
+            id2tidB.put((int)pbank.getShort(HitBasedTrkg__HBHitTrkId.id, i), (double)pbank.getFloat(HitBasedTrkg__HBHitTrkId.B, i));
+            id2tidtFlight.put((int)pbank.getShort(HitBasedTrkg__HBHitTrkId.id, i), (double)pbank.getFloat(HitBasedTrkg__HBHitTrkId.TFlight, i));
+            id2tidtProp.put((int)pbank.getShort(HitBasedTrkg__HBHitTrkId.id, i), (double)pbank.getFloat(HitBasedTrkg__HBHitTrkId.TProp, i));
         }
 
         DataBank bank = event.getBank(bankName);
@@ -357,19 +361,18 @@ private void read_HBHits(TimeToDistanceEstimator tde) {
         double[] trkDoca = new double[rows];
 
         for (int i = 0; i < rows; i++) {
-            id[i] = bank.getShort("id", i);
-            status[i] = bank.getShort("status", i);
-            sector[i] = bank.getByte("sector", i);
-            slayer[i] = bank.getByte("superlayer", i);
-            layer[i] = bank.getByte("layer", i);
-            wire[i] = bank.getShort("wire", i);
-            tdc[i] = bank.getInt("TDC", i);
-            jitter[i] = bank.getByte("jitter", i);
-            id[i] = bank.getShort("id", i);
-            LR[i] = bank.getByte("LR", i);
-
-            trkDoca[i] = bank.getFloat("trkDoca", i);
-            clusterID[i] = bank.getShort("clusterID", i);
+            id[i] = bank.getShort(HitBasedTrkg__Hits.id, i);
+            status[i] = bank.getShort(HitBasedTrkg__Hits.status, i);
+            sector[i] = bank.getByte(HitBasedTrkg__Hits.sector, i);
+            slayer[i] = bank.getByte(HitBasedTrkg__Hits.superlayer, i);
+            layer[i] = bank.getByte(HitBasedTrkg__Hits.layer, i);
+            wire[i] = bank.getShort(HitBasedTrkg__Hits.wire, i);
+            tdc[i] = bank.getInt(HitBasedTrkg__Hits.TDC, i);
+            jitter[i] = bank.getByte(HitBasedTrkg__Hits.jitter, i);
+            id[i] = bank.getShort(HitBasedTrkg__Hits.id, i);
+            LR[i] = bank.getByte(HitBasedTrkg__Hits.LR, i);
+            trkDoca[i] = bank.getFloat(HitBasedTrkg__Hits.trkDoca, i);
+            clusterID[i] = bank.getShort(HitBasedTrkg__Hits.clusterID, i);
             trkID[i] = -1;
             if(this.id2tid.containsKey(id[i]) ){
                 trkID[i]    = this.id2tid.get(id[i]);