StBTofINLCorr.cxx

/*******************************************************************
 *
 * $Id: StBTofINLCorr.cxx,v 1.11 2013/12/06 23:27:59 geurts Exp $
 *
 * Author: Xin Dong
 *****************************************************************
 *
 * Description: INL correction for all TDIG board channels
 *
 *****************************************************************
 *
 * $Log: StBTofINLCorr.cxx,v $
 * Revision 1.11  2013/12/06 23:27:59  geurts
 * improve diagnostics in log output (when comparing max ranges to actual ranges)
 *
 * Revision 1.10  2012/12/14 06:35:41  geurts
 * Changed global database calls to direct table access and/or removed deprecated database access code.
 *
 * Revision 1.9  2012/02/11 02:13:23  geurts
 * allow direct access to INL corrections given TDIG-Id
 *
 * Revision 1.8  2010/05/25 22:09:44  geurts
 * improved database handling and reduced log output
 *
 * Revision 1.7  2009/12/14 19:38:30  dongx
 * - mNValidBoards set by the read-in database entrie instead of a hard-coded number
 * - clean up mNValidTrays and related functions (not needed since previous versions)
 *
 * Revision 1.6  2009/08/25 01:02:44  dongx
 * Correct the total # of rows read-in for the TDIGOnTray table
 *
 * Revision 1.5  2009/03/04 04:57:36  dongx
 * INL arrays changed from float to short - memory occupied reduced by a factor of 2
 *
 * Revision 1.4  2009/02/23 23:52:07  dongx
 * In case of missing INL tables in db, return the INL corr from the first element in db
 *
 * Revision 1.3  2009/02/13 23:32:52  dongx
 * fixed the crash when no INL table for some board is available
 *
 * Revision 1.2  2009/02/13 22:59:02  dongx
 * new tofINLSCorr table for full barrel system for Run 9++
 *
 * Revision 1.1  2009/02/02 21:57:51  dongx
 * first release - Barrel TOF INL correction functions
 *
 *
 *******************************************************************/
#include <iostream>
#include "tables/St_tofTDIGOnTray_Table.h"
#include "tables/St_tofINLSCorr_Table.h"
#include "StMessMgr.h"
#include "StMaker.h"
#include "StBTofINLCorr.h"

StBTofINLCorr::StBTofINLCorr()
{ 
  Reset();
}

StBTofINLCorr::~StBTofINLCorr()
{ 
  Reset();
}

void StBTofINLCorr::init() {
  Reset();
}

void StBTofINLCorr::init(StMaker *maker) {
  Reset();
  initFromDbase(maker);
}

void StBTofINLCorr::initFromDbase(StMaker *maker) {

  LOG_INFO << "[StBTofINLCorr] retrieving TDIGOnTray and INL correction tables ..." << endm;
  // Load configuration parameters from dbase

  TDataSet *mDbTOFDataSet = maker->GetDataBase("Calibrations/tof/tofTDIGOnTray");
  St_tofTDIGOnTray* tofTDIGOnTray = static_cast<St_tofTDIGOnTray*>(mDbTOFDataSet->Find("tofTDIGOnTray"));
  if(!tofTDIGOnTray) {
    LOG_ERROR << "unable to get tofTDIGOnTray table" << endm;
    return;
  }
  tofTDIGOnTray_st* tdigOnTray = static_cast<tofTDIGOnTray_st*>(tofTDIGOnTray->GetArray());

  Int_t numRows = tofTDIGOnTray->GetNRows();
  for (Int_t i=0;i<mNTray+2;i++) {
    Int_t trayId = (Int_t)tdigOnTray[i].trayId;

    if(trayId==mEastVpdTrayId) {  // east vpd
      for(Int_t j=0;j<mNTDIGOnTray;j++)
        mTdigOnEastVpd[j] = (Int_t)tdigOnTray[i].tdigId[j];
    } else if (trayId==mWestVpdTrayId) {  // west vpd
      for(Int_t j=0;j<mNTDIGOnTray;j++)
        mTdigOnWestVpd[j] = (Int_t)tdigOnTray[i].tdigId[j];
    } else if (trayId>0 && trayId<= mNTray) { // barrel Tray
      for(Int_t j=0;j<mNTDIGOnTray;j++)
        mTdigOnTray[trayId-1][j] = (Int_t)tdigOnTray[i].tdigId[j];
    }
  }

  mDbTOFDataSet = maker->GetDataBase("Calibrations/tof/tofINLSCorr");
  St_tofINLSCorr* tofINLCorr = static_cast<St_tofINLSCorr*>(mDbTOFDataSet->Find("tofINLSCorr"));
  if(!tofINLCorr) {
    LOG_ERROR << "unable to get tofINLSCorr table" << endm;
    return;
  }
  tofINLSCorr_st* inlcorr = static_cast<tofINLSCorr_st*>(tofINLCorr->GetArray());
  numRows = tofINLCorr->GetNRows();
  if(numRows>mNTDIGMAX*mNChanOnTDIG) {
    { LOG_WARN << "number of rows in tofINLSCorr table ("<< numRows<<") exceeds the array limit ("<<mNTDIGMAX*mNChanOnTDIG << ") in this function! Entries truncated !!!" << endm; }
  }
  Int_t NTdig = 0;
  Int_t tdigId_old = 0;
  for (Int_t i=0;i<numRows;i++) {
    if(NTdig>mNTDIGMAX) {
      { LOG_WARN << " number of boards read-in ("<< NTdig <<") exceeds the array limit ("<<mNTDIGMAX <<") in this function! NTDIG Truncated !!! " << endm; }
      NTdig = mNTDIGMAX;
      break;
    }

    int tdigId = (Int_t)(inlcorr[i].tdigId);
    int tdcChanId = (Int_t)(inlcorr[i].tdcChanId);
    if(tdigId!=tdigId_old) {
      mBoardId[NTdig] = tdigId;
      NTdig++;
    }
        
    tdigId_old = tdigId;

    LOG_DEBUG << " tdigId=" << tdigId << "  tdcChanId=" << tdcChanId << endm;
    for(Int_t j=0;j<mNChanMAX;j++) {
      Short_t corr = (Short_t)(inlcorr[i].INLCorr[j]);
      mINLCorr[NTdig-1][tdcChanId][j] = corr;
      
      if(maker->Debug()&&(j%200==0)) {
        LOG_DEBUG << " " << corr;
      }
    }
    if(maker->Debug()) { LOG_DEBUG << endm; }
  }

  LOG_INFO << "[StBTofINLCorr] Total number of boards: " << NTdig << endm;
  mNValidBoards = NTdig;

  // re-organize
  for(Int_t i=0;i<NTdig;i++) {
    int boardId = mBoardId[i];
    if(boardId>0 && boardId<=mNBoardIdMAX) {
      mBoardId2Index[boardId] = i;
    } else {
      { LOG_WARN<< " Warning! boardId " << boardId << " out of range!" << endm; }
    }
  }

  LOG_DEBUG << "[StBTofINLCorr] ... done" << endm;
}

void StBTofINLCorr::Reset() {

  for(Int_t i=0;i<mNTray;i++) {
    for(Int_t j=0;j<mNTDIGOnTray;j++) {
      mTdigOnTray[i][j] = 0;
    }
  }
  for(Int_t i=0;i<mNTDIGOnTray;i++) {
    mTdigOnEastVpd[i] = 0;
    mTdigOnWestVpd[i] = 0;
  }

  for(Int_t i=0;i<mNTDIGMAX;i++) {
    mBoardId[i] = 0;
    for(int j=0;j<mNChanOnTDIG;j++) {
      for(int k=0;k<mNChanMAX;k++) {
        mINLCorr[i][j][k] = 0;
      }
    }
  }
  for(Int_t i=0;i<mNBoardIdMAX;i++) {
    mBoardId2Index[i] = -1;
  }

  mNValidBoards = 0;
}

float StBTofINLCorr::getTdigINLCorr(int tdigId, int tdcChannel, int bin) {
  int index = mBoardId2Index[tdigId];          // index in the inl array
  if (tdcChannel<0||tdcChannel>23) {
    LOG_WARN << "TDC Channel (" << tdcChannel << ") out of range. Forcing default values" << endm;
    index = -999;
  }
  if(index<0||index>=mNValidBoards) {
    LOG_WARN << " Missing INL table for TDIG-Id = " << tdigId << endm;
    LOG_WARN << " Using the table from boardId # " << mBoardId[0] << " tdcchan # 0 " << endm;
//    return 0.0;
    return mINLCorr[0][0][bin]/100.;
  } else {
    return mINLCorr[index][tdcChannel][bin]/100.;
  }
}

float StBTofINLCorr::getTrayINLCorr(int trayId, int globalTdcChan, int bin) {
  if(trayId<=0 || trayId>mNTray) return 0.0;  // trayId 1-120
  if(globalTdcChan<0 || globalTdcChan>=mNGLOBALCHANMAX) return 0.0;
  if(bin<0 || bin>=mNChanMAX) return 0.0;

  int iTdig = globalTdcChan/mNChanOnTDIG;  // 0-7
  int boardId = mTdigOnTray[trayId-1][iTdig];
  if(boardId<=0 || boardId>mNBoardIdMAX) return 0.0;

  int index = mBoardId2Index[boardId];          // index in the inl array
  int tdcChan = globalTdcChan % mNChanOnTDIG;   // 0-23
  if(index<0||index>=mNValidBoards) {
    LOG_WARN << " Missing INL table for boardId = " << boardId << " on tray " << trayId << endm;
    LOG_WARN << " Using the table from boardId # " << mBoardId[0] << " tdcchan # 0 " << endm;
//    return 0.0;
    return mINLCorr[0][0][bin]/100.;
  } else {
    return mINLCorr[index][tdcChan][bin]/100.;
  }
}

float StBTofINLCorr::getVpdINLCorr(StBeamDirection eastwest, int globalTdcChan, int bin) {
  if(eastwest!=east && eastwest!=west) return 0.0;
  if(globalTdcChan<0 || globalTdcChan>=mNGLOBALCHANMAX) return 0.0;
  if(bin<0 || bin>=mNChanMAX) return 0.0;
  int iTdig = globalTdcChan/mNChanOnTDIG;  // 0-7

  int boardId = -1;
  if(eastwest==east) { // east pvpd
    boardId = mTdigOnEastVpd[iTdig];
  } else if(eastwest==west) {  // west pvpd
    boardId = mTdigOnWestVpd[iTdig];
  }
  if(boardId<=0 || boardId>mNBoardIdMAX) return 0.0;

  int index = mBoardId2Index[boardId];          // index in the inl array
  int tdcChan = globalTdcChan % mNChanOnTDIG;   // 0-23
  if(index<0||index>=mNValidBoards) {
    LOG_WARN << " Missing INL table for boardId = " << boardId << " on vpd " << eastwest << endm;
    LOG_WARN << " Using the table from boardId # " << mBoardId[0] << " tdcchan # 0 " << endm;
//    return 0.0;
    return mINLCorr[0][0][bin]/100.;
  } else {
    return mINLCorr[index][tdcChan][bin]/100.;
  }
}