LISTSERV 16.5 - LCD-CVS Archives

lcsim-contrib/src/main/java/org/lcsim/contrib/onoprien/tester

TrackingTestBase.java removed after 1.1.1.1

diff -N TrackingTestBase.java
--- TrackingTestBase.java	10 Dec 2008 22:03:06 -0000	1.1.1.1
+++ /dev/null	1 Jan 1970 00:00:00 -0000
@@ -1,543 +0,0 @@

-package org.lcsim.contrib.onoprien.tester;
-
-import java.io.*;
-import java.lang.reflect.*;
-import java.util.*;
-import javax.swing.*;
-
-import hep.aida.*;
-import hep.aida.ref.histogram.*;
-import hep.physics.particle.Particle;
-import org.lcsim.event.*;
-import org.lcsim.recon.cat.util.NoSuchParameterException;
-import org.lcsim.recon.mcTrackFinder.MCTrack;
-import org.lcsim.util.Driver;
-import org.lcsim.geometry.Detector;
-import org.lcsim.util.aida.AIDA;
-
-/**
- * Abstract driver class that provides infrastructure and utility methods for testing track finders.
- * See {@link TrackingTest} and {@link PiTest} for examples of use.
- * <p>
- * Classes implementing particular tests should extend this class, overriding<br>
- * {@link #analyzeEvent(EventHeader)}<br>
- * and, if necessary,<br>
- * {@link #eventFilter(EventHeader event)},<br>
- * {@link #matchTracks(Track track, MCTrack mcTrack)},<br>
- * {@link #mcTrackFilter(MCTrack mcTrack)},<br>
- * {@link #isReconstructed(MCTrack mcTrack)},<br>
- * {@link #isFake(RatedTrack track)},<br>
- * {@link #startOfRun(Detector)}, and {@link #endOfRun()} methods.<br>
- * Default implementations are provided for these methods.
- * <p>
- * Subclusses extending this driver should be added to the event processing chain
- * after track findind stage. Cheater track finder 
- * (see {@link org.lcsim.recon.mcTrackFinder}) should also be run before the test 
- * to create a list of MCTracks and put it into the event. 
- * <p>
- * When the driver's {@link #process(EventHeader event)}
- * method is called by the framework, it fetches a list of Monte Carlo tracks,
- * marks those for which {@link #mcTrackFilter(MCTrack mcTrack)} returns 
- * <tt>true</tt> as being in the requested class (subsequent calls to
- * {@link MCTrack#getStatus(int) mcTrack.getStatus(TrackingTestBase.IN_CLASS)}
- * will return <tt>TrackingTestBase.YES</tt>),
- * associates MCTracks and reconstructed tracks for which 
- * {@link #matchTracks(Track track, MCTrack mcTrack)} returns <tt>true</tt> with 
- * each other, and then calls
- * {@link #analyzeEvent(EventHeader)} method that should be implemented by subclasses.
- * <p>
- * Only events for which {@link #eventFilter(EventHeader)} returns <tt>true</tt> are processed.
- * <p>
- * There is an optional facility for accumulating and printing statistics.
- * Any number of variables for accumulating statistics can be created with
- * {@link #createIndex(String name, IndexType... args)}. Data put into
- * these variables is automatically accumulated at the end of event processing,
- * and can be printed out with {@link #printStatistics(EventHeader event)} and 
- * {@link #printCumulativeStatistics()}.
- *
- * @author D. Onoprienko
- * @version $Id: TrackingTestBase.java,v 1.1.1.1 2008/12/10 22:03:06 jeremy Exp $
- */
-abstract public class TrackingTestBase extends Driver {
-  
-// -- Constants defining status categories and values:  ------------------------
-  
-  public static final int IN_CLASS = -1;
-  public static final int FAKE = -2;
-  
-  public static final int YES = -1;
-  public static final int NO = -2;
-  
-// -- Constructors :  ----------------------------------------------------------
-
-  /** Default constructor. */
-  public TrackingTestBase() {
-    _testName = "";
-    _aida = AIDA.defaultInstance();
-    _tree = _aida.tree();
-    _mcTrackListName = "";
-    _recoTrackListName = "";
-    _runInProgress = false;
-  }
-  
-  /** Constructor taking the name of the test. */
-  public TrackingTestBase(String name) {
-    this();
-    set("TEST_NAME", name);
-  }
-  
-  // -- Setters :  -------------------------------------------------------------
-  
-  /** 
-   * Set any <tt>String</tt> parameter.
-   * The following parameters can be set with this method:<br>
-   * <tt>"TEST_NAME"</tt> - name of the test. The name will printed with the test output statistics.<br>
-   * <tt>"RECONSTRUCTED_TRACK_COLLECTION_NAME"</tt> - name of reconstructed track 
-   *                         collection produced by the track finder being tested.<br>
-   * <tt>"MC_TRACK_COLLECTION_NAME"</tt> - name of MCTrack collection created by previously run MCTrackFinder.
-   * @param name   Name of parameter to be set. Case ignored.
-   * @param value  Value to be assigned to the parameter.
-   * @throws NoSuchParameterException Thrown if the supplied parameter name is unknown.
-   *         Subclasses may catch this exception after a call to <tt>super.set()</tt>
-   *         and set their own parameters.
-   */
-  public void set(String name, String value) {
-    if (name.equalsIgnoreCase("TEST_NAME")) {
-        _testName = value;
-    } else if (name.equalsIgnoreCase("RECONSTRUCTED_TRACK_COLLECTION_NAME")) {
-        _recoTrackListName = value;
-    } else if (name.equalsIgnoreCase("MC_TRACK_COLLECTION_NAME")) {
-        _mcTrackListName = value;
-    } else {
-      throw new NoSuchParameterException(name, this.getClass());
-    }
-  }
-
-  /** 
-   * Set any double parameter. 
-   * The following parameters can be set with this method:<br>
-   * <tt>"MCTrackCut_Pt"</tt> - cut on Pt for MCTrack to be considered reconstructable. Default: 0.<br>
-   * <tt>"MCTrackCut_Theta"</tt> - cut on Theta for MCTrack to be considered reconstructable. Default: 0.<br>
-   * <tt>"MCTrackCut_Rapidity"</tt> - cut on pseudo-rapidity for MCTrack to be considered reconstructable. Default: infinity.<br>
-   * @param name   Name of parameter to be set. Case ignored.
-   * @param value  Value to be assigned to the parameter.
-   * @throws NoSuchParameterException Thrown if the supplied parameter name is unknown.
-   *         Subclasses may catch this exception after a call to <tt>super.set()</tt>
-   *         and set their own parameters.
-   */
-  public void set(String name, double value) {
-    if (name.equalsIgnoreCase("MCTrackCut_Pt")) {
-      _mcTrackCut_Pt = value;
-    } else if (name.equalsIgnoreCase("MCTrackCut_Theta")) {
-      _mcTrackCut_theta = value;
-    } else if (name.equalsIgnoreCase("MCTrackCut_Rapidity")) {
-      if (value < 10000.) {
-        _mcTrackCut_theta = 2.*Math.atan(Math.exp(-value));
-      } else {
-        _mcTrackCut_theta = 0.;
-      }
-    } else {
-      throw new NoSuchParameterException(name, this.getClass());
-    }    
-  }
-
-  /** 
-   * Set any integer parameter. 
-   * The following parameters can be set with this method:<br>
-   * <tt>"MCTrackCut_nLayers"</tt> - cut on minimum number of layers with hits 
-   *                   for MCTrack to be considered reconstructable. Default: 3.<br>
-   * @param name   Name of parameter to be set. Case ignored.
-   * @param value  Value to be assigned to the parameter.
-   * @throws NoSuchParameterException Thrown if the supplied parameter name is unknown.
-   *         Subclasses may catch this exception after a call to <tt>super.set()</tt>
-   *         and set their own parameters.
-   */
-  public void set(String name, int value) {
-    if (name.equalsIgnoreCase("MCTrackCut_nLayers")) {
-      _mcTrackCut_nLayers = value;
-    } else {
-      throw new NoSuchParameterException(name, this.getClass());
-    }
-  }
-  
-// -- Processing event :  ------------------------------------------------------
-  
-  /** Process event. */
-  public final void process(EventHeader event) {
-    
-    super.process(event);
-    
-    // Skip undesired events
-    
-    if (!eventFilter(event)) return;
-    
-    // Reset "per event" statistics
-    
-    if (_statE != null) Arrays.fill(_statE, 0.);
-    
-    // Fetch list of Monte Carlo Tracks, and set IN_CLASS flag for them
-    
-    _mcTrackList = event.get(MCTrack.class, _mcTrackListName);
-    for (MCTrack mcTrack : _mcTrackList) {
-      mcTrack.setStatus(IN_CLASS, mcTrackFilter(mcTrack) ? YES : NO);
-    }
-    
-    // Associate reconstructed tracks with Monte Carlo Tracks
-    
-    _recoTrackList = event.get(Track.class, _recoTrackListName);
-    _ratedTrackList = new ArrayList<RatedTrack>(_recoTrackList.size());
-    
-    for (Track track : _recoTrackList) {
-      RatedTrack ratedTrack = new RatedTrack(track);
-      for (MCTrack mcTrack : _mcTrackList) {
-        if (matchTracks(track, mcTrack)) {
-          ratedTrack.addMCTrack(mcTrack);
-          mcTrack.addTrack(track);
-        }
-      }
-      _ratedTrackList.add(ratedTrack);
-    }
-    
-    // User's analysis
-    
-    analyzeEvent(event);
-    
-    // Update cumulative statistics
-    
-    if (_statE != null) {
-      for (int i=0; i<_statE.length; i++) _statC[i] += _statE[i];
-    }
-    _nEvents++;
-    
-    // Clean up
-    
-    for (MCTrack mcTrack : _mcTrackList) {
-      mcTrack.removeTracks();
-    }
-    _mcTrackList = null;
-    _recoTrackList = null;
-    _ratedTrackList = null;
-    
-  }
-  
-// -- Selector methods to be overridden by subclasses :  -----------------------
-  
-  /**
-   * Returns <code>true</code> for events that should be included in analysis.
-   * Default implementation always returns <code>true</code>.
-   * Subclasses should overwrite this method if some events need to be excluded.
-   */
-  protected boolean eventFilter(EventHeader event) {
-    return true;
-  }
-  
-  /** 
-   * Returns <tt>true</tt> if Monte Carlo track belongs to the class that needs to be included in analysis.
-   * Cuts on Pt, Theta, and a minimum number of layers with hits.
-   * Cut values can be set at run time, leaving them at default values means no cuts.
-   * Subclasses can overwrite this method to provide their own definition of "reconstructable" track.
-   */
-  protected boolean mcTrackFilter(MCTrack mcTrack) {
-    if (mcTrack.getPt() < _mcTrackCut_Pt) return false;
-    if (mcTrack.getTheta() < _mcTrackCut_theta) return false;
-    if (mcTrack.getNLayers() < _mcTrackCut_nLayers) return false;
-    return true;
-  }
-  
-  /** 
-   * Returns <code>true</code> if reconstructed track and Monte Carlo track are deemed to describe the same track.
-   * Default implementation: tracks match if they have common hits in at least 3 layers.
-   * (Alternative definition to be considered later: Tracks match if MCParticle 
-   * contributed to hits of reconstructed track in at least 3 layers).
-   * <i>Current implementation simply asks for 3 common hits since
-   * {@link TrackerHit} is completely "detector blind" at the moment.</i>
-   * Subclasses can overwrite this method to provide their own definition of matching tracks.
-   */
-  protected boolean matchTracks(Track track, MCTrack mcTrack) {
-    List<TrackerHit> recoTrackHitList = track.getTrackerHits();
-    List<TrackerHit> mcTrackHitList = mcTrack.getTrackerHits();
-    int nMatch = 0;
-    for (TrackerHit hit : mcTrackHitList) {
-      if (recoTrackHitList.contains(hit)) nMatch++;
-    }
-    return nMatch > 2;
-  }
-  
-  /** 
-   * Definition of a successfully reconstracted MCTrack.
-   * This method is not called internally by any <tt>TrackingTestBase</tt> methods,
-   * but can be used (or overridded) by subclasses.
-   * What I would like to do here is to require that there is a reconstructed 
-   * track that picked up hits from this MCTrack in at least 3 layers.
-   * Given current limitations of {@link TrackerHit} that has no layer information,
-   * the default implementation returns <tt>true</tt> if any reconstructed 
-   * tracks have been associated with MCTrack supplied as a parameter. If default
-   * implementation of {@link #matchTracks(Track, MCTrack)} is used, that means
-   * requiring a reconstructed track with 3 hits common with the given MCTrack.
-   */
-  protected boolean isReconstructed(MCTrack mcTrack) {
-    return mcTrack.getTracks().size() > 0;
-  }
-
-  /**
-   * Definition of fake track.
-   * This method is not called internally by any <tt>TrackingTestBase</tt> methods,
-   * but can be used (or overridded) by subclasses.
-   * In the future, I'd like to consider the track fake if there is no MCParticle
-   * that contributed to its hits in all but one layer.
-   * Given current limitations of {@link TrackerHit}, the actual definition is:
-   * the track is fake if there is no MCTrack that contains all but one of its hits.
-   */
-  protected boolean isFake(RatedTrack track) {
-    List<MCTrack> mcTrackList = track.getMCTracks();
-    if (mcTrackList.size() == 0) return true;
-    List<TrackerHit> recoHitList = track.getTrack().getTrackerHits();
-    for (MCTrack mcTrack : mcTrackList) {
-      int nSomeoneElsesHits = 0;
-      for (TrackerHit hit : recoHitList) {
-        if (!mcTrack.getTrackerHits().contains(hit)) nSomeoneElsesHits++;
-      }
-      if (nSomeoneElsesHits <= 1) return false;
-    }
-    return true;
-  }
-  
-// -- User analysis hooks :  ---------------------------------------------------
-  
-  /** User analysis before the run. */
-  protected void startOfRun(Detector detector) {}
-  
-  /** User analysis of the event. */
-  abstract protected void analyzeEvent(EventHeader event);
-  
-  /** User analysis before the run. */
-  protected void endOfRun() {}
-  
-  /**
-   * Called when all data processing is finished.
-   * Unless overwritten in the subclass, prints out standard cumulative statistics.
-   */
-  final protected void endOfData() {
-    super.endOfData();
-    endOfRun();
-    _runInProgress = false;
-  }
-  
-  /**
-   * Called before the first event is processed, or after a rewind.
-   * Unless overwritten in the subclass, resets standard cumulative statistics.
-   */
-  final public void detectorChanged(Detector detector) {
-    super.detectorChanged(detector);
-    if (_runInProgress) {
-      endOfRun();
-    }
-    _nEvents = 0;
-    if (_statE != null) Arrays.fill(_statC, 0.);
-    _runInProgress = true;
-    startOfRun(detector);
-  }
-  
-// -- Protected helper methods:  -----------------------------------------------
-  
-  /** 
-   * Print to the log.
-   * The output destination can be set with <tt>set("LOG_FILE", destination)</tt>.
-   * See {@link #set(String, String)} for details.
-   */
-  protected void printLog(String title, String... messages) {
-    if (title != null) {
-      System.out.println("");
-      System.out.println(title);
-      System.out.println("");
-    }
-    for (String line : messages) {
-      System.out.println(line);
-    }
-  }
-  
-  protected enum IndexType {NOSUM, SUM, SUM2, NOPRINT, PRINTEVENT, PRINTSUM, PRINTALL}
-  
-  /**
-   * Creates a new statistical variable and returns an index that can be used to access it.
-   * "Per event" data can be put into <code>_statE[index]</code>, these variables are reset
-   * to zero at the beginning of each event. At the end of the event, statistics is
-   * automatically accumulated into <code>_statC[index]</code>. The name of the variable
-   * is accessable through <code>_statName[index]</code>.
-   *
-   * @param name  Name to be assigned to the variable.
-   * @param args  Optional flags defining accumulation type and printing preferences. Possible flags and their meanings:<p>
-   *    &nbsp; NOSUM - do not accumulate this variable.<br>
-   *    &nbsp; SUM - <code>_statE[index]</code> added to <code>_statC[index]</code> at the end of event.<br>
-   *    &nbsp; SUM2 - square of <code>_statE[index]</code> added to <code>_statC[index]</code> at the end of event.<br>
-   *    &nbsp; If no flag is given, SUM is assumed.<p>
-   *    &nbsp; NOPRINT - variable is not printed by {@link #printStatistics(EventHeader event)} and {@link #printCumulativeStatistics()}<br>
-   *    &nbsp; PRINTEVENT - variable is printed by {@link #printStatistics(EventHeader event)} but not by {@link #printCumulativeStatistics()}<br>
-   *    &nbsp; PRINTSUM - variable is printed by {@link #printCumulativeStatistics()} but not by {@link #printStatistics(EventHeader event)}<br>
-   *    &nbsp; PRINTALL - variable is printed by both {@link #printCumulativeStatistics()} and {@link #printStatistics(EventHeader event)}<br>
-   *    &nbsp; &nbsp; If no flag is given, PRINTALL is assumed.<p>
-   * @return  Index into {@link #_statE}, {@link #_statC}, and {@link #_statName} arrays that can be used to access the variable being created.
-   */
-  protected int createIndex(String name, IndexType... args) {
-    
-    int size;
-    if (_statE == null) {
-      _statE = new double[] {0.};
-      _statC = new double[] {0.};
-      _statName = new String[] {name};
-      _statAccumulateFlag = new IndexType[] {IndexType.SUM};
-      _statPrintFlag = new IndexType[] {IndexType.PRINTALL};
-      size = 0;
-    } else {
-      
-      size = _statE.length;
-      
-      double[] tempD = new double[size+1];
-      System.arraycopy(_statE, 0, tempD, 0, size);
-      _statE = tempD;
-      _statE[size] = 0.;
-      
-      tempD = new double[size+1];
-      System.arraycopy(_statC, 0, tempD, 0, size);
-      _statC = tempD;
-      _statC[size] = 0.;
-      
-      String[] tempS = new String[size+1];
-      System.arraycopy(_statName, 0, tempS, 0, size);
-      _statName = tempS;
-      _statName[size] = name;
-      
-      IndexType[] tempI = new IndexType[size+1];
-      System.arraycopy(_statAccumulateFlag, 0, tempI, 0, size);
-      _statAccumulateFlag = tempI;
-      _statAccumulateFlag[size] = IndexType.SUM;
-      
-      tempI = new IndexType[size+1];
-      System.arraycopy(_statPrintFlag, 0, tempI, 0, size);
-      _statPrintFlag = tempI;
-      _statPrintFlag[size] = IndexType.PRINTSUM;
-    }
-    
-    if (args != null) {
-      for (IndexType type : args) {
-        switch (type) {
-          case NOSUM:
-          case SUM:
-          case SUM2:
-            _statAccumulateFlag[size] = type; break;
-          case NOPRINT:
-          case PRINTEVENT:
-          case PRINTSUM:
-          case PRINTALL:
-            _statPrintFlag[size] = type; break;
-        }
-      }
-    }
-    
-    return size;
-  }
-  
-  /** Print standard statistics at the end of an event to standard output. */
-  protected void printStatistics(EventHeader event) {
-    System.out.println("");
-    System.out.println("Tracking test: " + _testName + ", statistics for event " + event.getEventNumber());
-    for (int i=0; i<_statE.length; i++) {
-      if (_statPrintFlag[i] == IndexType.PRINTEVENT || _statPrintFlag[i] == IndexType.PRINTALL) {
-        System.out.println("  " + _statName[i] + "  " + _statE[i]);
-      }
-    }
-    System.out.println("");
-  }
-  
-  /** 
-   * Print cumulative statistics to the log. 
-   * The output destination can be set with <tt>set("LOG_FILE", destination)</tt>.
-   * See {@link #set(String, String)} for details.
-   * @param messages  Array of strings that should be printed before standard statistics.
-   * @param printStandard   Flag to indicate whether to print standard statistics.
-   */
-  protected void printCumulativeStatistics(boolean printStandard, String... messages) {
-    ArrayList<String> msgList = new ArrayList<String>(20);
-    msgList.add("");
-    if (messages != null) for (String msg : messages) msgList.add("  " + msg);
-    if (printStandard && _nEvents > 0) {
-      for (int i=0; i<_statE.length; i++) {
-        if (_statPrintFlag[i] == IndexType.PRINTSUM || _statPrintFlag[i] == IndexType.PRINTALL) {
-          msgList.add("  Average  " + _statName[i] + "  " + _statC[i]/_nEvents);
-        }
-      }
-    }
-    msgList.add("");
-    String[] msgArray = new String[msgList.size()];
-    msgArray = msgList.toArray(msgArray);
-    printLog("Tracking test: " + _testName + " cumulative statistics  (" + _nEvents + " events)", msgArray);
-  }
-  
-  /** 
-   * Print standard cumulative statistics. 
-   * The output destination can be set with <tt>set("LOG_FILE", destination)</tt>.
-   * See {@link #set(String, String)} for details.
-   */
-  protected void printCumulativeStatistics() {printCumulativeStatistics(true);}
-  
-// -- Miscellaneous utility methods :  -----------------------------------------
-  
-  public IHistogram1D efficiencyHistogram(String title, IHistogram1D good, IHistogram1D all) {
-      IHistogramFactory hFac = _aida.histogramFactory();
-      //Histogram1D eff = (Histogram1D) hFac.createHistogram1D(title, all.axis().bins(), all.axis().lowerEdge(), all.axis().upperEdge());
-      Histogram1D eff = (Histogram1D) hFac.divide(title, good, all);
-      int nBins = eff.axis().bins()+2;
-      double error[] = new double[nBins];
-      double height[] = new double[nBins];
-      for (int i = 0; i<nBins; i++) {
-          int bin;
-          if ( i == 0 ) {
-              bin = IAxis.UNDERFLOW_BIN;
-          } else if ( i == nBins+1 ) {
-              bin = IAxis.OVERFLOW_BIN;
-          } else {
-              bin = i - 1;
-          }
-          
-          double g = good.binHeight(bin);
-          double a = all.binHeight(bin);
-          height[bin] = eff.binHeight(bin);
-          if (a < .1) {
-              error[bin] = 0.;
-          } else {
-              double p = g/a;
-              error[bin] = Math.min(1.-p, Math.sqrt((p*(1.-p))/a));
-          }
-      }
-      eff.setContents(height, error, null, null, null);
-      return eff;
-  }
-  
-// -- Private fields :  --------------------------------------------------------
-  
-  protected String _testName = "";
-  
-  protected List<MCTrack> _mcTrackList;
-  protected List<Track> _recoTrackList;
-  protected ArrayList<RatedTrack> _ratedTrackList;
-  
-  protected String _mcTrackListName;
-  protected String _recoTrackListName;
-
-  protected double _mcTrackCut_Pt = 0.;
-  protected double _mcTrackCut_theta = 0.;
-  protected int _mcTrackCut_nLayers = 0;
-
-  protected int _nEvents;         // Number of events analyzed
-  protected double[] _statE;      // Array to hold per event statistics
-  protected double[] _statC;      // Array to hold cumulative statistics
-  protected String[] _statName;   // Array to hold names of statical variables
-  protected IndexType[]  _statAccumulateFlag;  // Array to hold flags indicating accumulation methods
-  protected IndexType[]  _statPrintFlag       ;  // Array to hold flags indicating accumulation printing options
-  
-  protected AIDA _aida;
-  protected ITree _tree;
-  
-  private boolean _runInProgress;
-  
-}

Commit in `lcsim-contrib/src/main/java/org/lcsim/contrib/onoprien/tester` on MAIN
`ExampleDriverTrackingTest.java`	-51	1.1.1.1 removed
`PiFinder.java`	-27	1.1.1.1 removed
`PiTest.java`	-92	1.1.1.1 removed
`RatedTrack.java`	-67	1.1.1.1 removed
`TrackingTest.java`	-121	1.1.1.1 removed
`TrackingTestBase.java`	-543	1.1.1.1 removed
`package.html`	-8	1.1.1.1 removed
	-909