GeomConverter/sandbox/calorimeter

BaseCalorimeterCell.java added at 1.1

diff -N BaseCalorimeterCell.java
--- /dev/null	1 Jan 1970 00:00:00 -0000
+++ BaseCalorimeterCell.java	28 Feb 2007 19:50:48 -0000	1.1
@@ -0,0 +1,533 @@

+package org.lcsim.identifier;
+
+import static java.lang.Math.PI;
+import static java.lang.Math.atan;
+import static java.lang.Math.sqrt;
+import static org.lcsim.geometry.subdetector.CalorimeterType.ECAL;
+import static org.lcsim.geometry.subdetector.CalorimeterType.FCAL;
+import static org.lcsim.geometry.subdetector.CalorimeterType.HCAL;
+import static org.lcsim.geometry.subdetector.CalorimeterType.LUMI;
+import static org.lcsim.geometry.subdetector.CalorimeterType.MUON;
+
+import java.util.List;
+
+import org.lcsim.event.MCParticle;
+import org.lcsim.event.EventHeader.LCMetaData;
+import org.lcsim.geometry.Calorimeter;
+import org.lcsim.geometry.IDDecoder;
+import org.lcsim.geometry.Subdetector;
+import org.lcsim.geometry.segmentation.GridXYZ;
+import org.lcsim.geometry.segmentation.ProjectiveCylinder;
+import org.lcsim.geometry.subdetector.CalorimeterType;
+import org.lcsim.spacegeom.CartesianPoint;
+import org.lcsim.spacegeom.SpacePoint;
+import org.lcsim.util.event.SamplingFractionManager;
+import org.lcsim.util.event.SubdetectorLocator;
+
+public class BaseCalorimeterCell implements CalorimeterCell 
+{
+    // TODO implement
+    // TODO first requires DetectorElement interface
+    //public DetectorElement detectorElement() 
+    //{
+    //  return null;
+    //}
+    
+    //public int hashCode() 
+    //{
+    //  return super.hashCode();
+    //}
+    
+	IDDecoder decoder;
+    LCMetaData data;
+	CalorimeterType calType;
+    long id;
+    double energy;
+    double time;
+    double gain;
+    double quality;
+
+    // Other possible parameters ...
+    //
+    // deta
+    // dphi
+    // dx
+    // dy
+    // dz
+    // eta
+    // phi
+    // r
+    // x
+    // y
+    // z
+    // SpacePoint (covers x,y,z,r,theta,phi)
+    BaseCalorimeterCell(IDDecoder decoder,
+                        LCMetaData data,
+                        long id,
+                        double energy,
+                        double time,
+                        double gain,
+                        double quality)
+    {
+        this.decoder = decoder;
+        this.data = data;
+        this.id = id;
+        this.energy = energy;
+        this.time = time;
+        this.gain = gain;
+        this.quality = quality;
+        this.calType = ((Calorimeter)decoder.getSubdetector()).getCalorimeterType();
+    }
+    
+    void setCartesian(double x, double y, double z)
+    {}
+    
+    void setSpherical(double eta, double phi, double r)
+    {}
+    	
+	public long cellId()
+	{
+        return id;
+	}
+    
+    public double quality()
+    {
+        return this.quality;
+    }
+    
+    public double gain()
+    {
+        return this.gain;
+    }
+    
+    public double e()
+    {
+        return this.energy;
+    }
+    
+    public double time() 
+    {
+        return this.time;
+    }
+	
+	public int compareTo(CalorimeterCell cell) 
+	{
+        if (cell.cellId() == cellId()) return 0; else return -1;
+	}
+	
+	public double distanceToCenter(SpacePoint point) 
+	{        
+        double x = point.x() - x();
+        double y = point.y() - y();
+        double z = point.z() - z();
+		return sqrt(x*x + y*y + z*z);       
+	}
+	
+    // Uses cylindrical approximation to see if within theta, phi, r
+	public boolean isInside(SpacePoint point) 
+	{		
+		double x = point.x();
+		double y = point.y();
+		double z = point.z();
+		double r = sqrt(x * x + y * y);
+		double theta = atan(r / z);				       
+        if (theta < 0) theta += PI;
+        double phi = point.phi();
+        return (phi > phiMin() && phi < phiMax()) && 
+               (theta > etaMin() && theta < etaMax()) && 
+               (r > rMin() && r < rMax());
+	}
+
+	public boolean isNear(SpacePoint point, double tolerance)
+	{
+		return distanceToCenter(point) <= tolerance;
+	}
+   
+    // Checks if point is within 10 cm of the cell center
+    static private double distance_tolerance = 100.0;
+    public boolean isNear(SpacePoint point)
+    {
+        return isNear(point, distance_tolerance);
+    }
+
+	// FIXME: Only works for decoders with explicit absorber field (which isn't currently set)
+	public boolean isAbsorber() 
+	{
+		return decoder.getValue("absorber") != 0;
+	}
+	
+	public IDDecoder decoder() 
+	{
+		return decoder;
+	}
+
+	public boolean isBarrel() 
+	{
+		return decoder.getBarrelEndcapFlag().isBarrel();
+	}
+
+	public boolean isEndcap() 
+	{
+		return decoder.getBarrelEndcapFlag().isEndcap();
+	}
+	
+	public boolean isPositiveEndcap() {
+		return decoder.getBarrelEndcapFlag().isEndcapNorth();
+	}
+
+	public boolean isNegativeEndcap() {
+        return decoder.getBarrelEndcapFlag().isEndcapSouth();		
+	}
+
+	public boolean isECAL() 
+	{
+		return calType == ECAL;		
+	}
+	
+	public boolean isMUON() 
+	{
+		return calType == MUON;
+	}
+	
+	public boolean isFCAL() 
+	{
+		return calType == FCAL;
+	}
+
+	public boolean isHCAL() 
+	{
+		return calType == HCAL;
+	}
+	
+	public boolean isLUMI()
+	{
+		return calType == LUMI;
+	}
+
+	public boolean hasHit() 
+	{
+		return e() != 0;
+	}
+	
+	// FIXME: Only works for decoders with explicit phi field.
+    //        Non-projective segmentations should still be able
+    //        to calculate this based on phi from xyz.
+	public int iphi() 
+	{
+		return decoder.getValue("phi");
+	}
+
+	// FIXME: Only works for decoders with explicit theta field
+    //        Non-projective segmentations should still be able
+    //        to calculate this based on theta from xyz.
+	public int ieta() 
+	{
+		return decoder.getValue("eta");
+	}
+
+	// FIXME: Only works for decoders with explicit x field    
+	public int ix() 
+	{
+		return decoder.getValue("x");
+	}
+
+	// FIXME: Only works for decoders with explicit y field
+	public int iy() 
+	{
+		return decoder.getValue("y");
+	}
+
+	// FIXME: Only works for decoders with explicit z field
+	public int iz() 
+	{
+		return decoder.getValue("z");
+	}
+
+	// FIXME: Only works for decoders with explicit layer field
+	public int layer() 
+	{
+		return decoder.getValue("layer");
+	}
+
+	// FIXME: Only works for decoders with explicit module field
+	public int module() 
+	{
+		return decoder.getValue("module");
+	}
+	
+	// FIXME: Only works for decoders with explicit row field
+	public int row() 
+	{
+		return decoder.getValue("row");
+	}
+
+	// FIXME: Only works for decoders with explicit section field
+	public int section() 
+	{
+		return decoder.getValue("section");
+	}
+
+	// FIXME: Only works for decoders with explicit stave field
+	public int stave() 
+	{
+		return decoder.getValue("stave");
+	}
+    
+    // FIXME: Only works for decoders with explicit column field
+    public int column() 
+    {
+        return decoder.getValue("column");
+    }
+
+	public double phi() 
+	{
+		return decoder.getPhi();
+	}
+
+	public double phiMax() 
+	{
+		return phi() + dphi() / 2;
+	}
+
+	public double phiMin() 
+	{
+		return phi() - dphi() / 2;
+	}
+
+	// FIXME: Only works for ProjectiveCylinder segmentation
+	public double dphi() 
+	{
+		ProjectiveCylinder prjCyl = (ProjectiveCylinder)decoder;
+		return (2 * PI) / prjCyl.getPhiBins(); 
+	}
+
+    public double p()
+    {
+        return sqrt(x() * x() + y() * y() + z() * z());
+    }
+
+    public double pt()
+    {
+        return sqrt(x() * x() + y() * y());
+    }
+    
+    public double ipt()
+    {
+        return 1.0 / pt();
+    }
+    
+	public SpacePoint position() 
+	{
+        double[] parr = decoder.getPosition();
+        SpacePoint p = new CartesianPoint(parr[0],parr[1],parr[2]);
+        return p;
+	}
+
+	public double r() 
+	{
+        return p();
+	}
+
+	public double rMax() 
+	{
+        // FIXME: Just an approximation and will be wrong for non-cylindrical
+        return pt() + width() / 2;
+	}
+
+	public double rMin() 
+	{
+	    // FIXME: Just an approximation and will be wrong for non-cylindrical
+        return pt() - width() / 2;
+	}
+
+	public double width() 
+	{
+		return decoder.getSubdetector().getLayering().getLayer(layer()).getSensorThickness();
+	}
+
+	public Subdetector subdetector() 
+	{
+		return decoder.getSubdetector();
+	}
+
+	public int system() 
+	{
+		return decoder.getSystemID();
+	}
+ 
+	public double eta() 
+	{
+		return decoder.getTheta();
+	}
+ 
+	public double etaMax() 
+	{
+		return eta() + deta() / 2; 
+	}
+ 
+	public double etaMin() 
+	{
+		return eta() - deta() / 2;
+	}
+    
+	public double deta() 
+	{
+	    // FIXME: Only works for ProjectiveCylinder
+		ProjectiveCylinder seg = (ProjectiveCylinder)decoder;
+		return (2 * PI) / seg.getThetaBins();
+	}
+
+	public int tower() 
+	{
+		return decoder.getValue("tower");
+	}
+
+	public double x()
+	{
+		return decoder.getX();
+	}
+
+	public double y() 
+	{
+		return decoder.getY();
+	}
+
+	public double z() 
+	{
+		return decoder.getZ();
+	}
+	
+	// FIXME: Only works for GridXYZ
+	public double dx()
+	{
+		return ((GridXYZ)decoder).getGridSizeX();
+	}
+	
+	// FIXME: Only works for GridXYZ.  
+	public double dy()
+	{
+		GridXYZ seg = (GridXYZ)decoder;
+		return seg.getGridSizeY();
+	}
+	
+	// FIXME: Only works for GridXYZ
+	public double dz()
+	{
+		GridXYZ seg = (GridXYZ)decoder;
+		return seg.getGridSizeZ();
+	}
+	
+	public double phiCircumference()
+	{
+		return 2 * PI * pt();
+	}
+	
+	public double thetaCircumference()
+	{
+		return 2 * PI * z();
+	}
+	
+	public double phiFraction()
+	{
+		return dphi() / (2 * PI);
+	}
+	
+	public double etaFraction()
+	{
+		return deta() / (2 * PI);
+	}
+	
+	public double phiArc()
+	{
+		return phiCircumference() * phiFraction();
+	}
+	
+	public double etaArc()
+	{
+		return thetaCircumference() * etaFraction();
+	}
+	
+	public double samplingFraction()
+	{
+		//return SamplingFractionManager.defaultInstance().getSamplingFraction(SubdetectorLocator.locateSubdetector(data,cellId()));
+        return 1.0;
+	}
+
+    // http://alxr.usatlas.bnl.gov/lxr/source/atlas/Calorimeter/CaloEvent/src/CaloCell.cxx#039
+    public double cosTheta()
+    {
+        double aux = sqrt(1. - sinTheta() * sinTheta());
+        if (eta() < 0) aux = -aux;
+        return aux;
+    }
+
+    public double cotTheta()
+    {
+        double aux = sqrt(1. - sinTheta() * sinTheta());
+        if (eta() < 0) aux = -aux;
+        return aux / sinTheta(); 
+    }
+
+    // http://www.math.com/tables/trig/identities.htm
+    public double sinTheta()
+    {
+        double sinTh = y() / p();
+        if ( p() < 0.001)
+            sinTh = 0;
+        return sinTh;
+    }
+    
+    public MCParticle getMCParticle(int index)
+    {
+        // TODO Auto-generated method stub
+        return null;
+    }
+
+    public int getMCParticleCount()
+    {
+        // TODO Auto-generated method stub
+        return 0;
+    }
+
+    public int getPDG(int index)
+    {
+        // TODO Auto-generated method stub
+        return 0;
+    }
+
+    public List<SpacePoint> getCellPointData()
+    {
+        // TODO Auto-generated method stub
+        return null;
+    }
+
+    // should get this from a compact parameter on the detector
+    public boolean isAnalog()
+    {
+        // TODO Auto-generated method stub
+        return false;
+    }
+
+    // should get this from a compact parameter on the detector
+    public boolean isDigital()
+    {
+        // TODO Auto-generated method stub
+        return false;
+    }
+
+    public CalorimeterCellNeighborhood neighbors(CalorimeterNeighborOptions opts)
+    {
+        // TODO Auto-generated method stub
+        return null;
+    }
+    
+    public boolean inCalorimeter(Calorimeter cal)
+    {
+        return cal.getSystemID() == decoder.getSystemID();
+    }
+
+    public int density()
+    {
+        return 0;
+    }
+}

GeomConverter/sandbox/calorimeter

CalorimeterCell.java added at 1.1

diff -N CalorimeterCell.java
--- /dev/null	1 Jan 1970 00:00:00 -0000
+++ CalorimeterCell.java	28 Feb 2007 19:50:48 -0000	1.1
@@ -0,0 +1,621 @@

+package org.lcsim.identifier;
+
+import java.util.List;
+
+import org.lcsim.event.MCParticle;
+import org.lcsim.geometry.Calorimeter;
+import org.lcsim.geometry.IDDecoder;
+import org.lcsim.geometry.Subdetector;
+import org.lcsim.spacegeom.SpacePoint;
+
+/**
+ * 
+ * An interface to Calorimeter cell detector description and hit data.
+ * 
+ * CalorimeterCell uses, wraps, refers to, or replaces the following classes.
+ *
+ * @see org.lcsim.geometry.subdetector.BarrelEndcapFlag
+ * @see org.lcsim.geometry.subdetector.Calorimeter
+ * @see org.lcsim.geometry.subdetector.CalorimeterType
+ * @see org.lcsim.event.CalorimeterHit
+ * @see org.lcsim.event.RawCalorimeterHit
+ * @see org.lcsim.event.SimCalorimeterHit
+ * @see org.lcsim.geometry.Subdetector
+ * @see org.lcsim.geometry.IDDecoder
+ * @see org.lcsim.geometry.util.BaseIDDecoder
+ * @see org.lcsim.geometry.CalorimeterIDDecoder
+ * @see org.lcsim.geometry.segmentation
+ * @see org.lcsim.geometry.subdetector.AbstractPolyhedraCalorimeter
+ * @see org.lcsim.geometry.subdetector.EcalBarrel
+ * @see org.lcsim.geometry.subdetector.AbstractTestBeam
+ * @see org.lcsim.geometry.subdetector.CylindricalBarrelCalorimeter
+ * @see org.lcsim.geometry.subdetector.CylindricalEndcapCalorimeter
+ * @see org.lcsim.geometry.subdetector.PolyhedraBarrelCalorimeter
+ * @see org.lcsim.geometry.subdetector.PolyhedraEndcapCalorimeter
+ * @see org.lcsim.geometry.TestBeamCalorimeter
+ * 
+ * For convenience, CalorimeterCell cell combines functionality 
+ * from these classes into a single "flattened" API so that users can avoid 
+ * lots of subcasting and/or method chaining in order to access the information
+ * required for their analysis.  It also replaces calls using "magic" field
+ * strings, primarily from IDDecoder, with proper interface methods.
+ *   
+ * Measurements, such as the position, are within a global coordinate 
+ * system based at (0,0,0), unless otherwise noted.  Indices, however,
+ * may refer to a local or global system.  For instance, ix would probably
+ * translate to local coordinates in a readout plate, while iphi is most
+ * likely a global phi index.
+ * 
+ * @author Jeremy McCormick
+ * 
+ * FIXME: Many of the geometrical methods in CalorimeterCell should be moved to a DD object.
+ *  
+ */
+public interface CalorimeterCell 
+//extends IDetectorElement 
+{        
+	/** 
+	 * 64-bit identifier of this cell
+     * 
+     * This is used as a hash by our current system, but it isn't one, really.
+     * The interface should probably include a hashCode method, too.
+	 * 
+	 * @see org.lcsim.event.CalorimeterHit.getCellId() 
+	 */
+	long cellId();	
+    
+	
+	/**
+	 * Hash code uniquely identifying the CalorimeterCell object
+	 * 
+	 * Can be based on ATLAS's IdentifierHash
+	 * 
+	 * (Java provides built-in hashing, but this needs support for hash back to id.)
+	 * 
+	 */
+	int hashCode();
+	
+	/**	
+     * This method returns 0 if the cells have matching ids.  Otherwise, it
+     * returns -1.
+	 */
+	int compareTo(CalorimeterCell cell);
+    
+	
+	/** 
+	 * Energy deposition in the cell (GeV)
+	 * 
+	 * @see CalorimeterHit.getRawEnergy()
+	 */
+	double e();
+			
+	/** 
+	 * Shortcut for energy != 0 
+	 */
+	boolean hasHit();
+	
+	/**
+	 * Time (nanoseconds)
+	 * 
+	 * @see org.lcsim.event.CalorimeterHit.getTime()
+	 *  
+	 */
+	double time();
+    
+    /** 
+     * Quality of signal (time only?) 
+     */
+    double quality();
+
+    /** 
+     * Gain (in ADC counts?) 
+     */
+    double gain();
+			
+	/** 
+	 * Center position (mm)
+	 *
+	 * @see org.lcsim.event.CalorimeterHit.getPosition()
+	 * @see org.lcsim.geometry.IDDecoder.getPosition()
+	 */
+	SpacePoint position();
+	
+	/** 
+	 * X at cell center (mm)
+	 *
+	 * @see org.lcsim.geometry.IDDecoder.getX()
+	 * 
+	 */
+	double x();
+	
+	/** 
+	 * Y at cell center (mm)
+	 *
+	 * @see org.lcsim.geometry.IDDecoder.getY()
+	 * 
+	 */
+	double y();
+	
+	/** 
+	 * Z at cell center (mm)
+	 *
+	 * @see org.lcsim.geometry.IDDecoder.getZ()
+	 * 
+	 */
+	double z();
+	
+    /** 
+     * Theta at cell center (radians) 
+     *
+     * @see IDDecoder.getTheta()
+     * 
+     */
+    double eta();
+    
+    /** 
+     * Phi at cell center (radians)
+     *
+     * @see IDDecoder.getPhi()
+     *
+     */
+    double phi();
+    
+	/** 
+	 * Size of the cell in x dim
+	 */
+	public double dx();
+		
+	/** 
+	 * Size of the cell in y dim
+	 */
+	public double dy();
+	
+	/** 
+	 * Size of the cell in z dim
+	 */
+	public double dz();
+    
+    /** 
+     * Angle subtended in theta (radians) 
+     */
+    double deta();
+    
+    /** 
+     * Angle subtended in theta (radians) 
+     */
+    double dphi();
+    
+    /** 
+     * Distance to the cell from origin 
+     */
+    double p(); 
+    
+    /** 
+     * Transverse distance (XY) to the cell from origin
+     */
+    double pt();
+        
+    /** 
+     * Inverse of pt
+     * 
+     * Norman: "Related to curvature. High pT gives low curvature.
+     *          the errors are gaussian distributed if you plot it in terms of 1/pT." 
+     */
+    double ipt(); 
+        
+    /** 
+      * Corner points of the cell's solid, in a LOCAL coordinate frame 
+      * (as if cell was at 0,0,0).
+      * 
+      * FIXME: Put into DE 
+      *       
+      */
+    public List<SpacePoint> getCellPointData();
+    
+	
+	/** 
+	 * Is the given point within tolerance of the cell center? (mm) 
+	 */
+	boolean isNear(SpacePoint point, double tolerance);
+    
+    /**
+     * Version of isNear with a default tolerance of 10 cm.
+     */    
+    boolean isNear(SpacePoint point);
+    	
+	/** 
+	 * Distance to cell center from point (mm)
+	 */
+	double distanceToCenter(SpacePoint point);
+	
+	/** 
+	 * Is the given point inside this cell? (mm)
+	 */
+	boolean isInside(SpacePoint point);
+	    
+    /** 
+     * sin of eta 
+     */
+    double sinTheta();
+    
+    /** 
+     * cosine of eta 
+     */
+    double cosTheta();
+    
+    /** 
+     * cotangent of eta 
+     */
+    double cotTheta();  
+	
+	/** 
+	 * Minimum theta of the cell (radians) 
+	 */
+	double etaMin();	
+	
+	/** 
+	 * Maximum theta of the cell (radians)
+	 */
+	double etaMax();
+	
+	/** 
+	 * Distance along circumference in phi (cylindrical radius) covered by this cell (mm)
+	 */
+	double etaArc();
+	
+	/** 
+	 * Fraction of theta (360 degrees) covered by this cell 
+	 */
+	double etaFraction();
+	
+	/** 
+	 * Minimum phi measurement of the cell (radians)
+	 */
+	double phiMin();
+	
+	/** 
+	 * Maximum phi measurement of the cell (radians)
+	 */
+	double phiMax();
+		
+	/** 
+	 * Distance along circumference covered by this cell in phi 
+	 */
+	double phiArc();
+	
+	/** 
+	 * Fraction of full phi (360) covered by this cell 
+	 */
+	double phiFraction();
+	    
+	/** 
+	 * Radius to the cell midpoint (mm)
+	 */
+	double r();        
+
+    /**
+     * Minimum radius measurement (mm)
+     */
+    double rMin();
+    
+    /**
+     * Maximum radius measurement (mm)
+     */
+    double rMax();
+	
+	/** 
+	 * Width of the cell along the layering axis (mm)
+	 */
+	double width();
+	
+	/** 
+	 * Circumference of the circle defined by r and phi (mm)
+	 */
+	double phiCircumference();
+	
+	/** 
+	 * Circumference of the circle defined by r and theta (mm)
+	 */
+	double thetaCircumference();
+		
+	/** 
+	 * X bin value 
+	 *
+	 * @see org.lcsim.geometry.IDDecoder.getValue()
+	 * @see org.lcsim.geometry.segmentation.GridXYZ.getXBin()
+	 * 
+	 */
+	int ix();
+	
+	/** 
+	 * Y bin value
+	 * 
+	 * @see org.lcsim.geometry.IDDecoder.getValue()
+	 * @see org.lcsim.geometry.segmentation.GridXYZ.getYBin()	 
+	 * 
+	 */
+	int iy();
+	
+	/** 
+	 * Z bin value
+	 *  
+     * @see org.lcsim.geometry.IDDecoder.getValue()
+     * @see org.lcsim.geometry.segmentation.GridXYZ.getZBin()    
+	 * 
+	 */
+	int iz();
+	
+	/** 
+	 * Theta bin value
+	 * 
+	 * @see org.lcsim.geometry.IDDecoder.getValue()
+	 *  
+	 */
+	int ieta();
+	
+	/** 
+	 * Phi bin value
+     * 
+     * @see org.lcsim.geometry.IDDecoder.getValue()
+	 * 
+	 */
+	int iphi();
+	
+	/** 
+	 * System number uniquely identifying the cell's Subdetector
+	 * 
+	 * @see org.lcsim.geometry.IDDecoder.getSystemID()
+	 * 
+	 */
+	int system();
+	
+	/** 
+	 * Section number of the calorimeter along the z axis 
+	 * 
+	 * @see org.lcsim.geometry.subdetector.AbstractPolyhedraCalorimeter
+     * @see org.lcsim.geometry.subdetector.EcalBarrel
+	 * 
+     * Also see Mokka's HCAL models for an example of a calorimeter with sections along z.
+     * 
+	 * section applies directly only to those calorimeters that have some subdivision of their
+     * envelope in the z direction, though basic cylindrical types could "fake it" based on 
+     * the value of iz() or z().
+	 * 
+	 */
+	int section();		
+	
+	/** 
+	 * Module number in calorimeter section 
+	 * 
+	 * @see org.lcsim.geometry.subdetector.AbstractPolyhedraCalorimeter
+     * @see org.lcsim.geometry.subdetector.EcalBarrel
+	 * 
+	 * Usually, there are as many modules as sides in the calorimeter's polyhedra envelope.
+     * 
+	 * Only applies to realistic polyhedra calorimeters, though cylindrical types
+	 * could "fake it" based on the value of iphi() or phi().
+	 * 
+	 */
+	int module();
+	
+	/** 
+	 * Stave number in the module
+	 * 
+	 * @see org.lcsim.geometry.subdetector.AbstractPolyhedraCalorimeter
+     * @see org.lcsim.geometry.subdetector.EcalBarrel
+	 * 
+	 * Mokka's current RPC HCAL is an example of a calorimeter with multiple staves per module. 
+	 * 
+	 */
+	int stave();
+	
+	/** 
+	 * Row number in a plate of cells 
+	 * 
+	 * This is primarily applicable to calorimeters with planar readout volumes,
+	 * such as those within trapezoidal staves.  It could also apply to testbeams. 
+	 */
+	int row();
+	
+	/** 
+	 * Column number in a plate of cells
+	 * 
+	 * This is primarily applicable to calorimeters with planar readout volumes,
+	 * such as those within trapezoidal staves.  It could also apply to testbeams. 	
+	 * 
+	 */
+	int column();
+	
+	/** 
+     * 
+	 * Projective tower number, spanning all the calorimeter subsystems
+	 * 
+	 * FIXME: Is tower a deprecated/superceded concept?
+	 * 
+	 */
+	int tower();
+	
+	/** 
+	 * Is the cell flagged as an absorber layer that was made sensitive for debugging? 
+	 * 
+	 * There are possibly other ways to know whether a cell is actually from an absorber,
+	 * but an interface method is the most straightforward way for user's to access this
+	 * information.
+	 * 
+	 */
+	boolean isAbsorber();
+	
+	/** 
+	 * Is the cell in a barrel?   
+	 * 	 
+	 * @see org.lcsim.geometry.IDDecoder.getBarrelEndcapFlag()
+	 * @see org.lcsim.geometry.subdetector.BarrelEndcapFlag.isBarrel()
+	 * 
+	 */
+	boolean isBarrel();
+	
+	/** 
+	 * Is the cell in an endcap? 
+	 *
+	 * @see org.lcsim.geometry.IDDecoder.getBarrelEndcapFlag()
+	 * @see org.lcsim.geometry.subdetector.BarrelEndcapFlag.isEndcap()
+	 */
+	boolean isEndcap();	
+	
+	/** 
+	 * 
+     * Is the cell in the positive endcap?
+     * 
+	 * @see org.lcsim.geometry.IDDecoder.getBarrelEndcapFlag()
+	 * @see org.lcsim.geometry.subdetector.BarrelEndcapFlag.isEndcapNorth()
+	 * 
+	 */
+	boolean isPositiveEndcap();
+	
+	/** 
+	 * Is the cell in the negative endcap?
+	 * 
+	 * @see org.lcsim.geometry.IDDecoder.getBarrelEndcapFlag()
+     * @see org.lcsim.geometry.subdetector.BarrelEndcapFlag.isEndcapNorth()	 
+	 * 	 
+	 */
+	boolean isNegativeEndcap();
+		
+	/** 
+	 * Is the cell from an ECAL subdetector? 
+	 * 
+	 * @see org.lcsim.geometry.Calorimeter.getCalorimeterType()
+	 * @see org.lcsim.geometry.subdetector.CalorimeterType
+	 * 	 
+	 */
+	boolean isECAL();
+	
+	/** 
+	 * Is the cell from an HCAL subdetector? 
+	 * 	  
+     * @see org.lcsim.geometry.Calorimeter.getCalorimeterType()
+     * @see org.lcsim.geometry.subdetector.CalorimeterType
+	 * 	 
+	 */
+	boolean isHCAL();
+	
+	/** 
+	 * Is the cell from a MUON subdetector? 
+	 * 
+     * @see org.lcsim.geometry.Calorimeter.getCalorimeterType()
+     * @see org.lcsim.geometry.subdetector.CalorimeterType
+	 * 
+	 */
+	boolean isMUON();
+	
+	/** 
+	 * Is the cell from a FWD subdetector? (forward calorimeter)
+	 *  
+     * @see org.lcsim.geometry.Calorimeter.getCalorimeterType()
+     * @see org.lcsim.geometry.subdetector.CalorimeterType
+	 * 
+	 */
+	boolean isFCAL();
+	
+	/**
+	 * Is this cell from a LUMI subdetector? (luminosity monitor)
+	 * 
+     * @see org.lcsim.geometry.Calorimeter.getCalorimeterType()
+     * @see org.lcsim.geometry.subdetector.CalorimeterType
+	 * 
+	 */
+	boolean isLUMI();
+    
+    /**
+     * Is this cell from the given Calorimeter?
+     * It checks that the SystemIDs are the same.
+     */
+    boolean inCalorimeter(Calorimeter cal);
+	
+	/** 
+	 * Subdetector associated with this CalorimeterCell
+	 * 
+     * @see org.lcsim.geometry.Calorimeter.getCalorimeterType()
+     * @see org.lcsim.geometry.subdetector.CalorimeterType
+	 * 
+	 * FIXME: This breaks the usual OO heuristic that a contained object should not
+	 *        reference its container.
+     *        
+	 * FIXME: Need to make sure that a Subdetector reference is not stored with each CalorimeterCell.
+	 *  
+	 */
+	Subdetector subdetector();
+	
+	/** 
+	 * IDDecoder associated with this CalorimeterCell
+	 * 
+	 * @see org.lcsim.event.CalorimeterHit.getIDDecoder()
+	 * 
+	 * FIXME: Need to make sure that an IDDecoder reference is not stored with each CalorimeterCell.
+	 * 
+	 */
+	IDDecoder decoder();
+			
+	/** 
+     * Sampling fraction associated with this cell 
+     * 
+     * FIXME: Is this an appropriate per-cell measurement or should it be external functionality only?
+     * 
+     */
+	double samplingFraction();
+
+    /** 
+     * Is this cell from a digital calorimeter?
+     */
+    boolean isDigital();
+
+    /** 
+     * Is this cell from an analog calorimeter?
+     */  
+    boolean isAnalog();
+           
+    /** 
+     * Layer number 
+     * 
+     * @see org.lcsim.geometry.IDDecoder.getLayer()     
+     *   
+     */
+    int layer();
+
+    /**
+      * 4-vec functionality 
+      * 
+      * @see p()
+      * @see pt()
+      * @see ipt()
+      * 
+      * http://alxr.usatlas.bnl.gov/lxr/source/atlas/Event/FourMom/FourMom/P4EEtaPhiMBase.h
+      *  
+      */    
+    
+    /** 
+     * Interface to MCParticles / MCTruth
+     * 
+     * @see org.lcsim.event.SimCalorimeterHit
+     * 
+     * FIXME: Maybe MCParticle relationships are best done with a derived class
+     * or using an external relation or map.
+     * 
+     */
+    MCParticle getMCParticle(int index);
+    int getMCParticleCount();
+    int getPDG(int index); 
+
+    /** 
+     * Stub for neighbor finding
+     * 
+     * http://alxr.usatlas.bnl.gov/lxr/source/atlas/Calorimeter/CaloIdentifier/CaloIdentifier/CaloNeighbours.h
+     *
+     */
+    CalorimeterCellNeighborhood neighbors(CalorimeterNeighborOptions opts);    
+
+    /**
+     * Measure of cell density 
+     */
+    int density();
+}

GeomConverter/sandbox/calorimeter

PadRowLayout2D.java added at 1.1

diff -N PadRowLayout2D.java
--- /dev/null	1 Jan 1970 00:00:00 -0000
+++ PadRowLayout2D.java	28 Feb 2007 19:50:48 -0000	1.1
@@ -0,0 +1,133 @@

+package org.lcsim.contrib.JeremyMcCormick;
+
+import hep.physics.vec.Hep3Vector;
+
+import java.util.List;
+
+/**
+ * Interface for PadRowLayout2D, copied from GEAR's PadRowLayout2D by Frank Gaede.
+ */
+public interface PadRowLayout2D 
+{
+	/** 
+	 * The type of the coordinate system. 
+	 */
+	public enum PadLayoutType
+	{
+		CARTESIAN,
+		POLAR
+	}
+
+	/** 
+	 * The shape of the readout pad. 
+	 */
+	public enum PadShape
+	{
+		RECTANGLE,
+		DIAMOND,
+		HEXAGON,
+		CHEVRON
+	}
+		
+	/** 
+	 * The type of the row labout: CARTESIAN or POLAR.
+	 */
+	PadLayoutType getPadLayoutType();
+	
+	/** 
+	 * The shape of the pads: RECTANGLE, DIAMOND, HEXGON, or CHEVRON.
+	 */
+	PadShape getPadShape();
+	
+	/** 
+	 * The total number of pads. 
+	 */
+	int getNPads();
+	
+	/** 
+	 * The number of rows. 
+	 */
+	int getNRows();
+	
+	/** 
+	 * The row heigh in mm. 
+	 */
+	double getRowHeight(int rowNumber);
+	
+	/** 
+	 * The width of the pad at padIndex in mm (CARTESIAN) or radians (POLAR). 
+	 */
+	double getPadWidth(int padIndex);
+	
+	/**
+	 *  Center of the pad at padIndex. 
+	 */
+	// FIXME: Should return a class representing a 2D point rather than 3D.
+	//        Could use spacegeom's CartesianTwoPoint but GeomConverter cannot
+	//        depend on lcsim!
+	Hep3Vector getPadCenter(int padIndex);
+
+	/** 
+	 * The height of the pad in mm.
+	 */
+	double getPadHeight(int padIndex);
+	
+	/** 
+	 * Indices of all pads in row rowNumber. 
+	 */
+	List<Integer> getPadsInRow(int rowNumber);
+	
+	/** 
+	 * Extent of the geometric readout plane:
+	 * [xmin,xmax,ymin,ymax] for cartesian	or
+	 * [rmin,rmax,phimin,phimax] for polar.
+	 */
+	List<Double> getPlaneExtent();
+	
+	/** 
+	 * The number of the row that contains the pad at padIndex.
+	 */
+	int getRowNumber(int padIndex);
+	
+	/** 
+	 * The pad number within the row. 
+	 */
+	int getPadNumber(int padIndex);
+	
+	/** 
+	 * The index of the pad at row number rowNum and column number padNum.
+	 */
+	int getPadIndex(int rowNum, int padNum);
+	
+	/**
+	 * The index of the pad nearest to the given point in 2d coordinates (x,y) or (r,phi). 
+	 */
+	int getNearestPad(double u, double v);
+	
+	/** 
+	 * The index of the right neighbor pad. 
+	 */
+	int getRightNeighbor(int padIndex);
+	
+	/** 
+	 * The index of the left neighbor pad. 
+	 */
+	int getLeftNeighbor(int padIndex);
+
+	/** 
+	 * The indices of the full set of 2D neighbors, 
+	 * e.g. 8 for a rectangular cell not at any edge.
+	 */
+	// NOTE: This method is not in the GEAR version.
+	int getAllNeighbors(int padIndex);
+		
+	/** 
+	 * True if coordinate (c1,c2) is within the given pad. 
+	 */
+	boolean isInsidePad(double c1, double c2, int padIndex);
+	
+	/**
+	 * True if coordinate (c1,c2) is within any pad. 
+	 */
+	boolean isInsidePad(double u, double v);	
+}

\ No newline at end of file

Commit in `GeomConverter/sandbox` on MAIN
`identifier/IIdHelper.java`	+3	-1	1.1 -> 1.2
`/IIdentifiable.java`	+1	-1	1.1 -> 1.2
`/IIdentifier.java`	+14	-9	1.1 -> 1.2
`/IIdentifier32.java`	+7	-7	1.1 -> 1.2
`/IIdentifier64.java`	+5	-1	1.1 -> 1.2
`/IIdentifierExpanded.java`	+11	-4	1.1 -> 1.2
`/IdentifierHash.java`	+2	-1	1.1 -> 1.2
`calorimeter/BaseCalorimeterCell.java`	+533		added 1.1
`/CalorimeterCell.java`	+621		added 1.1
`/CalorimeterCellNeighborhood.java`	+6		added 1.1
`/CalorimeterNeighborOptions.java`	+23		added 1.1
`/PadLayout2D.java`	+100		added 1.1
`/PadRowLayout2D.java`	+133		added 1.1
`tracker/SiTrackerBarrelLayerVolume.java`	+64		added 1.1
`CoordinateTransformation3D.java`		-100	1.1 removed
`DetectorElement.java`		-35	1.1 removed
`DetectorElementCollection.java`		-2	1.1 removed
`DetectorElementMixin.java`		-8	1.1 removed
`DetectorID.java`		-80	1.1 removed
`GeometryCatalog.java`		-62	1.1 removed
`GeometryInfo.java`		-103	1.1 removed
`IDetectorElement.java`		-36	1.1 removed
`IGeometryInfo.java`		-49	1.1 removed
`ISolid.java`		-35	1.1 removed
`LVolume.java`		-102	1.1 removed
`PVolume.java`		-107	1.1 removed
`PadRowLayout2D.java`		-133	1.1 removed
`Trapezoid.java`		-80	1.1 removed
`TubeSegment.java`		-85	1.1 removed
	+1523	-1041