DcsRadonLevelFinder.cxx

Go to the documentation of this file.

#include <cmath>
#include <algorithm>

#include "Conventions/SimFlag.h"
#include "DatabaseInterface/DbiSqlContext.h"
#include "DatabaseInterface/DbiServices.h"
#include "DcsUser/DcsRadonLevelFinder.h"
#include "MessageService/MsgService.h"

ClassImp(DcsRadonLevelFinder)

// Minimum time margin in secs either side of query date for fRadonLevelTable to satisfy results.
#define TIME_MARGIN  24*60*60.

// Define the default time window for new queries
#define TIME_WINDOW  30*24*60*60.

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

CVSID("$Id: DcsRadonLevelFinder.cxx,v 1.1 2009/06/02 21:24:56 nwest Exp $\n  CVSID_DBIRESULTPTR ");

DcsRadonLevelFinder* DcsRadonLevelFinder::fgDcsRadonLevelFinder = 0;

// Binary functor to compare times of 2 Dcs_Radon_Level objects.
struct earlier : public binary_function<const Dcs_Radon_Level*,const Dcs_Radon_Level*, bool> {
  bool operator()(const Dcs_Radon_Level* first,const Dcs_Radon_Level* second) { 
    return first->GetTimeStamp() < second->GetTimeStamp();
  }
};

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

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

DcsRadonLevelFinder::DcsRadonLevelFinder() :
  fDetector(Detector::kNear),
  IsGlobalVersion(false) {

}

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

DcsRadonLevelFinder::DcsRadonLevelFinder(VldTimeStamp start, VldTimeStamp end, Detector::Detector_t detector) :
  fDetector(Detector::kNear),
  IsGlobalVersion(false) {
  this->NewQuery(start,end,detector);

}

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

DcsRadonLevelFinder* DcsRadonLevelFinder::Instance() {
  if (! fgDcsRadonLevelFinder ) {
    fgDcsRadonLevelFinder = new DcsRadonLevelFinder();
    fgDcsRadonLevelFinder->IsGlobalVersion = true;
  }
  return fgDcsRadonLevelFinder;
}

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

Float_t DcsRadonLevelFinder::GetRadonLevel(VldContext context, Int_t numPoints /* = 0 */) {

  // See: GetRadonLevel(VldTimeStamp date, Detector::Detector_t detector, Int_t numPoints = 0);

  VldTimeStamp date(context.GetTimeStamp());
  Detector::Detector_t detector(context.GetDetector());
  SimFlag::SimFlag_t simflag(context.GetSimFlag());
  // Only have tables for Near and Far data.
  if ( simflag !=  SimFlag::kData || ( detector != Detector::kNear && detector != Detector::kFar ) ) return -999.;
  return this->GetRadonLevel(date,detector,numPoints);

}

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

Float_t DcsRadonLevelFinder::GetRadonLevel(VldTimeStamp date, Detector::Detector_t detector, Int_t numPoints /* = 0 */) {

  //  Return the radon level in detector 'detector' at date 'date' or -999. if unable to get the value.
  //  If numPoints <= 0 do linear interpolation between the closest two points in time.
  //  If numPoints >  0 find average of the numPoints nearest points in time.

  // If the current data is no good perform a new query if permitted.
  if ( ! this->HasGoodData(date,detector) ) {
    // Privately owned objects are not automatically updated when the current data is no good.
    if ( ! IsGlobalVersion ) return -999.;

    // For the Singleton (public) object form a new query with the required date near the start of the
    // range in anticipation that future queries will use later dates.
    this->NewQuery(VldTimeStamp(date.GetSeconds() - 2*TIME_MARGIN),
                   VldTimeStamp(date.GetSeconds() + TIME_WINDOW),
                   detector);
    if ( ! this->HasGoodData(date,detector) ) return -999.;
  }

  // Collect data points near in time to the request date into a buffer.
  struct data_point {Float_t relative_time; Float_t level;};
#define MAX_POINTS 50
  data_point buff[MAX_POINTS];

  if ( numPoints > MAX_POINTS ) numPoints = MAX_POINTS;

  // If interpolating use nearest 2 points.
  Bool_t interpolate = false;
  if ( numPoints <= 0 ) {
    interpolate = true;
    numPoints   = 2;
  }

  // Process rows of fRadonLevelTable until buff contains the nearest numPoints of data to required date.
  Bool_t tableFull = false;
  Int_t nextSlot   = 0; 

  Float_t required_time(date.GetSeconds());
  Int_t numRows(fRadonLevelTable.size());

  for (Int_t i_row = 0; i_row < numRows; ++i_row ) {
    const Dcs_Radon_Level& row(*fRadonLevelTable[i_row]);
    if ( ! row.IsValidEntry() ) continue;
    Float_t relative_time(row.GetTimeStamp().GetSeconds() - required_time);

    // Once the buffer is full, only continue to collect data if the 
    // current point is nearer that the one it is replacing.
    if ( tableFull && abs(buff[nextSlot].relative_time) < abs(relative_time) ) break;
    buff[nextSlot].relative_time = relative_time;
    buff[nextSlot].level         = row.GetRadonLevel();
    ++nextSlot;
    if ( nextSlot >=  numPoints ) {
      tableFull = true;
      nextSlot  = 0;
    }

  }

  // Determine the number of points in the buffer and deal with cases of 0 or 1 points
  if ( ! tableFull ) numPoints = nextSlot;

  if ( numPoints == 0 ) return -999.;
  if ( numPoints == 1 ) return buff[0].level;

  // Deal with 2 point interpolation.
  if ( interpolate ) {
    Float_t t1(buff[0].relative_time);
    Float_t t2(buff[1].relative_time);
    Float_t l1(buff[0].level);
    Float_t l2(buff[1].level);
    if ( t1 == t2 ) return (l1+l2)/2.;
    return (t1*l2 - t2*l1)/(t1-t2);
  }

  // Deal with average
  Float_t sum_l(0.);
  for (Int_t i_point = 0; i_point < numPoints; ++i_point ) sum_l += buff[i_point].level;
  return sum_l/numPoints;

}


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

Bool_t DcsRadonLevelFinder::HasGoodData(VldTimeStamp date, Detector::Detector_t detector) const {

  //  Return true if the current fRadonLevelTable is can be used to satisfy query for supplied date and detector

  if ( detector != fDetector ) return false;

  Int_t numRows(fRadonLevelTable.size());
  if ( numRows < 1 )  return false;
  if (    fRadonLevelTable[0]->GetTimeStamp()         > VldTimeStamp(date.GetSeconds() - TIME_MARGIN)
       or fRadonLevelTable[numRows-1]->GetTimeStamp() < VldTimeStamp(date.GetSeconds() + TIME_MARGIN) )  return false;
  return true;

}

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

void DcsRadonLevelFinder::NewQuery(VldTimeStamp start, VldTimeStamp end, Detector::Detector_t detector) {

  // Construct query.
  DbiSqlContext sqlContext(DbiSqlContext::kOverlaps,start,end,detector,SimFlag::kData);

  // Execute query.
  fQueryResults.NewQuery(sqlContext,0);

  // Perpare time ordered vector of pointers to the results.
  Int_t numRows(fQueryResults.GetNumRows());
  fRadonLevelTable.resize(numRows); 
  for (Int_t i_row = 0; i_row < numRows; ++i_row) fRadonLevelTable[i_row] = fQueryResults.GetRow(i_row);
  sort(fRadonLevelTable.begin(),fRadonLevelTable.end(),earlier());

  fDetector = detector;

}

---