StRoot: StDbUtilities/StMagUtilities.h Source File

00001 /***********************************************************************
00002  *
00003  * $Id: StMagUtilities.h,v 1.49 2012/04/25 19:22:56 genevb Exp $
00004  *
00005  * Author: Jim Thomas   11/1/2000
00006  *
00007  ***********************************************************************
00008  *
00009  * Description: Utilities for the Magnetic Field
00010  *
00011  ***********************************************************************
00012  *
00013  * $Log: StMagUtilities.h,v $
00014  * Revision 1.49  2012/04/25 19:22:56  genevb
00015  * More use of GLWeights, more realistic geometry model in PredictSpaceCharge
00016  *
00017  * Revision 1.48  2011/08/23 22:15:10  genevb
00018  * Introduce sector alignment distortion corrections and big speed improvements to Poisson relaxations
00019  *
00020  * Revision 1.47  2010/10/28 19:10:59  genevb
00021  * Provide for  usage of tpcHVPlanes and GG Voltage Error
00022  *
00023  * Revision 1.46  2010/05/30 21:12:44  genevb
00024  * For GridLeak studies: more knobs to adjust GL and SC in Predict() functions
00025  *
00026  * Revision 1.45  2010/02/25 21:49:05  genevb
00027  * Using sector number to better handle post-membrane hits, prep for sector-by-sector GL, and GGVoltage errors
00028  *
00029  * Revision 1.44  2009/12/11 04:53:58  genevb
00030  * Give the enum constants unique names
00031  *
00032  * Revision 1.43  2009/12/11 03:55:21  genevb
00033  * Singleton implementation + no defines in header
00034  *
00035  * Revision 1.42  2009/11/06 13:38:05  fisyak
00036  * Revert the change done 11/03/09
00037  *
00038  * Revision 1.40  2009/10/19 21:29:01  jhthomas
00039  * Improved execution speed for many algorithms: especially GridLeak.
00040  *
00041  * Revision 1.39  2009/10/01 22:40:11  jhthomas
00042  * Update grid spacing for UndoShort, and prepare for other future gridding upgrades to achieve higher resolution results.
00043  *
00044  * Revision 1.38  2008/03/27 00:09:54  jhthomas
00045  * Modify previous magfield changes and set 'zero' field to ~1 Gauss in a more robust way.
00046  * Add SpaceChargeEWRatio and appropriate functions that allow us to calibrate d-Au collisions.
00047  *
00048  * Revision 1.37  2007/07/12 19:20:42  fisyak
00049  * Account that StDetectorDbSpaceChargeR2 is not inherit from StDetectorDbSpaceCharge anymore
00050  *
00051  * Revision 1.36  2006/12/16 23:46:25  jhthomas
00052  * Add ManualShortedRing() for Gene, and protect against B=0 ... set to a minimum of 0.25 gauss instead
00053  *
00054  * Revision 1.35  2006/08/07 20:38:13  fisyak
00055  * TMatrix is typedef to TMatrixT<Float_t> now, with ROOT 5,12
00056  *
00057  * Revision 1.34  2006/07/28 04:58:32  jhthomas
00058  * Add code by GeneVB to update the ShortedRing tables every time the DB changes.
00059  *
00060  * Revision 1.33  2006/06/27 18:17:47  jhthomas
00061  * ADD new PredictSpaceCharge() function so that it includes fit errors in the prediction
00062  * It is now capable of including the SSD and SVT hits in the predictor/corrector loop
00063  *
00064  * Revision 1.32  2005/05/24 18:53:20  jhthomas
00065  * Add 3DGridLeak Distortion Correction and Utilities to support it.
00066  *
00067  * Revision 1.31  2005/02/17 02:00:51  jhthomas
00068  * Make GetSpaceChargeMode() a public member function.
00069  *
00070  * Revision 1.30  2005/02/09 23:50:36  jeromel
00071  * Changes by JHT for SpaceCharge / Leak corrections
00072  *
00073  * Revision 1.28  2004/10/20 17:53:11  jhthomas
00074  * Add StGetSpaceChargeMode() function
00075  *
00076  * Revision 1.27  2004/07/01 17:49:07  jhthomas
00077  * Add Event by Event SpaceCharge form GVB.  Start adding incomplete/unfinished work on Endcaps from JT.
00078  *
00079  * Revision 1.26  2004/04/01 22:19:48  jhthomas
00080  * Add 3D SpaceCharge capabilities
00081  *
00082  * Revision 1.25  2004/03/16 20:45:32  jhthomas
00083  * Add new (faster) BField shape distortion routine.  See comments for chain flags.
00084  *
00085  * Revision 1.24  2004/03/01 17:23:36  jhthomas
00086  * Add function to get shorted ring parameters.
00087  *
00088  * Revision 1.23  2004/01/06 20:09:26  jhthomas
00089  * Add new routine to handle shorted stripe on East end of TPC
00090  *
00091  * Revision 1.22  2003/09/02 17:57:51  perev
00092  * gcc 3.2 updates + WarnOff
00093  *
00094  * Revision 1.21  2003/06/27 18:47:12  jhthomas
00095  * Add new function called FixSpaceChargeDistortion( ,,,,, )
00096  *
00097  * Revision 1.20  2002/09/18 22:21:35  jhthomas
00098  * Add new option for 1/R**2 space charge density distribution.  Flag = 0x800
00099  *
00100  * Revision 1.19  2002/02/22 17:44:19  jhthomas
00101  * Get CathodeV and GG from DB. Change Defaults.  Change Instantiation argument
00102  * order. Update D'Oxygen documentation.  Remove 2000/2001 E field switch.
00103  *
00104  * Revision 1.18  2002/02/02 01:01:09  jeromel
00105  * Jim's modif for FC & SpaceCharge corrections.
00106  *
00107  * Revision 1.17  2001/10/25 23:00:24  hardtke
00108  * Use database to get a few parameters in StMagUtilities (including twist)
00109  *
00110  * Revision 1.16  2001/10/05 21:27:35  jeromel
00111  * Small comment addition for historical purposes.
00112  *
00113  * Revision 1.15  2001/10/05 20:18:02  dunlop
00114  * Tweaked enumeration of distortion selection to respect first three bits for
00115  * year flag
00116  *
00117  * Revision 1.14  2001/10/05 03:44:25  jeromel
00118  * Modifications by Jamie so we can turn on/off every corrections.
00119  *
00120  * Revision 1.13  2001/08/01 18:34:40  jhthomas
00121  * Add temporary mode flag for year 2 running (different cathode potentials)
00122  *
00123  * Revision 1.12  2001/06/14 22:12:11  jhthomas
00124  * Speedup UndoBDistorion by adding table lookups
00125  *
00126  * Revision 1.11  2001/06/13 16:24:43  jhthomas
00127  * Speed up PadRow13 Corrections
00128  *
00129  * Revision 1.3  2000/12/15 16:10:45  jhthomas
00130  * Add PadRow13, Clock, and Twist corrections to UndoDistortion
00131  *
00132  * Revision 1.2  2000/11/03 02:41:58  jhthomas
00133  * Added CVS comment structure to .h and .cxx files
00134  *
00135  ***********************************************************************/
00137 //                                                                      //
00138 // StMagUtilities Class                                                 //
00139 //                                                                      //
00141 #ifndef StMagUtilities_H
00142 #define StMagUtilities_H
00143  
00144 #include <math.h>
00145 #include <stdio.h>
00146 #include <stdlib.h>
00147 #include <Stiostream.h>
00148 
00149 #include "TSystem.h"
00150 #include "TROOT.h"        // Stop at this point and put further includes in .cxx file
00151 #include "TMatrix.h"      // TMatrix keeps changing ... keep it here until proven otherwise.
00152 
00153 enum   EBField  { kUndefined = 0, kConstant = 1, kMapped = 2, kChain = 3 } ;
00154 enum   Prime    { IsPrimary = 0 , IsGlobal = 1 } ;
00155 
00156 // Bit counting starts at 1 for the mode switch (...,3,2,1)
00157 
00158 enum   DistortSelect 
00159 { 
00160   kBMap              = 0x08,     // Bit 4
00161   kPadrow13          = 0x10,     // Bit 5
00162   kTwist             = 0x20,     // Bit 6
00163   kClock             = 0x40,     // Bit 7
00164   kMembrane          = 0x80,     // Bit 8
00165   kEndcap            = 0x100,    // Bit 9
00166   kIFCShift          = 0x200,    // Bit 10
00167   kSpaceCharge       = 0x400,    // Bit 11
00168   kSpaceChargeR2     = 0x800,    // Bit 12
00169   kShortedRing       = 0x1000,   // Bit 13
00170   kFast2DBMap        = 0x2000,   // Bit 14
00171   kGridLeak          = 0x4000,   // Bit 15
00172   k3DGridLeak        = 0x8000,   // Bit 16
00173   kGGVoltError       = 0x10000,  // Bit 17
00174   kSectorAlign       = 0x20000   // Bit 18
00175 } ;
00176 enum   EBMapSizes
00177 {
00178   BMap_nZ    =          57,           // Number of Z points in table. Measured STAR B field Maps from Steve T. 
00179   BMap_nR    =          28,           // Number of R points in table.
00180   BMap_nPhi  =          37,           // Number of Phi points in table.
00181   EMap_nZ    =         224,           // Number of Z points in table. Standard STAR distortion tables for interpolating. 
00182   EMap_nR    =          82,           // Number of R points in table
00183   EMap_nPhi  =          13            // Number of Phi points in table ( add one for 360 == 0 )
00184 } ;
00185 
00186 // DO NOT change the numbering of these constants. StBFChain depends
00187 // on these values to build an option flag. The option flag used in 
00188 // the chain is 2x larger than shown here in order to allow the first 
00189 // bit to be used as an on/off flag.  It is shifted away before entering 
00190 // StMagUtilities.  So, this can be summarized by saying: 
00191 // Bit counting starts at 0 for the chain option flag (...,3,2,1,0) 
00192 
00193 class StTpcDb ;
00194 class TDataSet ;
00195 class St_tpcHVPlanesC;
00196 #include "StDetectorDbMaker/StDetectorDbSpaceCharge.h"
00197 #include "StDetectorDbMaker/StDetectorDbTpcVoltages.h"
00198 #include "StDetectorDbMaker/StDetectorDbTpcOmegaTau.h"
00199 #include "StDetectorDbMaker/StDetectorDbGridLeak.h"
00200 
00201 //class TMatrix ;
00202 
00203 class StMagUtilities {
00204 
00205 
00206  private:
00207   static StMagUtilities *fgInstance;
00208  
00209   StTpcDb*  thedb ;  
00210   TDataSet* thedb2 ;
00211   StDetectorDbSpaceCharge*   fSpaceCharge   ;
00212   StDetectorDbSpaceChargeR2* fSpaceChargeR2 ;  
00213   StDetectorDbTpcVoltages*   fTpcVolts      ;
00214   StDetectorDbTpcOmegaTau*   fOmegaTau      ;
00215   StDetectorDbGridLeak*      fGridLeak      ;
00216   St_tpcHVPlanesC*           fHVPlanes      ;
00217 
00218   virtual void    SetDb( StTpcDb* dbin , TDataSet* dbin2 ) ;
00219   virtual void    GetMagFactor ()     ;
00220   virtual void    GetTPCParams ()     ;
00221   virtual void    GetTPCVoltages ()   ;
00222   virtual void    GetSpaceCharge ()   ;
00223   virtual void    GetSpaceChargeR2 () ;  
00224   virtual void    GetShortedRing ()   ;  
00225   virtual void    GetOmegaTau ()      ;
00226   virtual void    GetGridLeak()       ;
00227   virtual void    GetHVPlanes()       ;
00228 
00229   virtual void    CommonStart ( Int_t mode ) ;
00230   virtual void    ReadField ( ) ;
00231   virtual void    Search ( const Int_t N, const Float_t Xarray[], const Float_t x, Int_t &low ) ;
00232   virtual Int_t   IsPowerOfTwo (Int_t i) ;
00233   virtual void    SectorNumber ( Int_t& Sector , const Float_t x[] ) ;
00234   virtual void    SectorNumber ( Int_t& Sector , Float_t phi, const Float_t z ) ;
00235   virtual Float_t LimitZ (Int_t& Sector, const Float_t x[] ) ;
00236   virtual Float_t Interpolate ( const Float_t Xarray[], const Float_t Yarray[], 
00237                                 const Int_t ORDER, const Float_t x ) ;
00238   virtual Float_t Interpolate2DTable  ( const Int_t ORDER, const Float_t x, const Float_t y, const Int_t nx, const Int_t ny, 
00239                                         const Float_t XV[], const Float_t YV[], const TMatrix &Array ) ;
00240   virtual Float_t Interpolate3DTable ( const Int_t ORDER, const Float_t x,    const Float_t y,    const Float_t z,
00241                                        const Int_t  nx,    const Int_t  ny,    const Int_t  nz,
00242                                        const Float_t XV[], const Float_t YV[], const Float_t ZV[],
00243                                        TMatrix **ArrayofArrays ) ;
00244   virtual void    Interpolate2DBfield ( const Float_t r, const Float_t z, 
00245                                         Float_t &Br_value, Float_t &Bz_value ) ;
00246   virtual void    Interpolate3DBfield ( const Float_t r, const Float_t z, const Float_t phi, 
00247                                         Float_t &Br_value, Float_t &Bz_value, Float_t &Bphi_value ) ;
00248   virtual void    Interpolate2DEdistortion ( const Int_t ORDER, const Float_t r, const Float_t z, 
00249                                              const Float_t Er[EMap_nZ][EMap_nR], Float_t &Er_value ) ;
00250   virtual void    Interpolate3DEdistortion ( const Int_t ORDER, const Float_t r, const Float_t phi, const Float_t z, 
00251                                              const Float_t Er[EMap_nZ][EMap_nPhi][EMap_nR], const Float_t Ephi[EMap_nZ][EMap_nPhi][EMap_nR], 
00252                                              Float_t &Er_value, Float_t &Ephi_value ) ;
00253   virtual void    PoissonRelaxation  ( TMatrix &ArrayV, TMatrix &Charge, TMatrix &EroverEz, 
00254                                        const Int_t ITERATIONS ) ;
00255 
00256   virtual void    Poisson3DRelaxation( TMatrix **ArrayofArrayV, TMatrix **ArrayofCharge, TMatrix **ArrayofEroverEz, 
00257                                        TMatrix **ArrayofEPhioverEz,
00258                                        const Int_t PHISLICES, const Float_t DeltaPhi, 
00259                                        const Int_t ITERATIONS, const Int_t SYMMETRY) ;
00260 
00261   Int_t    mDistortionMode;             // Distortion mode - determines which corrections are run
00262 
00263   Float_t  StarDriftV ;                 // Drift Velocity (cm/microSec) Magnitude
00264   Float_t  TPC_Z0 ;                     // Z location of STAR TPC Ground Wire Plane (cm) Magnitude
00265   Float_t  XTWIST ;                     // X Displacement of West end of TPC wrt magnet (mRad)
00266   Float_t  YTWIST ;                     // Y Displacement of West end of TPC wrt magnet (mRad)
00267   Double_t CathodeV ;                   // Cathode Potential (volts)
00268   Double_t GG ;                         // Gating Grid voltage (volts)
00269   Float_t  EASTCLOCKERROR ;             // Phi rotation of East end of TPC in milli-radians
00270   Float_t  WESTCLOCKERROR ;             // Phi rotation of West end of TPC in milli-radians
00271   Float_t  IFCRadius ;                  // Radius of the Inner Field Cage
00272   Float_t  OFCRadius ;                  // Radius of the Outer Field Cage
00273   Float_t  GAPRADIUS ;                  // Radius of the gap between the Inner sectors and the Outer sectors
00274   Float_t  GAP13_14 ;                   // Width of the gap between the grids at row 13 and row 14 (cm)
00275   Float_t  StarMagE ;                   // STAR Electric Field (V/cm) Magnitude
00276   Float_t  IFCShift ;                   // Shift of the IFC towards the West Endcap (cm)
00277   Float_t  TensorV1 ;                   // Omega Tau tensor parameter - in the ExB direction
00278   Float_t  TensorV2 ;                   // Omega Tau tensor parameter - in the direction perpendicular to ExB and Z axis
00279   Float_t  Const_0, Const_1, Const_2  ; // OmegaTau parameters
00280   Float_t  SpaceChargeEWRatio         ; // Ratio of East/West Space charge ... for example, d-Au should be ratio 6/5, Au-Au ratio 1/1
00281   Double_t SpaceCharge, SpaceChargeR2 ; // Space Charge parameters (uniform or 1/R**2 in the TPC - arbitrary units)
00282   Double_t InnerGridLeakStrength      ; // Relative strength of the Inner grid leak
00283   Double_t InnerGridLeakRadius        ; // Location (in local Y coordinates) of the Inner grid leak 
00284   Double_t InnerGridLeakWidth         ; // Half-width of the Inner grid leak.  Must be larger than life for numerical reasons.
00285   Double_t MiddlGridLeakStrength      ; // Relative strength of the Middle grid leak
00286   Double_t MiddlGridLeakRadius        ; // Location (in local Y coordinates) of the Middle grid leak 
00287   Double_t MiddlGridLeakWidth         ; // Half-width of the Middle grid leak.  Must be larger than life for numerical reasons.
00288   Double_t OuterGridLeakStrength      ; // Relative strength of the Outer grid leak
00289   Double_t OuterGridLeakRadius        ; // Location (in local Y coordinates) of the Outer grid leak 
00290   Double_t OuterGridLeakWidth         ; // Half-width of the Outer grid leak.  Must be larger than life for numerical reasons.
00291   Float_t  GLWeights[25]              ; // GridLeak weights per sector.  24 sectors. Note: slot 0 is not used!!
00292   Int_t    ShortTableRows             ; // Number of rows in the Shorted Ring Table
00293   Int_t    Side[10]                   ; // Location of Short   E=0 /   W=1
00294   Int_t    Cage[10]                   ; // Location of Short IFC=0 / OFC=1
00295   Float_t  Ring[10]                   ; // Location of Short counting out from the CM.  CM==0 
00296   Float_t  MissingResistance[10]      ; // Amount of Missing Resistance due to this short (MOhm)
00297   Float_t  Resistor[10]               ; // Amount of compensating resistance added for this short
00298   Float_t  deltaVGGEast               ; // Voltage error on the East Gated Grid
00299   Float_t  deltaVGGWest               ; // Voltage error on the West Gated Grid
00300   Bool_t   useManualSCForPredict      ; // Flag on using fixed SC value or manually set one for Predict()
00301 
00302 
00303   Float_t  Bz[BMap_nZ][BMap_nR], Br[BMap_nZ][BMap_nR] ;         
00304   Float_t  Radius[BMap_nR], ZList[BMap_nZ] ;         
00305   Float_t  Bz3D[BMap_nPhi][BMap_nZ][BMap_nR], Br3D[BMap_nPhi][BMap_nZ][BMap_nR], Bphi3D[BMap_nPhi][BMap_nZ][BMap_nR] ;         
00306   Float_t  R3D[BMap_nR], Z3D[BMap_nZ], Phi3D[BMap_nPhi] ;         
00307 //Float_t  cmEr[EMap_nZ][EMap_nPhi][EMap_nR],    cmEphi[EMap_nZ][EMap_nPhi][EMap_nR]  ;
00308 //Float_t  endEr[EMap_nZ][EMap_nPhi][EMap_nR],   endEphi[EMap_nZ][EMap_nPhi][EMap_nR] ;
00309   Float_t  shiftEr[EMap_nZ][EMap_nR] ;
00310   Float_t  spaceEr[EMap_nZ][EMap_nR] ;
00311   Float_t  spaceR2Er[EMap_nZ][EMap_nR] ;
00312   Float_t  shortEr[EMap_nZ][EMap_nR] ;
00313   Float_t  GGVoltErrorEr[EMap_nZ][EMap_nR] ;
00314 
00315   static   Float_t ePhiList[EMap_nPhi] ;   // Note: These are initialized near CommonStart() in the .cxx file
00316   static   Float_t eRList[EMap_nR]     ;
00317   static   Float_t eZList[EMap_nZ]     ;
00318 
00319  public:
00320 
00321   StMagUtilities () ;
00322   StMagUtilities ( StTpcDb* dbin,  TDataSet* dbin2, Int_t mode = 0 ) ;
00323   StMagUtilities ( const EBField map, const Float_t factor, Int_t mode = 0 ) ;
00324   virtual ~StMagUtilities () { fgInstance = 0; }
00325   static StMagUtilities* Instance() { return fgInstance; }
00326 
00327   virtual void    BField ( const Float_t x[], Float_t B[] ) ;
00328   virtual void    BrBzField( const Float_t r, const Float_t z, Float_t &Br_value, Float_t &Bz_value ) ;
00329   virtual void    B3DField ( const Float_t x[], Float_t B[] ) ;
00330   virtual void    BrBz3DField ( const Float_t r, const Float_t z, const Float_t phi,
00331                                 Float_t &Br_value, Float_t &Bz_value, Float_t &Bphi_value ) ;
00332   virtual void    DoDistortion ( const Float_t x[], Float_t Xprime[] , Int_t Sector = -1 ) ;
00333   virtual void    UndoDistortion ( const Float_t x[], Float_t Xprime[] , Int_t Sector = -1 ) ;
00334   virtual void    UndoBDistortion ( const Float_t x[], Float_t Xprime[] , Int_t Sector = -1 ) ;
00335   virtual void    Undo2DBDistortion ( const Float_t x[], Float_t Xprime[] , Int_t Sector = -1 ) ;
00336   virtual void    FastUndoBDistortion ( const Float_t x[], Float_t Xprime[] , Int_t Sector = -1 ) ;
00337   virtual void    FastUndo2DBDistortion ( const Float_t x[], Float_t Xprime[] , Int_t Sector = -1 ) ;
00338   virtual void    UndoPad13Distortion ( const Float_t x[], Float_t Xprime[] , Int_t Sector = -1 ) ;
00339   virtual void    UndoTwistDistortion ( const Float_t x[], Float_t Xprime[] , Int_t Sector = -1 ) ;
00340   virtual void    UndoClockDistortion ( const Float_t x[], Float_t Xprime[] , Int_t Sector = -1 ) ;
00341   virtual void    UndoMembraneDistortion ( const Float_t x[], Float_t Xprime[] , Int_t Sector = -1 ) ;
00342   virtual void    UndoEndcapDistortion ( const Float_t x[], Float_t Xprime[] , Int_t Sector = -1 ) ;
00343   virtual void    UndoSpaceChargeDistortion ( const Float_t x[], Float_t Xprime[] , Int_t Sector = -1 ) ;
00344   virtual void    UndoSpaceChargeR2Distortion ( const Float_t x[], Float_t Xprime[] , Int_t Sector = -1 ) ;
00345   virtual void    UndoGridLeakDistortion ( const Float_t x[], Float_t Xprime[] , Int_t Sector = -1 ) ;
00346   virtual void    Undo3DGridLeakDistortion ( const Float_t x[], Float_t Xprime[] , Int_t Sector = -1 ) ;
00347   virtual void    UndoIFCShiftDistortion ( const Float_t x[], Float_t Xprime[] , Int_t Sector = -1 ) ;
00348   virtual void    UndoShortedRingDistortion ( const Float_t x[], Float_t Xprime[] , Int_t Sector = -1 ) ;
00349   virtual void    UndoGGVoltErrorDistortion ( const Float_t x[], Float_t Xprime[], Int_t Sector = -1 ) ;
00350   virtual void    UndoSectorAlignDistortion ( const Float_t x[], Float_t Xprime[], Int_t Sector = -1 ) ;
00351 
00352   virtual void    FixSpaceChargeDistortion ( const Int_t Charge, const Float_t x[3], const Float_t p[3],
00353                                              const Prime PrimaryOrGlobal, 
00354                                              Float_t x_new[3], Float_t p_new[3],
00355                                              const unsigned int RowMask1 = 0xFFFFFF00 , 
00356                                              const unsigned int RowMask2 = 0x1FFFFF,
00357                                              const Float_t VertexError = 0.0200 ) ;
00358 
00359   virtual void    ApplySpaceChargeDistortion ( const Double_t sc, const Int_t Charge, 
00360                                                const Float_t x[3], const Float_t p[3], 
00361                                                const Prime PrimaryOrGlobal, Int_t &new_Charge, 
00362                                                Float_t x_new[3], Float_t p_new[3],
00363                                                const unsigned int RowMask1 = 0xFFFFFF00 , 
00364                                                const unsigned int RowMask2 = 0x1FFFFF,
00365                                                const Float_t VertexError = 0.0200 ) ;
00366 
00367   virtual Int_t   PredictSpaceChargeDistortion ( Int_t   Charge, 
00368                                                  Float_t Pt, 
00369                                                  Float_t VertexZ, 
00370                                                  Float_t PseudoRapidity, 
00371                                                  Float_t DCA,  
00372                                                  const unsigned int RowMask1, 
00373                                                  const unsigned int RowMask2, 
00374                                                  Float_t &pSpace ) ;
00375 
00376   virtual Int_t   PredictSpaceChargeDistortion ( Int_t   Charge, 
00377                                                  Float_t Pt, 
00378                                                  Float_t VertexZ, 
00379                                                  Float_t PseudoRapidity, 
00380                                                  Float_t Phi,
00381                                                  Float_t DCA,  
00382                                                  const unsigned int RowMask1, 
00383                                                  const unsigned int RowMask2, 
00384                                                  Float_t RowMaskErrorR[64], 
00385                                                  Float_t RowMaskErrorRPhi[64], 
00386                                                  Float_t &pSpace ) ;
00387 
00388   virtual void    ManualShortedRing ( Int_t EastWest, Int_t InnerOuter, 
00389                                       Float_t RingNumber, Float_t MissingRValue, Float_t ExtraRValue) ;
00390 
00391   virtual Int_t    GetSpaceChargeMode();
00392   virtual void     ManualSpaceCharge(Double_t SpcChg)   { SpaceCharge   = SpcChg ; fSpaceCharge   = 0 ; }
00393   virtual void     ManualSpaceChargeR2(Double_t SpcChg, Float_t EWRatio = 1.0 ) { SpaceChargeR2 = SpcChg ; fSpaceChargeR2 = 0 ; 
00394                                                                                   SpaceChargeEWRatio = EWRatio ; }
00395   virtual void     ManualGridLeakStrength(Double_t inner, Double_t middle, Double_t outer);
00396   virtual void     ManualGridLeakRadius  (Double_t inner, Double_t middle, Double_t outer);
00397   virtual void     ManualGridLeakWidth   (Double_t inner, Double_t middle, Double_t outer);
00398   virtual void     AutoSpaceCharge()   {GetSpaceCharge()  ; } // use DB
00399   virtual void     AutoSpaceChargeR2() {GetSpaceChargeR2(); } // use DB
00400   virtual Double_t CurrentSpaceCharge()   {return SpaceCharge  ;}
00401   virtual Double_t CurrentSpaceChargeR2() {return SpaceChargeR2;}
00402   virtual Float_t  CurrentSpaceChargeEWRatio() { return SpaceChargeEWRatio ; }
00403   virtual Bool_t   UpdateShortedRing();
00404   virtual void     UseManualSCForPredict(Bool_t flag=kTRUE) { useManualSCForPredict=flag; };
00405   virtual void     ManualGGVoltError(Double_t east, Double_t west);
00406 
00407   ClassDef(StMagUtilities,1)    // Base class for all STAR MagField
00408 
00409 };
00410 
00411 #endif
00412 
00413 
00414 
00415 
00416 
00417 
00418 
00419