StRoot: StTrsMaker/include/StTrsAnalogSignalGenerator.hh Source File

00001 /***************************************************************************
00002  *
00003  * $Id: StTrsAnalogSignalGenerator.hh,v 1.10 2008/10/13 19:56:10 fisyak Exp $
00004  *
00005  * Author: 
00006  ***************************************************************************
00007  *
00008  * Description: Abstract Class to define the Analog signal generator
00009  *
00010  ***************************************************************************
00011  *
00012  * $Log: StTrsAnalogSignalGenerator.hh,v $
00013  * Revision 1.10  2008/10/13 19:56:10  fisyak
00014  * Account that Z-offset is sector dependent
00015  *
00016  * Revision 1.9  2005/09/09 22:12:48  perev
00017  * Bug fix + IdTruth added
00018  *
00019  * Revision 1.8  2000/02/10 01:21:47  calderon
00020  * Switch to use StTpcDb.
00021  * Coordinates checked for consistency.
00022  * Fixed problems with StTrsIstream & StTrsOstream.
00023  *
00024  * Revision 1.7  2000/01/10 23:11:31  lasiuk
00025  * Include MACROS for compatibility with SUN CC5.0
00026  *
00027  * Revision 1.6  1999/11/10 15:45:50  calderon
00028  * Made changes to reduce timing, including:
00029  * Made coordinate transfrom a data member of StTrsAnalogSignalGenerator
00030  * Added upper-lower bound instead of symmetric cut.
00031  * Revived checking if signal is above threshold.
00032  *
00033  * Revision 1.5  1999/04/23 19:20:55  lasiuk
00034  * add mTimeShiftOfSignalCentroid
00035  *
00036  * Revision 1.4  1999/02/28 20:13:40  lasiuk
00037  * noise additions
00038  *
00039  * Revision 1.3  1999/01/18 21:00:52  lasiuk
00040  * add fractionSampled(); reorder initialization
00041  *
00042  * Revision 1.2  1999/01/18 10:20:23  lasiuk
00043  * add tau
00044  *
00045  * Revision 1.1  1998/11/10 17:12:08  fisyak
00046  * Put Brian trs versin into StRoot
00047  *
00048  * Revision 1.5  1998/11/08 17:02:32  lasiuk
00049  * vector allocator, TRUE/true
00050  *
00051  * Revision 1.4  1998/11/04 21:27:04  lasiuk
00052  * unresolved symbol--forgot to set virtual function to zero (inducedChargeOnPad)
00053  *
00054  * Revision 1.3  1998/11/04 18:46:20  lasiuk
00055  * remove gas gain functionality (now in WireHistogram)
00056  * initialization in base class
00057  * incorporate signalSampler
00058  *
00059  * Revision 1.2  1998/10/22 14:58:12  lasiuk
00060  * image charge returns double and uses PRF integral
00061  *
00062  * Revision 1.1  1998/06/30 22:54:10  lasiuk
00063  * Initial Revision
00064  *
00065  **************************************************************************/
00066 #ifndef ST_TRS_ANALOG_SIGNAL_GENERATOR_HH
00067 #define ST_TRS_ANALOG_SIGNAL_GENERATOR_HH
00068 
00069 #include <utility>
00070 #include <vector>
00071 
00072 #if defined (__SUNPRO_CC) && __SUNPRO_CC >= 0x500
00073 using std::min;
00074 using std::max;
00075 #endif
00076 
00077 #include "Randomize.h"
00078 
00079 #include "StTrsAnalogSignal.hh"
00080 #include "StTpcGeometry.hh"
00081 #include "StTpcSlowControl.hh"
00082 #include "StTpcElectronics.hh"
00083 #define TPC_DATABASE_PARAMETERS
00084 #ifndef TPC_DATABASE_PARAMETERS
00085 #include "StTpcCoordinateTransform.hh"
00086 #else
00087 #include "StDbUtilities/StTpcCoordinateTransform.hh"
00088 #endif
00089 #include "StTrsWireHistogram.hh"
00090 #include "StTrsSector.hh"
00091 
00092 class StTrsAnalogSignalGenerator {
00093 public:
00094     StTrsAnalogSignalGenerator(StTpcGeometry*, StTpcSlowControl*, StTpcElectronics*, StTrsSector*);
00095     virtual ~StTrsAnalogSignalGenerator() {/* nopt */}
00096 
00097     // Charge Induction
00098   virtual void inducedChargeOnPad(StTrsWireHistogram*, Int_t sector)            = 0;
00099 
00100     // Sampling
00101     virtual void   sampleAnalogSignal()                         = 0;
00102     virtual double signalSampler(double, StTrsAnalogSignal&)    = 0;
00103 
00104     // access and set
00105     void           setDeltaPad(int);
00106     void           setDeltaRow(int);
00107     void           setSignalThreshold(double);
00108     void           setSuppressEmptyTimeBins(bool);
00109     virtual void   setNormalFactor(double FudgeFactor) {assert(0);}
00110     // noise generation
00111     void           addNoise(bool);
00112     void           setNoiseRMS(double);
00113     void           generateNoiseUnderSignalOnly(bool);
00114     
00115 protected:
00116     void           fractionSampled();
00117     double         generateNoise()    const;
00118     
00119 protected:
00120     StTpcGeometry*       mGeomDb;
00121     StTpcSlowControl*    mSCDb;
00122     StTpcElectronics*    mElectronicsDb;
00123     StTpcCoordinateTransform transformer;
00124     int                  mDeltaPad;
00125     int                  mDeltaRow;
00126     pair<int, int>       mRowLimits;
00127     pair<int, int>       mPadLimits;
00128 
00129     StTrsSector*         mSector;    // MAKE SURE IT IS CONTAINED BY REFERENCE
00130 
00131     //sampling
00132     double                    mSignalThreshold;
00133     bool                      mSuppressEmptyTimeBins;
00134     StTrsAnalogSignal         mElectronicSignal;
00135 #ifndef ST_NO_TEMPLATE_DEF_ARGS
00136     vector<StTrsAnalogSignal> mDiscreteAnalogTimeSequence;    
00137     vector<StTrsAnalogSignal>::iterator mTimeSequenceIterator;
00138 #else
00139     vector<StTrsAnalogSignal, allocator<StTrsAnalogSignal> > mDiscreteAnalogTimeSequence;    
00140     vector<StTrsAnalogSignal, allocator<StTrsAnalogSignal> >::iterator mTimeSequenceIterator;
00141 #endif
00142     // db parameters
00143     double mSigma1;
00144     double mSigma2;
00145     double mTau;
00146     double mSamplingFrequency;
00147     double mGain;
00148     double mFractionSampled;
00149 
00150     // Noise Generation
00151     bool   mAddNoise;
00152     bool   mAddNoiseUnderSignalOnly;
00153     double mNoiseRMS;
00154 
00155 
00156     // Time Shift for electronics
00157     double mTimeShiftOfSignalCentroid;
00158 
00159     
00160     static HepJamesRandom mEngine;
00161     static RandGauss      mGaussDistribution;
00162 };
00163 void inline StTrsAnalogSignalGenerator::setDeltaRow(int dr) { mDeltaRow = (dr >=0) ? dr : 0;}
00164 void inline StTrsAnalogSignalGenerator::setDeltaPad(int dp) { mDeltaPad = (dp >=0) ? dp : 0;}
00165 void inline StTrsAnalogSignalGenerator::setSignalThreshold(double th) { mSignalThreshold = th;}
00166 void inline StTrsAnalogSignalGenerator::setSuppressEmptyTimeBins(bool su) {mSuppressEmptyTimeBins = su;}
00167 void inline StTrsAnalogSignalGenerator::addNoise(bool v) {mAddNoise = v;}
00168 void inline StTrsAnalogSignalGenerator::setNoiseRMS(double v) {mNoiseRMS = v*mGain;}
00169 void inline StTrsAnalogSignalGenerator::generateNoiseUnderSignalOnly(bool v) {mAddNoiseUnderSignalOnly = v;}
00170 double inline StTrsAnalogSignalGenerator::generateNoise() const {return fabs(mGaussDistribution.shoot(0.,mNoiseRMS));}
00171 #endif