PmtGeomInfoSvc.cc

Go to the documentation of this file.

#include "PmtGeomInfoSvc.h"
#include "PmtGeomInfo.h"

#include "DetDesc/IDetectorElement.h"
#include "DetDesc/ParamValidDataObject.h"
#include "Conventions/Detectors.h"

#include "GaudiKernel/SmartDataPtr.h"
#include "GaudiKernel/MsgStream.h"

// comment out MsgStream usage in get() and find() using //nomsg 


using namespace std;

PmtGeomInfoSvc::PmtGeomInfoSvc(const std::string& name, ISvcLocator *svc)
    : Service(name,svc)
    , m_detSvc(0)
    , m_detector(0)
{
    declareProperty("SiteIdUserParameter",m_SiteIdUserParameter="SiteID",
                    "Name of the user parameter attached to Site detector "
                    "elements that gives the packed Site ID number.");
    declareProperty("DetectorIdUserParameter", 
                    m_DetectorIdUserParameter="DetectorID",
                    "Name of the user parameter attached to Detector "
                    "detector elements that gives the fully qualified "
                    "packed Detector ID.");
    declareProperty("PmtIdUserParameter",m_PmtIdUserParameter="PmtID",
                    "Name of the user parameter attached to PMT detector "
                    "elements that gives the fully qualified packed PMT ID");
    std::vector<std::string> defaultStreamItems;
    defaultStreamItems.push_back("/dd/Structure/DayaBay");
    declareProperty("StreamItems",m_StreamItems=defaultStreamItems,
                    "List of top level Detector Elements.");
    declareProperty("EnableSabGeometry",m_enableSabGeometry=true,
                    "Workaround to allow for non-existent SAB geometry");
}

PmtGeomInfoSvc::~PmtGeomInfoSvc()
{
}



StatusCode PmtGeomInfoSvc::initialize()
{
    this->Service::initialize();

    MsgStream msg(msgSvc(),name());
    msg << MSG::DEBUG << "PmtGeomInfoSvc::initialize()" << endreq;

    StatusCode sc = service("DetectorDataSvc",m_detSvc,true);
    if (sc.isFailure()) return sc;

    msg << MSG::DEBUG << "Using IDs:"
        << " site: " << m_SiteIdUserParameter
        << " det: " << m_DetectorIdUserParameter
        << " pmt: " << m_PmtIdUserParameter
        << endreq;

    if (! m_StreamItems.size()) {
        msg << MSG::WARNING << "did not get any StreamItems, can not lookup PMTs" << endreq;
        return StatusCode::FAILURE;
    }
    for (size_t ind=0; ind<m_StreamItems.size(); ++ind) {
        string dename = m_StreamItems[ind];
        SmartDataPtr<IDetectorElement> obj(m_detSvc,dename);
        if (!obj) {
            MsgStream msg(msgSvc(),name());
            msg << MSG::WARNING << "Failed to get top Detector Element: \"" 
                << dename << "\", skipping" << endreq;
            sc = StatusCode::FAILURE;
            continue;
        }
        msg << MSG::DEBUG << "Adding top level Detector Element: \"" 
            << dename << endreq;
        m_topDEs.push_back(obj);
    }
    return sc;
}

StatusCode PmtGeomInfoSvc::reinitialize()
{
    return StatusCode::SUCCESS;
}

StatusCode PmtGeomInfoSvc::finalize()
{
    m_detSvc->release();

    // Delete all PmtGeomInfo's.....

    return StatusCode::SUCCESS;
}

IPmtGeomInfo* PmtGeomInfoSvc::get(std::string structure_path)
{
    //nomsg MsgStream msg(msgSvc(),name());
    //nomsg msg << MSG::DEBUG << "PmtGeomInfoSvc::get(path "<<structure_path<<")" << endreq;

    IPmtGeomInfo* pmtinfo = m_byPath[structure_path];
    if (pmtinfo) return pmtinfo;

    SmartDataPtr<IDetectorElement> obj(m_detSvc,structure_path);
    if (!obj) return 0;

    unsigned int pmtid = obj->params()->param<int>(m_PmtIdUserParameter);
    if (!pmtid) return 0;
    
    return this->add(pmtid,structure_path,obj);
}

IPmtGeomInfo* PmtGeomInfoSvc::get(IDetectorElement* pmtde)
{
    //nomsg MsgStream msg(msgSvc(),name());
    //nomsg msg << MSG::DEBUG << "PmtGeomInfoSvc::get(IDetectorElement "<<pmtde->name()<<")" << endreq;

    IPmtGeomInfo* pmtinfo = m_byDE[pmtde];
    if (pmtinfo) return pmtinfo;

    unsigned int pmtid = pmtde->params()->param<int>(m_PmtIdUserParameter);
    if (!pmtid) return 0;

    return this->add(pmtid,"",pmtde);
}

IPmtGeomInfo* PmtGeomInfoSvc::get(unsigned int pmtid)
{
    //nomsg MsgStream msg(msgSvc(),name());
    //nomsg msg << MSG::DEBUG << "PmtGeomInfoSvc::get(int "<<(void*)pmtid<<")" << endreq;
    

    /*
      algorithm: 

      * add site/detector values into high level detector elements in
      XML.

      * add isCompatible() method to Detectors.h, Returns true if bits
      * match, but not including fully zero'd bytes.

      * Search down /dd/Structure, check each DetectorElement for a
      * PmtID user parameter.  Failing that look for a DetectorID
      * parameter and if found check if value isCompatible() and
      * abandon branch if it isn't. Quit if DetectorElements are
      * exhausted or if one is found that matches the PMTID.

     */

    if(m_enableSabGeometry){
      // If site is SAB, use DYB near site instead.
      DayaBay::DetectorSensor sensor(pmtid);
      if(sensor.site() == Site::kSAB){
        static bool beenWarned = false;
        if(!beenWarned){
          //nomsg msg << MSG::WARNING << "Using Near site PMT positions for SAB"              << endreq;
          beenWarned = true;
        }
        DayaBay::DetectorSensor tempSensor(sensor.sensorId(),
                                           Site::kDayaBay,
                                           sensor.detectorId());
        pmtid = tempSensor.fullPackedData();
      }
    }

    // Have we seen you before?
    IPmtGeomInfo* pmtinfo = m_byId[pmtid];
    if (pmtinfo) {
        //nomsg msg << MSG::DEBUG << "Found "<< (void*)pmtid << ", seen before"<<endreq;
        return pmtinfo;
    }

    // Let's first do a quick check in the last detector we saw
    if (m_detector) {
        //nomsg msg << MSG::DEBUG << "Looking for "<< (void*)pmtid             << " in "<< m_detector->name() << endreq;
        pmtinfo = this->find(pmtid,m_detector);
        if (pmtinfo) {
            //nomsg msg << MSG::DEBUG << "Found "<< (void*)pmtid                << " after quick check"<<endreq;
            return pmtinfo;
        }
        m_detector = 0;
    }

    // No luck, do a full search starting from top level DEs
    for (size_t ind=0; ind<m_topDEs.size(); ++ind) {
        //nomsg msg << MSG::DEBUG << "Looking for "<< (void*)pmtid             << " in "<< m_topDEs[ind]->name() << endreq;
        pmtinfo = this->find(pmtid,m_topDEs[ind]);
        if (pmtinfo) {
            //nomsg msg << MSG::DEBUG << "Found "<< (void*)pmtid                << " after full search"<<endreq;
            return pmtinfo;
        }
    }
    //nomsg msg << MSG::DEBUG << "Failed to find PMT ID "<< (void*)pmtid << endreq;
    return 0;
}

IPmtGeomInfo* PmtGeomInfoSvc::find(unsigned int pmtid, IDetectorElement* de)
{
    //nomsg MsgStream msg(msgSvc(),name());
    //nomsg msg << MSG::DEBUG << "PmtGeomInfoSvc::find(int "<<(void*)pmtid        <<","<<de->name()<<")" << endreq;

    const ParamValidDataObject* params = de->params();
    // Check if DE is a PMT.  If current DE has a PmtID we are done
    // for good or bad.
    if (de->params()->exists(m_PmtIdUserParameter)) {
        unsigned int this_pmtid = (unsigned int)(params->param<int>(m_PmtIdUserParameter));
        if (pmtid == this_pmtid) {
            //nomsg msg << MSG::DEBUG << "found PMT ID " << (void*)pmtid << endreq;
            return this->add(pmtid,"",de);
        }
        //nomsg msg << MSG::DEBUG << "got PMT ID but wrong one "            << (void*)this_pmtid << " != " << (void*)pmtid << endreq;
        return 0;
    }

    // Check if DE is a Detector.  If current DE has a DetectorID we
    // check for compatibility and cache or bail out.
    if (de->params()->exists(m_DetectorIdUserParameter)) {
        unsigned int detid = 
            (unsigned int)(params->param<int>(m_DetectorIdUserParameter));
        //nomsg msg << MSG::DEBUG << "checking Detector ID "            << (void*)detid << " =?= " << (void*)(pmtid) << endreq;

        if ( (pmtid&0xffff0000) == detid) { 
            //nomsg msg << MSG::DEBUG << "found Detector ID "                << (void*)detid << " for " << (void*)(pmtid) << endreq;
            m_detector = de;    // We have a winner!
        }
        else {                  // We have a detector, but the wrong one
            //nomsg msg << MSG::DEBUG << "got Detector ID but wrong one "                << (void*)detid << " != " << (void*)(pmtid&0xffff0000) << endreq;
        }
    }

    // Check if DE is a Site.  If current DE has a SiteID we bail out
    // if it isn't compatible.
    if (params->exists(m_SiteIdUserParameter)) {
        unsigned int siteid = 
            (unsigned int)(params->param<int>(m_SiteIdUserParameter));
        if ( (pmtid&0xff000000) != siteid) {
            //nomsg msg << MSG::DEBUG << "got Site ID but wrong one "                << (void*)siteid << " != " << (void*)(pmtid&0xff000000) << endreq;
            return 0;
        }
    }

    // We get here we know we are still on the right track
    IDetectorElement::IDEContainer& child = de->childIDetectorElements();
    for (size_t ind=0; ind < child.size(); ++ind) {
        IPmtGeomInfo *pgi = this->find(pmtid,child[ind]);
        if (pgi) return pgi;
    }
    //nomsg msg << MSG::DEBUG << "failed to find pmtid " << (void*)pmtid << endreq;
    return 0;
}


IDetectorElement* PmtGeomInfoSvc::findParent(unsigned int pmtid,
                                             IDetectorElement* currentDE)
{
    // Find the parent detector element for this PMT, starting the
    // search at the current detector element.  If currentDE==0, then
    // the entire geometry will be searched.

    //nomsg MsgStream msg(msgSvc(),name());
    //nomsg msg << MSG::DEBUG << "PmtGeomInfoSvc::find(int "<<(void*)pmtid;
    //nomsg if (currentDE) msg <<","<<currentDE->name();
    //nomsg msg << ")"<< endreq;

    if (!currentDE) {
      // If current detector element is undefined, check the usual suspects
      // First, check the cached detector
      if (m_detector) {
        IDetectorElement* parent = findParent(pmtid, m_detector);
        if(parent) return parent;
        m_detector = 0; // Unset incorrect cached detector
      }
      // Next, check the top-level detector elements
      for (size_t ind=0; ind<m_topDEs.size(); ++ind) {
        if (m_topDEs[ind]){
          IDetectorElement* parent = findParent(pmtid, m_topDEs[ind]);
          if(parent) return parent;
        }
      }
      // Failed to find parent detector
      //nomsg msg << MSG::DEBUG << "failed to find parent detector for pmtid "  << (void*)pmtid << endreq;
      return 0;
    }

    //nomsg msg << MSG::DEBUG << "Looking for "<< (void*)pmtid  << " in "<< currentDE->name() << endreq;
    const ParamValidDataObject* params = currentDE->params();

    // Check if current detector element is the pmt parent detector
    if (params->exists(m_DetectorIdUserParameter)) {
      unsigned int detid = 
        (unsigned int)(params->param<int>(m_DetectorIdUserParameter));
      //nomsg msg << MSG::DEBUG << "checking Detector ID "        << (void*)detid << " =?= " << (void*)(pmtid) << endreq;
      if ( (pmtid&0xffff0000) == detid) { 
        //nomsg msg << MSG::DEBUG << "found Detector ID "           << (void*)detid << " for " << (void*)(pmtid) << endreq;
        return currentDE;    // We have a winner!
      }
    }

    // Check if current detector element is the correct site
    if (params->exists(m_SiteIdUserParameter)) {
      unsigned int siteid = 
        (unsigned int)(params->param<int>(m_SiteIdUserParameter));
      if ( (pmtid&0xff000000) != siteid) {
        //nomsg msg << MSG::DEBUG << "got Site ID but wrong one "           << (void*)siteid << " != " << (void*)(pmtid&0xff000000) << endreq;
        return 0;
      }
    }
    
    // Check detector element children
    // We get here we know we are still on the right track
    IDetectorElement::IDEContainer& child = currentDE->childIDetectorElements();
    for (size_t ind=0; ind < child.size(); ++ind) {
        IDetectorElement* parent = this->findParent(pmtid,child[ind]);
        if (parent) return parent;
    }
    //nomsg msg << MSG::DEBUG   << "failed to find parent detector for pmtid "  << (void*)pmtid << " in current branch" << endreq;
    return 0;    
}


IPmtGeomInfo* PmtGeomInfoSvc::add(unsigned int pmtid, const std::string& path,
                                  IDetectorElement* de)
{
    MsgStream msg(msgSvc(), name());

    if (!de) {
        msg << MSG::ERROR 
            << "Given NULL DetectorElement (pmtid=" 
            << (void*)pmtid << endreq;
        return 0;
    }
    IDetectorElement* parent = findParent(pmtid,0);
    if (!parent) {
        msg << MSG::ERROR 
            << "No parent detector, cannot add DetectorElement with pmtid=" 
            << (void*)pmtid << endreq;
        return 0;
    }

    msg << MSG::DEBUG
        << "Adding pmtid " << (void*)pmtid << " at \"" << path <<"\""
        << endreq;

    PmtGeomInfo* gpi = new PmtGeomInfo(pmtid,de,parent);

    if (path == "") m_byPath[de->name()] = gpi;
    else m_byPath[path] = gpi;
    m_byDE[de] = gpi;
    m_byId[pmtid] = gpi;

    return gpi;
}
StatusCode PmtGeomInfoSvc::queryInterface(const InterfaceID& riid, 
                                          void** ppvInterface)
{
    StatusCode sc = StatusCode::FAILURE;
    if (ppvInterface) {
        *ppvInterface = 0;
    
        if (IPmtGeomInfoSvc::interfaceID().versionMatch(riid)) {
            *ppvInterface = static_cast<IPmtGeomInfoSvc*>(this);
            sc = StatusCode::SUCCESS;
            addRef();
        }
        else sc = Service::queryInterface( riid, ppvInterface );    
    }
    return sc;
}