import org.lcsim.contrib.onoprien.crux.algorithms.ValidationDriver; import org.lcsim.contrib.onoprien.crux.algorithms.Validator; import org.lcsim.contrib.onoprien.crux.algorithms.rosary.RosaryClusterer;

+package org.lcsim.contrib.onoprien.crux.recon; + +import java.util.*; +import java.util.logging.Level; + +import org.lcsim.event.CalorimeterHit; +import org.lcsim.event.EventHeader; +import org.lcsim.util.hitmap.HitMap; + +import org.lcsim.contrib.onoprien.util.job.Driver; + +import org.lcsim.contrib.onoprien.crux.infrastructure.*; + +/** + * Driver that creates new hit maps or lists containing only those hits from the + * input maps or lists that pass the filters. Can also be used to combine or split + * maps or lists, or to convert maps into lists and vice versa. + * + * See {@link #set set} method documentation for details. + * + * Note that as long as accepting or rejecting the hit only depends on the {@link CalorimeterHit} + * object itself, there is no need to assign hit map to {@link CruxHitFilter} before processing. In cases where + * the decision requires access to a hit map (for example, when the filter need to look up neighbouring + * hits), the map can be specified through a call to <tt>set("ID_TO_HIT_MAP", mapName)</tt>. + * If no map has been specified in this way, the input map being filtered will also be + * used by the filter to look up hits by their <tt>CellID</tt>. + * + * @author D. Onoprienko + * @version $Id: HitMapFilterDriver.java,v 1.1 2009/02/12 01:32:08 onoprien Exp $ + */ +public class HitMapFilterDriver extends Driver { + +// -- Constructors : ---------------------------------------------------------- + + public HitMapFilterDriver() { + } + +// -- Setters : --------------------------------------------------------------- + + /** + * Set any parameter. + * The following parameters can be set with this method: + * <dl> + * <dt>"INPUT"</dt> <dd>Names of input collections or maps of {@link CalorimeterHit} objects. + * Several input sources can be combined by calling this method several times, or + * by providing several names in a single call. If a collection with the given name + * is not present in the event record, it is assumed to be empty and ignored.</dd> + * <dt>"EXCLUDE"</dt> <dd>Names of {@link CalorimeterHit} collections or maps that need to be subtracted + * from the input collections. Hits present in these collections will not be included into + * the output collections whether or not they pass the filters. If a collection with the given name + * is not present in the event record, it is assumed to be empty and ignored. + * Several collections can be excluded by calling this method several times, + * or by providing several names in a single call.</dd> + * <dt>"OUTPUT"</dt> <dd>The first value is the name under which the output collection should + * be saved into the event record. If the collection with this name already exists, + * its contents will be added to the output collection without any filtering. + * The second (optional) value is the {@link CruxHitFilter} object - only hits that + * pass the filter will be added to this output collection. If this parameter + * is omitted, no filtering is applied. + * The third (optional) value is a <tt>String</tt> that defines the type of output + * collection (can be "CruxHitMap", "ArrayList", "Map", "HitMap"). If this parameter + * is omitted, "CruxHitMap" is assumed. + * Several output collections can be created, each with its own filter, by calling + * this method repeatedly.</dd> + * <dt>"ID_TO_HIT_MAP"</dt> <dd>Name of the map (of type <tt>Map<Long,CalorimeterHit></tt> + * or {@link CruxHitMap}) to be fetched from the event record and assigned to filters + * before event processing. Only filters that did not have a map previously assigned to + * them will be affected. + * Default: <tt>null</tt> (input map being filtered is to be used).</dd></dl> + * + * @param name Name of parameter to be set. Case is ignored. + * @param values List of values to be used for setting the parameter. + * @throws NoSuchParameterException Thrown if the supplied parameter name is unknown. + * @throws IllegalArgumentException Thrown if incorrect number of values, or a value + * of incorrect type is supplied. + */ + public void set(String name, Object... values) { + Object value = values.length == 0 ? null : values[0]; + try { + if (name.equalsIgnoreCase("INPUT")) { + for (Object ob : values) { + _inNames.add((String) ob); + } + _inNames.trimToSize(); + } else if (name.equalsIgnoreCase("EXCLUDE")) { + for (Object ob : values) { + _excludeNames.add((String) ob); + } + _excludeNames.trimToSize(); + } else if (name.equalsIgnoreCase("OUTPUT")) { + if (values.length > 3 || values.length < 1) throw new IllegalArgumentException(ERR_INV + name); + _outNames.add((String)(values[0])); _outNames.trimToSize(); + CruxHitFilter filter = CruxHitFilter.ALL; + String type = CHM; + for (int i=1; i<values.length; i++) { + Object v = values[i]; + if (v instanceof CruxHitFilter) { + filter = (CruxHitFilter)v; + } else if (v instanceof String) { + type = (String)v; + if (type.equalsIgnoreCase(CHM)) { + type = CHM; + } else if (type.equalsIgnoreCase(AL)) { + type = AL; + } else if (type.equalsIgnoreCase(HM)) { + type = HM; + } else if (type.equalsIgnoreCase(M)) { + type = M; + } else { + throw new IllegalArgumentException(ERR_IV + name); + } + } + } + _filters.add(filter); _filters.trimToSize(); + _types.add(type); _types.trimToSize(); + } else if (name.equalsIgnoreCase("ID_TO_HIT_MAP")) { + _defMapName = (String) value; + } else { + super.set(name, values); + } + } catch (ClassCastException x) { + throw new IllegalArgumentException(ERR_VIT, x); + } + } + +// -- Event processing : ------------------------------------------------------ + + /** Called by the framework to process an event. */ + public void process(EventHeader event) { + + super.process(event); + + // Create collection of collections of input hits : + + ArrayList<Collection<CalorimeterHit>> input = new ArrayList<Collection<CalorimeterHit>>(_inNames.size()); + for (String name : _inNames) { + try { + Object col = event.get(name); + if (col instanceof Collection) { + input.add((Collection<CalorimeterHit>)col); + } else if (col instanceof Map) { + input.add(((Map<Long,CalorimeterHit>)col).values()); + } else { + throw new IllegalArgumentException(); + } + } catch (IllegalArgumentException x) {} + } + + // Compile a set of hits to exclude + + Set<CalorimeterHit> excludeSet; + if (_excludeNames.isEmpty()) { + excludeSet = Collections.<CalorimeterHit>emptySet(); + } else { + excludeSet = new HashSet<CalorimeterHit>(200); + for (String name : _excludeNames) { + try { + Object o = event.get(name); + if (o instanceof Collection) { + excludeSet.addAll((Collection<CalorimeterHit>)o); + } else if (o instanceof Map) { + excludeSet.addAll(((Map<Long,CalorimeterHit>)o).values()); + } + } catch (IllegalArgumentException x) {break;} + } + } + + // Fetch default hit map and assign it to filters + + int nOut = _filters.size(); + boolean[] mapChanged = new boolean[nOut]; + if (_defMapName != null) { + Map<Long, CalorimeterHit> defMap; + Object map = event.get(_defMapName); + if (map instanceof Map) { + defMap = (Map<Long, CalorimeterHit>) map; + } else if (map instanceof CruxHitMap) { + defMap = ((CruxHitMap)map).asMap(); + } else { + throw new IllegalArgumentException(); + } + for (int i=0; i<nOut; i++) { + CruxHitFilter filter = _filters.get(i); + if (filter != CruxHitFilter.ALL && filter.getHitMap() == null) { + filter.setHitMap(defMap); + mapChanged[i] = true; + } else { + mapChanged[i] = false; + } + } + } + + // Create CruxHitMaps for output collections + + ArrayList<CruxHitMap> outMaps = new ArrayList<CruxHitMap>(nOut); + for (int i=0; i<nOut; i++) { + try { + Object o = event.get(_outNames.get(i)); + if (o instanceof CruxHitMap) { + outMaps.add((CruxHitMap)o); + } else if (o instanceof Collection) { + outMaps.add(new CruxHitMap((Collection<CalorimeterHit>)o)); + } else if (o instanceof Map) { + outMaps.add(new CruxHitMap(((Map<Long,CalorimeterHit>)o).values())); + } + } catch (IllegalArgumentException x) { + outMaps.add(new CruxHitMap()); + } + } + + // Do filtering + + for (Collection<CalorimeterHit> col : input) { + for (CalorimeterHit hit : col) { + if (! excludeSet.contains(hit)) { + for (int i=0; i<nOut; i++) { + if (_filters.get(i).pass(hit)) outMaps.get(i).add(hit); + } + } + } + } + + // Reset hit maps associated with filters if necessary + + if (_defMapName != null) { + for (int i=0; i<nOut; i++) { + if (mapChanged[i]) _filters.get(i).setHitMap(null); + } + } + + // Save output collections + + for (int i=0; i<nOut; i++) { + String type = _types.get(i); + if (type == CHM) { + event.put(_outNames.get(i), outMaps.get(i), CalorimeterHit.class, 0); + } else if (type == HM) { + event.put(_outNames.get(i), new HitMap(outMaps.get(i).asMap())); + } else if (type == AL) { + event.put(_outNames.get(i), new ArrayList(outMaps.get(i)), CalorimeterHit.class, 0); + } else if (type == M) { + event.put(_outNames.get(i), outMaps.get(i).asMap()); + } + log("Saved "+ _outNames.get(i) +" with "+ outMaps.size() +" hits as "+ type, Level.FINER); + } + + } + + +// -- Private parts : --------------------------------------------------------- + + static private final String CHM = "CruxHitMap"; + static private final String HM = "HitMap"; + static private final String AL = "ArrayList"; + static private final String M = "Map"; + + private ArrayList<String> _inNames = new ArrayList<String>(1); + + private ArrayList<String> _excludeNames = new ArrayList<String>(0); + + private ArrayList<CruxHitFilter> _filters = new ArrayList<CruxHitFilter>(1); + private ArrayList<String> _outNames = new ArrayList<String>(1); + private ArrayList<String> _types = new ArrayList<String>(1); + + private String _defMapName; + + private String _err1 = "Requested output type is inconsistent with identically named existing collection"; +}

+/** + * Miscellaneous drivers implementing various steps and functions in the event reconstruction chain. + * + * These drivers are intended to be building blocks for assembling the master driver for a + * particular reconstruction or analysis job. Most drivers are configurable through their + * <tt>set(String parametername, Object... parameterValues)</tt> methods. Assembly and + * configuration can be done with an XML steering file. + * + * @author D. Onoprienko + */ +package org.lcsim.contrib.onoprien.crux.recon; +

lcsim-contrib/src/main/java/org/lcsim/contrib/onoprien/crux/auxdrivers

HitMapFilterDriver.java removed after 1.1.1.1

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

-package org.lcsim.contrib.onoprien.crux.auxdrivers;
-
-import java.util.*;
-import java.util.logging.Level;
-
-import org.lcsim.event.CalorimeterHit;
-import org.lcsim.event.EventHeader;
-import org.lcsim.util.hitmap.HitMap;
-
-import org.lcsim.contrib.onoprien.util.job.Driver;
-
-import org.lcsim.contrib.onoprien.crux.infrastructure.*;
-
-/**
- * Driver that creates new hit maps or lists containing only those hits from the 
- * input maps or lists that pass the filters. Can also be used to combine or split
- * maps or lists, or to convert maps into lists and vice versa.
- * <p>
- * See {@link #set set} method documentation for details.
- * <p>
- * Note that as long as accepting or rejecting the hit only depends on the {@link CalorimeterHit}
- * object itself, there is no need to assign hit map to {@link CruxHitFilter} before processing. In cases where
- * the decision requires access to a hit map (for example, when the filter need to look up neighbouring
- * hits), the map can be specified through a call to <tt>set("ID_TO_HIT_MAP", mapName)</tt>.
- * If no map has been specified in this way, the input map being filtered will also be
- * used by the filter to look up hits by their <tt>CellID</tt>.
- *
- * @author D. Onoprienko
- * @version $Id: HitMapFilterDriver.java,v 1.1.1.1 2008/12/10 22:03:06 jeremy Exp $
- */
-public class HitMapFilterDriver extends Driver {
-  
-// -- Constructors :  ----------------------------------------------------------
-  
-  public HitMapFilterDriver() {
-  }
-  
-// -- Setters :  ---------------------------------------------------------------
-
-  /**
-   * Set any parameter. 
-   * The following parameters can be set with this method:
-   * <p><dl>
-   * <dt>"INPUT"</dt> <dd>Names of input collections or maps of {@link CalorimeterHit} objects.<br>
-   *         Several input sources can be combined by calling this method several times, or
-   *         by providing several names in a single call. If a collection with the given name 
-   *         is not present in the event record, it is assumed to be empty and ignored.</dd>
-   * <dt>"EXCLUDE"</dt> <dd>Names of {@link CalorimeterHit} collections or maps that need to be subtracted
-   *         from the input collections. Hits present in these collections will not be included into
-   *         the output collections whether or not they pass the filters. If a collection with the given name 
-   *         is not present in the event record, it is assumed to be empty and ignored.
-   *         Several collections can be excluded by calling this method several times,
-   *         or by providing several names in a single call.</dd>
-   * <dt>"OUTPUT"</dt> <dd>The first value is the name under which the output collection should 
-   *         be saved into the event record. If the collection with this name already exists,
-   *         its contents will be added to the output collection without any filtering.<br>
-   *         The second (optional) value is the {@link CruxHitFilter} object - only hits that 
-   *         pass the filter will be added to this output collection. If this parameter
-   *         is omitted, no filtering is applied.<br>
-   *         The third (optional) value is a <tt>String</tt> that defines the type of output
-   *         collection (can be "CruxHitMap", "ArrayList", "Map", "HitMap"). If this parameter
-   *         is omitted, "CruxHitMap" is assumed.<br>
-   *         Several output collections can be created, each with its own filter, by calling
-   *         this method repeatedly.</dd>
-   * <dt>"ID_TO_HIT_MAP"</dt> <dd>Name of the map (of type <tt>Map&lt;Long,CalorimeterHit&gt;</tt>
-   *         or {@link CruxHitMap}) to be fetched from the event record and assigned to filters 
-   *         before event processing. Only filters that did not have a map previously assigned to
-   *         them will be affected.
-   *         <br>Default: <tt>null</tt> (input map being filtered is to be used).</dd></dl>
-   * 
-   * @param name   Name of parameter to be set. Case is ignored.
-   * @param values  List of values to be used for setting the parameter.
-   * @throws NoSuchParameterException Thrown if the supplied parameter name is unknown.
-   * @throws IllegalArgumentException Thrown if incorrect number of values, or a value
-   *                                  of incorrect type is supplied.
-   */
-  public void set(String name, Object... values) {
-    Object value = values.length == 0 ? null : values[0];
-    try {
-      if (name.equalsIgnoreCase("INPUT")) {
-        for (Object ob : values) {
-          _inNames.add((String) ob);
-        }
-        _inNames.trimToSize();
-      } else if (name.equalsIgnoreCase("EXCLUDE")) {
-        for (Object ob : values) {
-          _excludeNames.add((String) ob);
-        }
-        _excludeNames.trimToSize();
-      } else if (name.equalsIgnoreCase("OUTPUT")) {
-        if (values.length > 3 || values.length < 1) throw new IllegalArgumentException(ERR_INV + name);
-        _outNames.add((String)(values[0])); _outNames.trimToSize();
-        CruxHitFilter filter = CruxHitFilter.ALL;
-        String type = CHM;
-        for (int i=1; i<values.length; i++) {
-          Object v = values[i];
-          if (v instanceof CruxHitFilter) {
-            filter = (CruxHitFilter)v;
-          } else if (v instanceof String) {
-            type = (String)v;
-            if (type.equalsIgnoreCase(CHM)) {
-              type = CHM;
-            } else if (type.equalsIgnoreCase(AL)) {
-              type = AL;
-            } else if (type.equalsIgnoreCase(HM)) {
-              type = HM;
-            } else if (type.equalsIgnoreCase(M)) {
-              type = M;
-            } else {
-              throw new IllegalArgumentException(ERR_IV + name);
-            }
-          }
-        }
-        _filters.add(filter); _filters.trimToSize();
-        _types.add(type); _types.trimToSize();
-      } else if (name.equalsIgnoreCase("ID_TO_HIT_MAP")) {
-        _defMapName = (String) value;
-      } else {
-        super.set(name, values);
-      }
-    } catch (ClassCastException x) {
-      throw new IllegalArgumentException(ERR_VIT, x);
-    }
-  }
-  
-// -- Event processing :  ------------------------------------------------------
-  
-  /** Called by the framework to process an event. */
-  public void process(EventHeader event) {
-    
-    super.process(event);
-    
-    // Create collection of collections of input hits :
-    
-    ArrayList<Collection<CalorimeterHit>> input = new ArrayList<Collection<CalorimeterHit>>(_inNames.size());
-    for (String name : _inNames) {
-      try {
-        Object col = event.get(name);
-        if (col instanceof Collection) {
-          input.add((Collection<CalorimeterHit>)col);
-        } else if (col instanceof Map) {
-          input.add(((Map<Long,CalorimeterHit>)col).values());
-        } else {
-          throw new IllegalArgumentException();
-        }
-      } catch (IllegalArgumentException x) {}
-    }
-    
-    // Compile a set of hits to exclude 
-    
-    Set<CalorimeterHit> excludeSet;
-    if (_excludeNames.isEmpty()) {
-      excludeSet = Collections.<CalorimeterHit>emptySet();
-    } else {
-      excludeSet = new HashSet<CalorimeterHit>(200);
-      for (String name : _excludeNames) {
-        try {
-          Object o = event.get(name);
-          if (o instanceof Collection) {
-            excludeSet.addAll((Collection<CalorimeterHit>)o);
-          } else if (o instanceof Map) {
-            excludeSet.addAll(((Map<Long,CalorimeterHit>)o).values());
-          }
-        } catch (IllegalArgumentException x) {break;}
-      }
-    }
-
-    // Fetch default hit map and assign it to filters
-    
-    int nOut = _filters.size();
-    boolean[] mapChanged = new boolean[nOut];
-    if (_defMapName != null) {
-      Map<Long, CalorimeterHit> defMap;
-      Object map = event.get(_defMapName);
-      if (map instanceof Map) {
-        defMap = (Map<Long, CalorimeterHit>) map;
-      } else if (map instanceof CruxHitMap) {
-        defMap = ((CruxHitMap)map).asMap();
-      } else {
-        throw new IllegalArgumentException();
-      }
-      for (int i=0; i<nOut; i++) {
-        CruxHitFilter filter = _filters.get(i);
-        if (filter != CruxHitFilter.ALL && filter.getHitMap() == null) {
-          filter.setHitMap(defMap);
-          mapChanged[i] = true;
-        } else {
-          mapChanged[i] = false;
-        }
-      }
-    }
-
-    // Create CruxHitMaps for output collections
-    
-    ArrayList<CruxHitMap> outMaps = new ArrayList<CruxHitMap>(nOut);
-    for (int i=0; i<nOut; i++) {
-      try {
-        Object o = event.get(_outNames.get(i));
-        if (o instanceof CruxHitMap) {
-          outMaps.add((CruxHitMap)o);
-        } else if (o instanceof Collection) {
-          outMaps.add(new CruxHitMap((Collection<CalorimeterHit>)o));
-        } else if (o instanceof Map) {
-          outMaps.add(new CruxHitMap(((Map<Long,CalorimeterHit>)o).values()));
-        }
-      } catch (IllegalArgumentException x) {
-        outMaps.add(new CruxHitMap());
-      }
-    }
-    
-    // Do filtering
-    
-    for (Collection<CalorimeterHit> col : input) {
-      for (CalorimeterHit hit : col) {
-        if (! excludeSet.contains(hit)) {
-          for (int i=0; i<nOut; i++) {
-            if (_filters.get(i).pass(hit)) outMaps.get(i).add(hit);
-          }
-        }
-      }
-    }
-    
-    // Reset hit maps associated with filters if necessary
-    
-    if (_defMapName != null) {
-      for (int i=0; i<nOut; i++) {
-        if (mapChanged[i]) _filters.get(i).setHitMap(null);
-      }
-    }
-    
-    // Save output collections
-    
-    for (int i=0; i<nOut; i++) {
-      String type = _types.get(i);
-      if (type == CHM) {
-        event.put(_outNames.get(i), outMaps.get(i), CalorimeterHit.class, 0);
-      } else if (type == HM) {
-        event.put(_outNames.get(i), new HitMap(outMaps.get(i).asMap()));
-      } else if (type == AL) {
-        event.put(_outNames.get(i), new ArrayList(outMaps.get(i)), CalorimeterHit.class, 0);
-      } else if (type == M) {
-        event.put(_outNames.get(i), outMaps.get(i).asMap());
-      }
-      log("Saved "+ _outNames.get(i) +" with "+ outMaps.size() +" hits as "+ type, Level.FINER);
-    }
-
-  }
-
-  
-// -- Private parts :  ---------------------------------------------------------
-  
-  static private final String CHM = "CruxHitMap";
-  static private final String HM = "HitMap";
-  static private final String AL = "ArrayList";
-  static private final String M = "Map";
-  
-  private ArrayList<String> _inNames = new ArrayList<String>(1);
-  
-  private ArrayList<String> _excludeNames = new ArrayList<String>(0);
-  
-  private ArrayList<CruxHitFilter> _filters = new ArrayList<CruxHitFilter>(1);
-  private ArrayList<String> _outNames = new ArrayList<String>(1);
-  private ArrayList<String> _types = new ArrayList<String>(1);
-  
-  private String _defMapName;
-  
-  private String _err1 = "Requested output type is inconsistent with identically named existing collection";
-}

Commit in `lcsim-contrib/src/main/java/org/lcsim/contrib/onoprien/crux` on MAIN
`algorithms/ClusteringDriver.java`	+1	-2	1.1.1.1 -> 1.2
`tests/TestDriverClustering.java`	+2	-2	1.1.1.1 -> 1.2
`/TestDriverRosary.java`	+2	-2	1.2 -> 1.3
`recon/CalorimeterDriver.java`	+100		added 1.1
`/HitMapFilterDriver.java`	+268		added 1.1
`/package-info.java`	+12		added 1.1
`auxdrivers/HitMapFilterDriver.java`		-268	1.1.1.1 removed
`/package-info.java`		-4	1.1.1.1 removed
	+385	-278