java/trunk/users/src/main/java/org/lcsim/hps/users/meeg

NoiselessReadoutChip.java removed after 130

--- java/trunk/users/src/main/java/org/lcsim/hps/users/meeg/NoiselessReadoutChip.java	2014-01-29 18:18:24 UTC (rev 130)
+++ java/trunk/users/src/main/java/org/lcsim/hps/users/meeg/NoiselessReadoutChip.java	2014-01-29 19:21:07 UTC (rev 131)
@@ -1,314 +0,0 @@

-/*
- * Class BasicReadoutChip
- */
-package org.lcsim.hps.users.meeg;
-
-import java.util.ArrayList;
-import java.util.List;
-import java.util.SortedMap;
-import java.util.TreeMap;
-import org.lcsim.detector.tracker.silicon.SiSensor;
-import org.lcsim.detector.tracker.silicon.SiSensorElectrodes;
-import org.lcsim.event.RawTrackerHit;
-import org.lcsim.hps.recon.tracking.HPSSVTCalibrationConstants;
-import org.lcsim.recon.tracking.digitization.sisim.ReadoutChip;
-import org.lcsim.recon.tracking.digitization.sisim.ReadoutChip.ReadoutChannel;
-import org.lcsim.recon.tracking.digitization.sisim.SiElectrodeData;
-import org.lcsim.recon.tracking.digitization.sisim.SiElectrodeDataCollection;
-
-/**
- * Basic readout chip class.  This class supports the minimal functions expected of
- * a readout chip.  The charge on a strip/pixel is digitized as an integer number
- * with a simple ADC with programmable resolution and dynamic range.  A chip with
- * 1-bit ADC resolution (binary readout) is treated as a special case.
- * 
- * Noise is added to strips with charge and random noise hits are generated as well.
- * Methods are provided to decode the charge and time (although the current
- * implementation always returns a time of 0).
- *
- * This implementation has thresholds that are settable in units of RMS noise of
- * each channel to enable simluation of highly optimized readout chains.  If
- * absolute thresholds are desired, GenericReadoutChip should be used instead.
- *
- * @author Tim Nelson
- */
-public class NoiselessReadoutChip implements ReadoutChip {
-
-    private BasicChannel _channel = new BasicChannel();
-    private ADC _adc = new ADC();
-    private boolean dropBadChannels = false;
-
-    /** Creates a new instance of BasicReadoutChip */
-    public NoiselessReadoutChip() {
-    }
-
-    public void setDropBadChannels(boolean dropBadChannels) {
-        this.dropBadChannels = dropBadChannels;
-    }
-
-    /**
-     * Set the noise intercept (i.e., the noise for 0 strip/pixel capacitance).
-     * Units are electrons of noise.
-     *
-     * @param noise_intercept noise for 0 capacitance
-     */
-    public void setNoiseIntercept(double noise_intercept) {
-        _channel.setNoiseIntercept(noise_intercept);
-    }
-
-    /**
-     * Set the noise slope (i.e., the proportionality between noise and capacitance).
-     * Units are electrons of noise per fF of capacitance.
-     *
-     * @param noise_slope noise slope per unit capacitance
-     */
-    public void setNoiseSlope(double noise_slope) {
-        _channel.setNoiseSlope(noise_slope);
-    }
-
-    /**
-     * Set the number of bits of ADC resolution
-     *
-     * @param nbits
-     */
-    public void setNbits(int nbits) {
-        getADC().setNbits(nbits);
-    }
-
-    /**
-     * Set the dynamic range of the ADC
-     *
-     * @param dynamic_range in fC
-     */
-    public void setDynamicRange(double dynamic_range) {
-        getADC().setDynamicRange(dynamic_range);
-    }
-
-    /**
-     * Return the BasicChannel associated with a given channel number.
-     * For the basic readout, there is a single instance of BasicChannel
-     * and thus the channel number is ignored.
-     *
-     * @param channel_number channel number
-     * @return associated BasicReadoutChannel
-     */
-    public BasicChannel getChannel(int channel_number) {
-        return _channel;
-    }
-
-    private ADC getADC() {
-        return _adc;
-    }
-
-    /**
-     * Given a collection of electrode data (i.e., charge on strips/pixels),
-     * return a map associating the channel and it's list of raw data.
-     *
-     * @param data  electrode data from the charge distribution
-     * @param electrodes  strip or pixel electrodes
-     * @return  map containing the ADC counts for this sensor
-     */
-    public SortedMap<Integer, List<Integer>> readout(SiElectrodeDataCollection data, SiSensorElectrodes electrodes) {
-
-        //  If there is no electrode data for this readout chip,  create an empty
-        //  electrode data collection
-        if (data == null) {
-            data = new SiElectrodeDataCollection();
-        }
-
-        //  Add noise hits to the electrode data collection
-//        addNoise(data, electrodes);
-
-        //  return the digitized charge data as a map that associates a hit
-        //  channel with a list of raw data for the channel
-        return digitize(data, electrodes);
-    }
-
-    /**
-     * Decode the hit charge stored in the RawTrackerHit
-     *
-     * @param hit raw hit
-     * @return hit charge in units of electrons
-     */
-    public double decodeCharge(RawTrackerHit hit) {
-        return getADC().decodeCharge(hit.getADCValues()[0]);
-    }
-
-    /**
-     * Decode the hit time.  Currently, the basic readout chip ignores the
-     * hit time and returns 0.
-     *
-     * @param hit raw hit data
-     * @return hit time
-     */
-    public int decodeTime(RawTrackerHit hit) {
-        return 0;
-    }
-
-    /**
-     * Digitizes the hit channels in a SiElectrodeDataCollection.
-     *
-     * The SiElectrodeDataCollection is a map that associates a given channel with
-     * it's SiElectrodeData.  The SiElectrodeData encapsulates the deposited charge
-     * on an strip/pixel and any associated SimTrackerHits.
-     *
-     * The output of this class is a map that associates a channel number with
-     * a list of raw data
-     *
-     * @param data electrode data collection
-     * @return map associating channels with a list of raw data
-     */
-    private SortedMap<Integer, List<Integer>> digitize(SiElectrodeDataCollection data,
-            SiSensorElectrodes electrodes) {
-        //  Create the map that associates a given sensor channel with it's list of raw data
-        SortedMap<Integer, List<Integer>> chip_data = new TreeMap<Integer, List<Integer>>();
-
-        //  Loop over the channels contained in the SiElectrodeDataCollection
-        for (Integer channel : data.keySet()) {
-            if (dropBadChannels && HPSSVTCalibrationConstants.isBadChannel((SiSensor) electrodes.getDetectorElement(), channel)) {
-//                System.out.format("%d bad\n", channel);
-                continue;
-            }
-//                System.out.format("%d OK\n", channel);
-            //  Fetch the electrode data for this channel
-            SiElectrodeData eldata = data.get(channel);
-
-            //  Get the charge in units of electrons
-            double charge = eldata.getCharge();
-
-            //  Calculate the ADC value for this channel and make sure it is positive
-            int adc = getADC().convert(charge);
-            if (adc <= 0) {
-                continue;
-            }
-
-            //  Create a list containing the adc value - for the basic readout
-            //  there is only 1 word of raw data
-            List<Integer> channel_data = new ArrayList<Integer>();
-            channel_data.add(adc);
-
-            //  Save the list of raw data in the chip_data map
-            chip_data.put(channel, channel_data);
-        }
-
-        return chip_data;
-    }
-
-    /**
-     * BasicChannel class representing a single channel's behavior
-     *
-     * Note that binary readout is a special case.  Anything positive value
-     * passed to a binary ADC for digitization is assumed to have crossed t
-     * hreshold and is assigned a value of 1.  Decoding binary readout results
-     * in either 0 or dynamic_range.
-     */
-    private class BasicChannel implements ReadoutChannel {
-
-        private double _noise_intercept = 0.;
-        private double _noise_slope = 0.;
-
-        /**
-         * Set the noise (in electrons) for 0 capacitance
-         *
-         * @param noise_intercept noise intercept
-         */
-        private void setNoiseIntercept(double noise_intercept) {
-            _noise_intercept = noise_intercept;
-        }
-
-        /**
-         * Set the capacitative noise slope (in electrons / pF)
-         *
-         * @param noise_slope noise slope
-         */
-        private void setNoiseSlope(double noise_slope) {
-            _noise_slope = noise_slope;
-        }
-
-        /**
-         * Return the noise in electrons for a given strip/pixel capacitance
-         *
-         * @param capacitance capacitance in pF
-         * @return noise in electrons
-         */
-        public double computeNoise(double capacitance) {
-            return _noise_intercept + _noise_slope * capacitance;
-        }
-    }
-
-    /**
-     * ADC class representing analog to digital converter.
-     */
-    private class ADC {
-
-        private int _nbits = 8;
-        private double _dynamic_range = 20.;
-
-        /**
-         * Set the ADC resolution in number of bits.
-         *
-         * @param nbits number of bits
-         */
-        private void setNbits(int nbits) {
-            _nbits = nbits;
-        }
-
-        /**
-         * Set the dynamic range in fC
-         *
-         * @param dynamic range
-         */
-        private void setDynamicRange(double dynamic_range) {
-            _dynamic_range = dynamic_range;
-        }
-
-        /**
-         * Compute the maximum ADC value
-         *
-         * @return largest possible ADC value according to # of bits
-         */
-        private int maxADCValue() {
-            return (int) Math.pow(2, _nbits) - 1;
-        }
-
-        /**
-         * Compute the conversion constant in ADC/fC
-         *
-         * @return conversion constant for ADC
-         */
-        private double conversionConstant() {
-            return maxADCValue() / _dynamic_range;
-        }
-
-        /**
-         * Perform analog to digital conversion
-         *
-         * @return digital ADC output between 0 and maxADCValue
-         */
-        public int convert(double charge) {
-            if (_nbits != 1) {
-                return Math.max(0, Math.min(maxADCValue(), (int) Math.floor(charge * 1.602e-4 * conversionConstant())));
-            } else {
-                if (charge <= 0.0) {
-                    return 0;
-                } else {
-                    return 1;
-                }
-            }
-        }
-
-        /**
-         * Decode charge from ADC value
-         *
-         * @return charge specified by a given ADC value
-         */
-        public double decodeCharge(int adc_value) {
-            if (_nbits != 1) {
-                return (adc_value + 0.5) / (1.602e-4 * conversionConstant());
-            } else {
-                return adc_value * _dynamic_range;
-            }
-
-        }
-    }
-}

Commit in `java/trunk` on MAIN
`hps-java/src/main/resources/org/lcsim/hps/steering/readout/HPSTrackingDefaults.lcsim`	+1	-1	130 -> 131
`hps-java/src/main/resources/org/lcsim/hps/steering/users/meeg/EcalGainDriverSim.lcsim`	+1	-1	130 -> 131
`users/src/main/java/org/lcsim/hps/users/meeg/NoiselessReadoutChip.java`		-314	130 removed
`/SimpleTrackerDigiDriver.java`		-71	130 removed
	+2	-387