BfldDbiPlaneMap.cxx

Go to the documentation of this file.

// $Id: BfldDbiPlaneMap.cxx,v 1.17 2008/03/14 05:14:13 rhatcher Exp $
//
// BfldDbiPlaneMap
//
// Package: BField
//
// Concept: DBI table to record when what maps to use for which planes
//          in the detector (at any given VldContext)
//
//
// Author: R. Hatcher 2003-05-29
//

#include "BField/BfldDbiPlaneMap.h"
#include "MessageService/MsgService.h"
#include "DatabaseInterface/DbiOutRowStream.h"
#include "DatabaseInterface/DbiResultSet.h"
#include "DatabaseInterface/DbiValidityRec.h"

#include "TMath.h"

#include <cassert>
#include <string.h>

using std::string;
using std::vector;

ClassImp(BfldDbiPlaneMap)

CVSID("$Id: BfldDbiPlaneMap.cxx,v 1.17 2008/03/14 05:14:13 rhatcher Exp $ CVSID_DBIRESULTPTR ");

//  Instantiate associated Result Pointer class.
//  *******************************************

#include "DatabaseInterface/DbiResultPtr.tpl"
template class  DbiResultPtr<BfldDbiPlaneMap>;

#include "DatabaseInterface/DbiWriter.tpl"
template class  DbiWriter<BfldDbiPlaneMap>;

//   Definition of static data members
//   *********************************

Bool_t BfldDbiPlaneMap::fgDefensiveUnpkg = kTRUE;

// Definition of member functions (alphabetical order)
// ***************************************************


//.....................................................................

BfldDbiPlaneMap::BfldDbiPlaneMap() 
  : fPlaneId(), 
    fDetailSize(0), fDetailShape(kCircle), fBHCurve(0), 
    fBHFactor(0), fBHCutoff(0), 
    fSlotFactor(0), fSlotCutoff(0), fBdotScale(1.0)
{
  for ( int indx = 0; indx < kEndOfList; ++indx ) {
    fMapVariant[indx] = 0;
    fScale[indx]      = 0.0;
  }
  LEA_CTOR;
}

//.....................................................................

void BfldDbiPlaneMap::Fill(DbiResultSet& rs,
                                      const DbiValidityRec* vrec) {
//
//
//  Purpose:  Fill object from Result Set
//
//  Arguments: 
//    rs           in    Result Set used to fill object
//    vrec         in    Associated validity record (or 0 if filling
//                                                    DbiValidityRec)
//
//  Return:    
//
//  Contact:   R. Hatcher
//
//  Specification:-
//  =============
//
//  o Fill object from current row of Result Set.

//  Program Notes:-
//  =============

//  None.


   UShort_t ipln = 1023;

   if (fgDefensiveUnpkg) {

      // unpack allowing for various column names and ordering

      Int_t tmpshape = fDetailShape;

      Int_t numCol = rs.NumCols();
      //  The first column (SeqNo) has already been processed.
      for (Int_t curCol = rs.HasRowCounter() ? 3 : 2; curCol <= numCol; ++curCol) {
         string colName = rs.CurColName();

         if (      colName == "PLANENUM")      rs >> ipln;

         // old column names
         else if ( colName == "MAPVAR")        rs >> fMapVariant[0];
         else if ( colName == "SCALE")         rs >> fScale[0];
         else if ( colName == "MAPVAR_2ND")    rs >> fMapVariant[1];
         else if ( colName == "SCALE_2ND")     rs >> fScale[1];

         // new column names
         else if ( colName == "MAPVAR1ON")     rs >> fMapVariant[0];
         else if ( colName == "SCALE1ON")      rs >> fScale[0];
         else if ( colName == "MAPVAR2ON")     rs >> fMapVariant[1];
         else if ( colName == "SCALE2ON")      rs >> fScale[1];
         else if ( colName == "MAPVAR1OFF")    rs >> fMapVariant[2];
         else if ( colName == "SCALE1OFF")     rs >> fScale[2];
         else if ( colName == "MAPVAR2OFF")    rs >> fMapVariant[3];
         else if ( colName == "SCALE2OFF")     rs >> fScale[3];
         // yet newer names
         else if ( colName == "MAPON1")         rs >> fMapVariant[0];
         else if ( colName == "SCALEON1")       rs >> fScale[0];
         else if ( colName == "MAPON2")         rs >> fMapVariant[1];
         else if ( colName == "SCALEON2")       rs >> fScale[1];
         else if ( colName == "MAPOFF1")        rs >> fMapVariant[2];
         else if ( colName == "SCALEOFF1")      rs >> fScale[2];
         else if ( colName == "MAPOFF2")        rs >> fMapVariant[3];
         else if ( colName == "SCALEOFF2")      rs >> fScale[3];

         // new columns
         else if ( colName == "MAPDETAIL1")     rs >> fMapVariant[4];
         else if ( colName == "SCALEDETAIL1")   rs >> fScale[4];
         else if ( colName == "MAPDETAIL2")     rs >> fMapVariant[5];
         else if ( colName == "SCALEDETAIL2")   rs >> fScale[5];
         else if ( colName == "MAPPLNGAP1")     rs >> fMapVariant[6];
         else if ( colName == "SCALEPLNGAP1")   rs >> fScale[6];
         else if ( colName == "MAPPLNGAP2")     rs >> fMapVariant[7];
         else if ( colName == "SCALEPLNGAP2")   rs >> fScale[7];

         // new (more descriptive) names
         else if ( colName == "MAPDETAILGAP1")    rs >> fMapVariant[6];
         else if ( colName == "SCALEDETAILGAP1")  rs >> fScale[6];
         else if ( colName == "MAPDETAILGAP2")    rs >> fMapVariant[7];
         else if ( colName == "SCALEDETAILGAP2")  rs >> fScale[7];

         // newest columns
         else if ( colName == "MAPFULLGAP1")    rs >> fMapVariant[8];
         else if ( colName == "SCALEFULLGAP1")  rs >> fScale[8];
         else if ( colName == "MAPFULLGAP2")    rs >> fMapVariant[9];
         else if ( colName == "SCALEFULLGAP2")  rs >> fScale[9];

         else if ( colName == "DETAILSIZE")     rs >> fDetailSize;
         else if ( colName == "DETAILSHAPE")    rs >> tmpshape;

         else if ( colName == "BDOTSCALE")      rs >> fBdotScale;

         else if ( colName == "BHCURVEINDEX")   rs >> fBHCurve;
         else if ( colName == "BHFACTOR")       rs >> fBHFactor;
         else if ( colName == "BHCUTOFF")       rs >> fBHCutoff;
         else if ( colName == "SLOTFACTOR")     rs >> fSlotFactor;
         else if ( colName == "SLOTCUTOFF")     rs >> fSlotCutoff;

         else {
            static int nmsg = 25;
            if (nmsg-- > 0) MSG("Bfld",Msg::kWarning) 
               << "Ignoring column " << rs.CurColNum() 
               << " (of " << rs.NumCols() << ")"
               << " \""<< colName << "\"; not part of "
               << ClassName() << endl;
            rs.IncrementCurCol();
         } // end of conditional if/elseif/else/
      } // end of loop
      fDetailShape = (MapShape_t)tmpshape;
   } // end defensive unpacking
   else {
      Int_t numCol = rs.NumCols() - (rs.HasRowCounter() ? 1 : 0);
      if ( 4 == numCol ) {
        rs >> ipln
           >> fMapVariant[0]
           >> fScale[0];
      }
      else if ( 6 == numCol ) {
        rs >> ipln
           >> fMapVariant[0]
           >> fScale[0]
           >> fMapVariant[1]
           >> fScale[1];
      }
      else if ( 7 == numCol ) {
        rs >> ipln
           >> fMapVariant[0]
           >> fScale[0]
           >> fMapVariant[1]
           >> fScale[1]
           >> fBHCurve;
      }
      else if ( 11 == numCol ) {
        rs >> ipln
           >> fMapVariant[0]
           >> fScale[0]
           >> fMapVariant[1]
           >> fScale[1]
           >> fBHCurve
           >> fBHFactor
           >> fBHCutoff
           >> fSlotFactor
           >> fSlotCutoff;
      }
      else if ( 15 == numCol ) {
        rs >> ipln
           >> fMapVariant[0]
           >> fScale[0]
           >> fMapVariant[1]
           >> fScale[1]
           >> fMapVariant[2]
           >> fScale[2]
           >> fMapVariant[3]
           >> fScale[3]
           >> fBHCurve
           >> fBHFactor
           >> fBHCutoff
           >> fSlotFactor
           >> fSlotCutoff;
      }
      else if ( 25 == numCol ) {
        int tmpshape;
        rs >> ipln
           >> fMapVariant[0]
           >> fScale[0]
           >> fMapVariant[1]
           >> fScale[1]
           >> fMapVariant[2]
           >> fScale[2]
           >> fMapVariant[3]
           >> fScale[3]
           >> fMapVariant[4]
           >> fScale[4]
           >> fMapVariant[5]
           >> fScale[5]
           >> fMapVariant[6]
           >> fScale[6]
           >> fMapVariant[7]
           >> fScale[7]
           >> fDetailSize
           >> tmpshape
           >> fBHCurve
           >> fBHFactor
           >> fBHCutoff
           >> fSlotFactor
           >> fSlotCutoff;
        fDetailShape = (MapShape_t)tmpshape;
      }
      else if ( 30 == numCol ) {
        int tmpshape;
        rs >> ipln
           >> fMapVariant[0]
           >> fScale[0]
           >> fMapVariant[1]
           >> fScale[1]
           >> fMapVariant[2]
           >> fScale[2]
           >> fMapVariant[3]
           >> fScale[3]
           >> fMapVariant[4]
           >> fScale[4]
           >> fMapVariant[5]
           >> fScale[5]
           >> fMapVariant[6]
           >> fScale[6]
           >> fMapVariant[7]
           >> fScale[7]
           >> fMapVariant[8]
           >> fScale[8]
           >> fMapVariant[9]
           >> fScale[9]
           >> fDetailSize
           >> tmpshape
           >> fBdotScale
           >> fBHCurve
           >> fBHFactor
           >> fBHCutoff
           >> fSlotFactor
           >> fSlotCutoff;
        fDetailShape = (MapShape_t)tmpshape;
      }
      else {
        static int nmsg = 25;
        if (nmsg-- > 0) MSG("Bfld",Msg::kWarning) 
          << "Table has " << numCol << " columns, but in non-Defensive unpacking "
          << "we only know how to deal with 4, 6, 7, 11, 15, 25 or 30."
          << endl;                          
      }
    }

    Detector::Detector_t det =
      (Detector::Detector_t) 
      ((vrec) ? vrec->GetVldRange().GetDetectorMask() : 0);

    fPlaneId = PlexPlaneId(det,ipln,kTRUE);

#ifdef RWH_DEBUG
    if ( ipln == 0 )
      MSG("Bfld",Msg::kDebug) 
           << " BfldDbiPlaneMap plane " 
           << ipln << " vrec = " << *vrec
           << endl
           << *this
           << endl;
#endif

}

//.....................................................................

void BfldDbiPlaneMap::Store(DbiOutRowStream& ors,
                          const DbiValidityRec* /* vrec */) const {
//
//
//  Purpose:  Stream object to output row stream
//
//  Arguments: 
//    ors          in     Output row stream.
//    vrec         in     Associated validity record (or 0 if filling
//                                                    DbiValidityRec)
//
//  Return:    
//
//  Contact:   R. Hatcher
//
//  Specification:-
//  =============
//
//  o  Stream object to output row stream.

//  Program Notes:-
//  =============

//  None.

  Int_t numCol = ors.NumCols() - (ors.HasRowCounter() ? 1 : 0);
  if ( 4 == numCol ) {
    ors << fPlaneId.GetPlane() << fMapVariant[0] << fScale[0];
  }
  else if ( 6 == numCol ) {
    ors << fPlaneId.GetPlane() 
        << fMapVariant[0] << fScale [0]
        << fMapVariant[1] << fScale [1];
  }
  else if ( 8 == numCol ) {
    ors << fPlaneId.GetPlane() 
        << fMapVariant[0] << fScale [0]
        << fMapVariant[1] << fScale [1]
        << fBHCurve;
  }
  else if ( 11 == numCol ) {
    ors << fPlaneId.GetPlane() 
        << fMapVariant[0] << fScale [0]
        << fMapVariant[1] << fScale [1]
        << fBHCurve
        << fBHFactor      << fBHCutoff
        << fSlotFactor    << fSlotCutoff;
  }
  else if ( 15 == numCol ) {
    ors << fPlaneId.GetPlane() 
        << fMapVariant[0] << fScale [0]
        << fMapVariant[1] << fScale [1]
        << fMapVariant[2] << fScale [2]
        << fMapVariant[3] << fScale [3]
        << fBHCurve
        << fBHFactor      << fBHCutoff
        << fSlotFactor    << fSlotCutoff;
  }
  else if ( 25 == numCol ) {
    ors << fPlaneId.GetPlane()
        << fMapVariant[0] << fScale[0]
        << fMapVariant[1] << fScale[1]
        << fMapVariant[2] << fScale[2]
        << fMapVariant[3] << fScale[3]
        << fMapVariant[4] << fScale[4]
        << fMapVariant[5] << fScale[5]
        << fMapVariant[6] << fScale[6]
        << fMapVariant[7] << fScale[7]
        << fDetailSize    << (int)fDetailShape
        << fBHCurve
        << fBHFactor
        << fBHCutoff
        << fSlotFactor
        << fSlotCutoff;
  }
  else if ( 25 == numCol ) {
    ors << fPlaneId.GetPlane()
        << fMapVariant[0] << fScale[0]
        << fMapVariant[1] << fScale[1]
        << fMapVariant[2] << fScale[2]
        << fMapVariant[3] << fScale[3]
        << fMapVariant[4] << fScale[4]
        << fMapVariant[5] << fScale[5]
        << fMapVariant[6] << fScale[6]
        << fMapVariant[7] << fScale[7]
        << fMapVariant[8] << fScale[8]
        << fMapVariant[9] << fScale[9]
        << fDetailSize    << (int)fDetailShape
        << fBdotScale
        << fBHCurve
        << fBHFactor
        << fBHCutoff
        << fSlotFactor
        << fSlotCutoff;
  }
  else {
    static int nmsg = 25;
    if (nmsg-- > 0) MSG("Bfld",Msg::kWarning) 
      << "Table has " << numCol << " columns, but Store() "
      << "we only know how to deal with 4, 6, 7, 11, 15, 25 or 30."
      << endl;                          
  }
}

//.....................................................................
void BfldDbiPlaneMap::SetDetailShape(Int_t ishape)
{ 
  fDetailShape = (MapShape_t)ishape; 
}

//.....................................................................
Bool_t BfldDbiPlaneMap::IsInDetail(Double_t x, Double_t y) const
{
  switch ( fDetailShape ) {
  case kCircle:
    {
      Double_t r2     = x*x + y*y;
      Double_t r2max  = fDetailSize * fDetailSize;
      if ( r2 >= r2max ) return false;
      return true;
      break;
    }
  case kDiamond:
    {
      // translate into U,V space and make same test as kSquare
      static const Double_t r_sqrt2 = 1.0 / TMath::Sqrt(2.0);
      Double_t u = ( x + y ) * r_sqrt2;
      Double_t v = (-x + y ) * r_sqrt2;
      x = u; y = v;  // fall through so we don't need to repeat the test
    }
  case kSquare:
    {
      if ( x <= -fDetailSize || x >= fDetailSize ) return false;
      if ( y <= -fDetailSize || y >= fDetailSize ) return false;
      return true;
      break;
    }
  default:
    return false;  // not legal
    break;
  }
  return false;  // not legal
}

//.....................................................................
Int_t BfldDbiPlaneMap::GetAggregateNo() const
{ 
  return (int)fPlaneId.GetDetector()*100000000 + fPlaneId.GetPlane();
}

//.....................................................................
UInt_t BfldDbiPlaneMap::GetIndex(UInt_t /* defIndex */) const
{ 
  return fPlaneId.GetPlane();
}

//.....................................................................
std::ostream& operator<<(std::ostream& os, const BfldDbiPlaneMap& plnmap)
{ return plnmap.FormatToOStream(os); }

//.....................................................................
void BfldDbiPlaneMap::Print(Option_t *option) const
{ FormatToOStream(cout,option); }

//.....................................................................
std::ostream& BfldDbiPlaneMap::FormatToOStream(std::ostream& os,
                                               Option_t * /* option */) const
{
  os << GetName() << " " 
     << fPlaneId.AsString("c"); 

  const char* shapename = "unknown";
  const char* shapelist[] = { "circle", "square", "diamond" };
  if ( fDetailShape >= 0 && fDetailShape <= 2 ) shapename = shapelist[fDetailShape];
  os << ", Detail size=" << fDetailSize
     << " shape=" << shapename;
  os << endl;

  int indxlabel = 0;
  const char* unknownlabel = "Unknown Map Pair: ";
  const char* labels[]   = { "Current On:       ",
                             "Current Off:      ",
                             "Steel Detail:     ",
                             "Gap Detail:       ",
                             "Gap Full Plane:   " };
  int nlabels = sizeof(labels)/sizeof(const char*);

  int indx = 0;
  while ( indx < kEndOfList-1 ) {  // -1 because we're doing A+B pairs
    const char* thislabel = unknownlabel;
    if ( indxlabel < nlabels ) thislabel = labels[indxlabel];
    os << "   " << thislabel;
    bool do1st = (fMapVariant[indx  ]!=0 && fScale[indx  ]!=0);
    bool do2nd = (fMapVariant[indx+1]!=0 && fScale[indx+1]!=0);
    if ( ! do1st && ! do2nd ) os << "no field maps ";
    if ( do1st ) os << fScale[indx  ] << "*Map_" << fMapVariant[indx  ];
    if ( do1st && do2nd ) os << " + ";
    if ( do2nd ) os << fScale[indx+1] << "*Map_" << fMapVariant[indx+1];
    os << endl;
    indx += 2;   // do in pairs
    indxlabel++; // move pair label index onward
  }

  os << "   BdotScale " << fBdotScale;
  os << " BHCurveIndex " << fBHCurve;
  os << " BHFactor " << fBHFactor << "/" << fBHCutoff;
  os << " SlotFactor " << fSlotFactor << "/" << fSlotCutoff;
  os << endl;

  return os;
}

//.....................................................................

const char* BfldDbiPlaneMap::GetTableDescr()
{
//
//
//  Purpose:  Return a string describing rows in the table
//            Used in creating temporary tables
//
//  Return:   const char* to parenthesized comma separated list
//            of column name and type pairs
//
//  Contact:   R. Hatcher
//
//  Specification:-
//  =============
//

//  Program Notes:-
//  =============

//  None.

   const char* const_tabledescr = "(\
       SEQNO             int,      \
       ROW_COUNTER       int,      \
       PLANENUM          int,      \
       MAPON1            int,      \
       SCALEON1          float,    \
       MAPON2            int,      \
       SCALEON2          float,    \
       MAPOFF1           int,      \
       SCALEOFF1         float,    \
       MAPOFF2           int,      \
       SCALEOFF2         float,    \
       MAPDETAIL1        int,      \
       SCALEDETAIL1      float,    \
       MAPDETAIL2        int,      \
       SCALEDETAIL2      float,    \
       MAPPLNGAP1        int,      \
       SCALEPLNGAP1      float,    \
       MAPPLNGAP2        int,      \
       SCALEPLNGAP2      float,    \
       MAPFULLGAP1       int,      \
       SCALEFULLGAP1     float,    \
       MAPFULLGAP2       int,      \
       SCALEFULLGAP2     float,    \
       DETAILSIZE        float,    \
       DETAILSHAPE       int,      \
       BHCURVEINDEX      int,      \
       BDOTSCALE         float,    \
       BHFACTOR          float,    \
       BHCUTOFF          float,    \
       SLOTFACTOR        float,    \
       SLOTCUTOFF        float,    \
       primary key (SEQNO,ROW_COUNTER) \
       )";

   return const_tabledescr;
}

//.....................................................................


/*    Template for New Member Function

//.....................................................................

BfldDbiPlaneMap:: {
//
//
//  Purpose:  
//
//  Arguments: 
//    xxxxxxxxx    in    yyyyyy
//
//  Return:    
//
//  Contact:   R. Hatcher
//
//  Specification:-
//  =============
//
//  o 

//  Program Notes:-
//  =============

//  None.


}

*/

---