Merge pull request #766 from DhanashreePetare/feature/jivexml-extra-hits-268

EdwardMoyse · web-flow · commit bb4e1ce4e0d6 · 2026-01-10T09:26:31.000Z
feat: improve JiveXML extra hits handling with UI controls and RK extrapolation (#268)
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,13 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 	- New helper: `RKHelper.extrapolateFromLastPosition(track, radius)`
 	- UI: dat.GUI and Phoenix menu controls to toggle extension and set radius
 	- Scene update: `SceneManager.extendCollectionTracks(collectionName, radius, enable)`
+- Improve JiveXML extra hits handling with UI controls and RK extrapolation (#268)
+	- New configuration interface: `JiveXMLTrackExtensionConfig` with options for extra hits and RK extrapolation
+	- Improved extra hits filtering algorithm with angular consistency checks (theta/phi within 0.5 radians)
+	- Configurable `minDelta` parameter for hit distance filtering (default 250mm)
+	- Integration with RK extrapolation from #177 for truncated track extension
+	- UI controls in both dat.GUI and Phoenix menu for all configuration options
+	- Methods: `EventDisplay.setJiveXMLTrackExtensionConfig()`, `EventDisplay.getJiveXMLTrackExtensionConfig()`
 
 
 
diff --git a/packages/phoenix-event-display/src/event-display.ts b/packages/phoenix-event-display/src/event-display.ts
@@ -73,6 +73,16 @@ export class EventDisplay {
     this.graphicsLibrary.init(configuration);
     // Initialize the UI with configuration
     this.ui.init(configuration);
+    // Apply JiveXML track extension configuration and surface UI controls when available
+    const loaderWithTrackExtension = this.configuration.eventDataLoader as any;
+    if (loaderWithTrackExtension?.setTrackExtensionConfig) {
+      if (this.configuration.jiveXMLTrackExtension) {
+        loaderWithTrackExtension.setTrackExtensionConfig(
+          this.configuration.jiveXMLTrackExtension,
+        );
+      }
+      this.ui.addJiveXMLTrackExtensionUI(this);
+    }
     // Set up for the state manager
     this.getStateManager().setEventDisplay(this);
 
@@ -810,4 +820,43 @@ export class EventDisplay {
       }
     }
   }
+
+  /**
+   * Set JiveXML track extension configuration.
+   * @param config Partial configuration for JiveXML track extension.
+   */
+  public setJiveXMLTrackExtensionConfig(config: any) {
+    if (!this.configuration.eventDataLoader) {
+      return;
+    }
+    // Check if the loader has the setTrackExtensionConfig method (JiveXMLLoader)
+    if (
+      typeof (this.configuration.eventDataLoader as any)
+        .setTrackExtensionConfig === 'function'
+    ) {
+      (this.configuration.eventDataLoader as any).setTrackExtensionConfig(
+        config,
+      );
+    }
+  }
+
+  /**
+   * Get JiveXML track extension configuration.
+   * @returns Current JiveXML track extension configuration or undefined if not available.
+   */
+  public getJiveXMLTrackExtensionConfig(): any {
+    if (!this.configuration.eventDataLoader) {
+      return undefined;
+    }
+    // Check if the loader has the getTrackExtensionConfig method (JiveXMLLoader)
+    if (
+      typeof (this.configuration.eventDataLoader as any)
+        .getTrackExtensionConfig === 'function'
+    ) {
+      return (
+        this.configuration.eventDataLoader as any
+      ).getTrackExtensionConfig();
+    }
+    return undefined;
+  }
 }
diff --git a/packages/phoenix-event-display/src/lib/types/configuration.ts b/packages/phoenix-event-display/src/lib/types/configuration.ts
@@ -2,6 +2,7 @@ import { PresetView } from '../models/preset-view.model';
 import type { EventDataLoader } from '../../loaders/event-data-loader';
 import type { PhoenixMenuNode } from '../../managers/ui-manager/phoenix-menu/phoenix-menu-node';
 import type { AnimationPreset } from '../../managers/three-manager/animations-manager';
+import type { JiveXMLTrackExtensionConfig } from '../../loaders/jivexml-loader';
 
 /**
  * Configuration of the event display.
@@ -27,4 +28,6 @@ export interface Configuration {
   allowUrlOptions?: boolean;
   /** Whether to force a theme ('dark' or 'light' are current options) */
   forceColourTheme?: string;
+  /** Optional configuration for JiveXML track extension controls */
+  jiveXMLTrackExtension?: Partial<JiveXMLTrackExtensionConfig>;
 }
diff --git a/packages/phoenix-event-display/src/loaders/jivexml-loader.ts b/packages/phoenix-event-display/src/loaders/jivexml-loader.ts
@@ -1,5 +1,22 @@
 import { PhoenixLoader } from './phoenix-loader';
 import { CoordinateHelper } from '../helpers/coordinate-helper';
+import { RKHelper } from '../helpers/rk-helper';
+
+/**
+ * Configuration options for JiveXML track extension.
+ */
+export interface JiveXMLTrackExtensionConfig {
+  /** Enable using extra hits for truncated tracks */
+  useExtraHits: boolean;
+  /** Minimum delta distance for filtering extra hits (in mm) */
+  extraHitsMinDelta: number;
+  /** Enable RK extrapolation for truncated tracks */
+  useRKExtrapolation: boolean;
+  /** Radius for RK extrapolation (in mm) */
+  rkExtrapolationRadius: number;
+  /** Track collections to apply extension to (empty means all) */
+  trackCollectionsToExtend: string[];
+}
 
 /**
  * PhoenixLoader for processing and loading an event from the JiveXML data format.
@@ -9,15 +26,48 @@ export class JiveXMLLoader extends PhoenixLoader {
   private data: any;
   /** List of tracks to draw with thicker tubes */
   thickTrackCollections: string[];
+  /** Configuration for track extension options */
+  private trackExtensionConfig: JiveXMLTrackExtensionConfig;
 
   /**
    * Constructor for the JiveXMLLoader.
    * @param thickTrackCollections A list of names of track collections which should be drawn thicker
+   * @param trackExtensionConfig Configuration for track extension behavior
    */
-  constructor(thickTrackCollections: string[] = []) {
+  constructor(
+    thickTrackCollections: string[] = [],
+    trackExtensionConfig?: Partial<JiveXMLTrackExtensionConfig>,
+  ) {
     super();
     this.data = {};
     this.thickTrackCollections = thickTrackCollections;
+    // Set default configuration
+    this.trackExtensionConfig = {
+      useExtraHits: false, // Disabled by default as per issue
+      extraHitsMinDelta: 250, // Current default value
+      useRKExtrapolation: false,
+      rkExtrapolationRadius: 1500,
+      trackCollectionsToExtend: [], // Empty means all collections
+      ...trackExtensionConfig, // Override with provided config
+    };
+  }
+
+  /**
+   * Update track extension configuration.
+   * @param config Partial configuration to update
+   */
+  public setTrackExtensionConfig(
+    config: Partial<JiveXMLTrackExtensionConfig>,
+  ): void {
+    this.trackExtensionConfig = { ...this.trackExtensionConfig, ...config };
+  }
+
+  /**
+   * Get current track extension configuration.
+   * @returns Current configuration
+   */
+  public getTrackExtensionConfig(): JiveXMLTrackExtensionConfig {
+    return { ...this.trackExtensionConfig };
   }
 
   /**
@@ -367,14 +417,22 @@ export class JiveXMLLoader extends PhoenixLoader {
           polylineCounter += numPolyline[i];
           track.pos = pos;
         }
+
+        // Check if we should extend this track collection
+        const shouldExtendTrack =
+          (this.trackExtensionConfig.useExtraHits ||
+            this.trackExtensionConfig.useRKExtrapolation) &&
+          (this.trackExtensionConfig.trackCollectionsToExtend.length === 0 ||
+            this.trackExtensionConfig.trackCollectionsToExtend.includes(
+              trackCollectionName,
+            ));
+
+        // IMPROVED: Extra hits extension with better filtering
         if (
-          // eslint-disable-next-line
-          false &&
-          numHits.length > 0 &&
-          trackCollectionName?.includes('Muon')
+          shouldExtendTrack &&
+          this.trackExtensionConfig.useExtraHits &&
+          numHits.length > 0
         ) {
-          // Disable for the moment.
-
           // Now loop over hits, and if possible, see if we can extend the track
           const measurementPositions = [];
           if (numHits.length > 0) {
@@ -400,35 +458,84 @@ export class JiveXMLLoader extends PhoenixLoader {
             track.hits = listOfHits;
           }
 
-          // This seems to give pretty poor results, so try to filter.
+          // IMPROVED: Better filtering logic
           // Sort radially (sorry cosmics!)
           const sortedMeasurements = measurementPositions.sort(
             (a, b) => a[3] - b[3],
           );
-          const minDelta = 250; // tweaked by trial and error
+          const minDelta = this.trackExtensionConfig.extraHitsMinDelta;
           let newHitCount = 0;
           let rejectedHitCount = 0;
           let lastDistance = maxR + minDelta;
+
           if (sortedMeasurements.length) {
             for (const meas of sortedMeasurements) {
+              // Better filtering: check distance AND angular consistency
               if (meas[3] > lastDistance + minDelta) {
-                track.pos.push([meas[0], meas[1], meas[2]]);
-                lastDistance = meas[3] + minDelta;
-                newHitCount++;
+                // Check angular consistency with track direction
+                const measTheta = Math.acos(meas[2] / meas[3]);
+                const measPhi = Math.atan2(meas[1], meas[0]);
+                const thetaDiff = Math.abs(measTheta - theta);
+                const phiDiff = Math.abs(measPhi - track.phi);
+
+                // Only add if angles are reasonably close (within 0.5 radians ~= 28 degrees)
+                if (thetaDiff < 0.5 && phiDiff < 0.5) {
+                  track.pos.push([meas[0], meas[1], meas[2]]);
+                  lastDistance = meas[3];
+                  newHitCount++;
+                } else {
+                  rejectedHitCount++;
+                }
               } else {
                 rejectedHitCount++;
               }
             }
           }
-          console.log(
-            'Added ' +
-              newHitCount +
-              ' hits to ' +
-              trackCollectionName +
-              ' (and rejected ' +
-              rejectedHitCount +
-              ')',
+
+          if (newHitCount > 0) {
+            console.log(
+              `Extended ${trackCollectionName} with ${newHitCount} extra hits (rejected ${rejectedHitCount})`,
+            );
+          }
+        }
+
+        // NEW: RK Extrapolation for truncated tracks
+        if (
+          shouldExtendTrack &&
+          this.trackExtensionConfig.useRKExtrapolation &&
+          track.pos.length > 0 &&
+          track.dparams.length === 5
+        ) {
+          const lastPos = track.pos[track.pos.length - 1];
+          const currentRadius = Math.sqrt(
+            lastPos[0] * lastPos[0] +
+              lastPos[1] * lastPos[1] +
+              lastPos[2] * lastPos[2],
           );
+          const targetRadius = this.trackExtensionConfig.rkExtrapolationRadius;
+
+          // Only extrapolate if we're not already beyond target radius
+          if (currentRadius < targetRadius) {
+            try {
+              const extrapolatedPoints = RKHelper.extrapolateFromLastPosition(
+                track,
+                targetRadius,
+              );
+
+              if (extrapolatedPoints.length > 0) {
+                // Add extrapolated points to track
+                track.pos.push(...extrapolatedPoints);
+                console.log(
+                  `Extended ${trackCollectionName} with ${extrapolatedPoints.length} RK extrapolated points to radius ${targetRadius}mm`,
+                );
+              }
+            } catch (error) {
+              console.warn(
+                `Failed to RK extrapolate track in ${trackCollectionName}:`,
+                error,
+              );
+            }
+          }
         }
 
         if (storeTrack) jsontracks.push(track);
diff --git a/packages/phoenix-event-display/src/managers/ui-manager/dat-gui-ui.ts b/packages/phoenix-event-display/src/managers/ui-manager/dat-gui-ui.ts
@@ -477,4 +477,53 @@ export class DatGUIMenuUI implements PhoenixUI<GUI> {
   public getEventDataTypeFolder(typeName: string): GUI {
     return this.eventFolder.__folders[typeName];
   }
+
+  /**
+   * Add JiveXML track extension controls to the menu.
+   * @param eventDisplay The event display instance.
+   */
+  public addJiveXMLTrackExtension(eventDisplay: any): void {
+    const jiveFolder = this.gui.addFolder('JiveXML Track Extension');
+
+    const jiveParams = {
+      useExtraHits: false,
+      extraHitsMinDelta: 250,
+      useRKExtrapolation: false,
+      rkRadius: 1500,
+    };
+
+    jiveFolder
+      .add(jiveParams, 'useExtraHits')
+      .name('Use Extra Hits')
+      .onChange((value: boolean) => {
+        eventDisplay.setJiveXMLTrackExtensionConfig({ useExtraHits: value });
+      });
+
+    jiveFolder
+      .add(jiveParams, 'extraHitsMinDelta', 50, 500)
+      .name('Extra Hits Min Delta (mm)')
+      .onChange((value: number) => {
+        eventDisplay.setJiveXMLTrackExtensionConfig({
+          extraHitsMinDelta: value,
+        });
+      });
+
+    jiveFolder
+      .add(jiveParams, 'useRKExtrapolation')
+      .name('Use RK Extrapolation')
+      .onChange((value: boolean) => {
+        eventDisplay.setJiveXMLTrackExtensionConfig({
+          useRKExtrapolation: value,
+        });
+      });
+
+    jiveFolder
+      .add(jiveParams, 'rkRadius', 100, 5000)
+      .name('RK Radius (mm)')
+      .onChange((value: number) => {
+        eventDisplay.setJiveXMLTrackExtensionConfig({
+          rkExtrapolationRadius: value,
+        });
+      });
+  }
 }
diff --git a/packages/phoenix-event-display/src/managers/ui-manager/index.ts b/packages/phoenix-event-display/src/managers/ui-manager/index.ts
@@ -609,4 +609,16 @@ export class UIManager {
   public getUIMenus(): PhoenixUI<unknown>[] {
     return this.uiMenus;
   }
+
+  /**
+   * Add JiveXML track extension controls to the UI if available.
+   * @param eventDisplay Reference to the EventDisplay instance for configuration callbacks.
+   */
+  public addJiveXMLTrackExtensionUI(eventDisplay: any) {
+    this.uiMenus.forEach((menu) => {
+      if (menu.addJiveXMLTrackExtension) {
+        menu.addJiveXMLTrackExtension(eventDisplay);
+      }
+    });
+  }
 }
diff --git a/packages/phoenix-event-display/src/managers/ui-manager/phoenix-menu/phoenix-menu-ui.ts b/packages/phoenix-event-display/src/managers/ui-manager/phoenix-menu/phoenix-menu-ui.ts
diff --git a/packages/phoenix-event-display/src/managers/ui-manager/phoenix-ui.ts b/packages/phoenix-event-display/src/managers/ui-manager/phoenix-ui.ts
