FWRPZView.cc

Go to the documentation of this file.

// -*- C++ -*-
//
// Package:     Core
// Class  :     FWRPZView
//
// Implementation:
//     <Notes on implementation>
//
// Original Author:  Chris Jones
//         Created:  Tue Feb 19 10:33:25 EST 2008
//

// system include files
#include <stdexcept>
#include <functional>
#include <memory>

#include "TGLViewer.h"
#include "TGLScenePad.h"
#include "TEveManager.h"
#include "TEveElement.h"
#include "TEveScene.h"
#include "TEveProjections.h"
#include "TEveProjectionAxes.h"
#include "TGLabel.h"
#include "TEveProjectionManager.h"
#include "TEveCalo.h"

// user include files
#include "Fireworks/Core/interface/FWRPZView.h"
#include "Fireworks/Core/interface/FWRPZViewGeometry.h"
#include "Fireworks/Core/interface/FWBeamSpot.h"
#include "Fireworks/Core/interface/Context.h"
#include "Fireworks/Core/interface/fwLog.h"
#include "Fireworks/Core/interface/FWViewContext.h"
#include "Fireworks/Core/interface/FWViewContext.h"
#include "Fireworks/Core/interface/FWViewEnergyScale.h"
#include "Fireworks/Core/interface/CmsShowViewPopup.h"
#include "Fireworks/Core/interface/CmsShowCommon.h"

const float FWRPZView::s_distortF = 0.001;
const float FWRPZView::s_distortFInv = 1000;
//
// constructors and destructor
//
FWRPZView::FWRPZView(TEveWindowSlot* iParent, FWViewType::EType id)
    : FWEveView(iParent, id, 7),
      m_geometryList(nullptr),
      m_projMgr(nullptr),
      m_axes(nullptr),

      m_calo(nullptr),

      m_showPixelBarrel(this, "Show Pixel Barrel", false),
      m_showPixelEndcap(this, "Show Pixel Endcap", false),
      m_showTrackerBarrel(this, "Show Tracker Barrel", false),
      m_showTrackerEndcap(this, "Show Tracker Endcap", false),
      m_showRpcEndcap(this, "Show RPC Endcap", false),
      m_showGEM(this, "Show GEM", false),
      m_showME0(this, "Show ME0", false),

      m_shiftOrigin(this, "Shift origin to beam-spot", false),
      m_fishEyeDistortion(this, "Distortion", 0., 0., 100.),
      m_fishEyeR(this, "FixedRadius", (double)fireworks::Context::caloR1(), 0.0, 150.0),

      m_caloDistortion(this, "Calo compression", 1.0, 0.01, 10.),
      m_muonDistortion(this, "Muon compression", 0.2, 0.01, 10.),
      m_showProjectionAxes(this, "Show projection axis", false),
      m_projectionAxesLabelSize(this, "Projection axis label size", 0.015, 0.001, 0.2),
      m_compressMuon(this, "Compress detectors", false),
      m_showHF(nullptr),
      m_showEndcaps(nullptr) {
  TEveProjection::EPType_e projType = (id == FWViewType::kRhoZ) ? TEveProjection::kPT_RhoZ : TEveProjection::kPT_RPhi;

  m_projMgr = new TEveProjectionManager(projType);
  m_projMgr->IncDenyDestroy();
  m_projMgr->SetImportEmpty(kTRUE);

  m_projMgr->GetProjection()->SetDistortion(m_fishEyeDistortion.value() * s_distortF);
  m_projMgr->GetProjection()->SetFixR(m_fishEyeR.value());

#ifdef TEVEPROJECTIONS_DISPLACE_ORIGIN_MODE
  m_projMgr->GetProjection()->SetDisplaceOrigin(m_shiftOrigin.value());
#endif

  if (id == FWViewType::kRhoPhi || id == FWViewType::kRhoPhiPF) {
    m_projMgr->GetProjection()->AddPreScaleEntry(0, fireworks::Context::caloR1(), 1.0);
    m_projMgr->GetProjection()->AddPreScaleEntry(0, 300, 0.2);
  } else {
    m_projMgr->GetProjection()->AddPreScaleEntry(0, fireworks::Context::caloR1(), 1.0);
    m_projMgr->GetProjection()->AddPreScaleEntry(1, 310, 1.0);
    m_projMgr->GetProjection()->AddPreScaleEntry(0, 370, 0.2);
    m_projMgr->GetProjection()->AddPreScaleEntry(1, 580, 0.2);
  }

  // camera
  viewerGL()->SetCurrentCamera(TGLViewer::kCameraOrthoXOY);
  if (TGLOrthoCamera* camera = dynamic_cast<TGLOrthoCamera*>(&(viewerGL()->CurrentCamera()))) {
    camera->SetZoomMax(1e6);
  }
  geoScene()->GetGLScene()->SetSelectable(kFALSE);

  m_axes = new TEveProjectionAxes(m_projMgr);
  m_axes->SetRnrState(m_showProjectionAxes.value());
  m_axes->SetLabelSize(m_projectionAxesLabelSize.value());
  m_showProjectionAxes.changed_.connect(std::bind(&FWRPZView::showProjectionAxes, this));
  m_projectionAxesLabelSize.changed_.connect(std::bind(&FWRPZView::projectionAxesLabelSize, this));
  eventScene()->AddElement(m_axes);

  if (id != FWViewType::kRhoZ) {
    m_showEndcaps = new FWBoolParameter(this, "Include EndCaps", true);
    m_showEndcaps->changed_.connect(std::bind(&FWRPZView::setEtaRng, this));
    m_showHF = new FWBoolParameter(this, "Include HF", true);
    m_showHF->changed_.connect(std::bind(&FWRPZView::setEtaRng, this));
  }

  m_shiftOrigin.changed_.connect(std::bind(&FWRPZView::doShiftOriginToBeamSpot, this));

  m_fishEyeDistortion.changed_.connect(std::bind(&FWRPZView::doFishEyeDistortion, this));

  m_fishEyeR.changed_.connect(std::bind(&FWRPZView::doFishEyeDistortion, this));

  m_caloDistortion.changed_.connect(std::bind(&FWRPZView::doPreScaleDistortion, this));
  m_muonDistortion.changed_.connect(std::bind(&FWRPZView::doPreScaleDistortion, this));
  m_compressMuon.changed_.connect(std::bind(&FWRPZView::doCompression, this, std::placeholders::_1));
}

FWRPZView::~FWRPZView() {
  m_calo->Destroy();
  m_projMgr->DecDenyDestroy();
}

//
// member functions
//

TEveCaloViz* FWRPZView::getEveCalo() const { return static_cast<TEveCaloViz*>(m_calo); }

void FWRPZView::setContext(const fireworks::Context& ctx) {
  FWEveView::setContext(ctx);

  m_geometryList = new FWRPZViewGeometry(ctx);
  m_geometryList->IncDenyDestroy();
  m_geometryList->initStdGeoElements(typeId());
  TEveElement* p = m_projMgr->ImportElements(m_geometryList);
  geoScene()->AddElement(p);

  TEveCaloData* data = context().getCaloData();

  TEveCalo3D* calo3d = new TEveCalo3D(data);

  m_calo = static_cast<TEveCalo2D*>(m_projMgr->ImportElements(calo3d, eventScene()));

  if (typeId() == FWViewType::kRhoPhiPF)
    m_calo->SetBarrelRadius(177);
  else
    m_calo->SetBarrelRadius(context().caloR1(false));

  m_calo->SetEndCapPos(context().caloZ1(false));
  m_calo->SetAutoRange(false);
  m_calo->SetScaleAbs(true);

  m_showPixelBarrel.changed_.connect(
      std::bind(&FWRPZViewGeometry::showPixelBarrel, m_geometryList, std::placeholders::_1));
  m_showPixelEndcap.changed_.connect(
      std::bind(&FWRPZViewGeometry::showPixelEndcap, m_geometryList, std::placeholders::_1));
  m_showTrackerBarrel.changed_.connect(
      std::bind(&FWRPZViewGeometry::showTrackerBarrel, m_geometryList, std::placeholders::_1));
  m_showTrackerEndcap.changed_.connect(
      std::bind(&FWRPZViewGeometry::showTrackerEndcap, m_geometryList, std::placeholders::_1));
  m_showRpcEndcap.changed_.connect(std::bind(&FWRPZViewGeometry::showRpcEndcap, m_geometryList, std::placeholders::_1));
  m_showGEM.changed_.connect(std::bind(&FWRPZViewGeometry::showGEM, m_geometryList, std::placeholders::_1));
  m_showME0.changed_.connect(std::bind(&FWRPZViewGeometry::showME0, m_geometryList, std::placeholders::_1));
}

void FWRPZView::eventBegin() {
  if (context().getBeamSpot()) {
    float c[3] = {0, 0, 0};
    context().commonPrefs()->getEventCenter(c);

    // projection center
    TEveVector center(c[0], c[1], c[2]);
    m_projMgr->GetProjection()->SetCenter(center);

    // camera move
    TGLCamera& cam = viewerGL()->CurrentCamera();
    cam.SetExternalCenter(true);
    if (typeId() != FWViewType::kRhoZ) {
      double r = center.Mag();
      cam.SetCenterVec(center.fZ, TMath::Sign(r, center.fY), 0);
    } else {
      cam.SetCenterVec(c[0], c[1], c[2]);
    }
  }
}

void FWRPZView::eventEnd() {
  float c[3];
  context().commonPrefs()->getEventCenter(c);
  m_projMgr->SetCenter(c[0], c[1], c[2]);
  FWEveView::eventEnd();
}

void FWRPZView::setupEventCenter() {
  float c[3];
  context().commonPrefs()->getEventCenter(c);
  m_projMgr->SetCenter(c[0], c[1], c[2]);
  FWEveView::setupEventCenter();
}

void FWRPZView::doShiftOriginToBeamSpot() {
#ifdef TEVEPROJECTIONS_DISPLACE_ORIGIN_MODE

  TEveProjection* p = m_projMgr->GetProjection();
  if (p->GetDisplaceOrigin() != m_shiftOrigin.value()) {
    p->SetDisplaceOrigin(m_shiftOrigin.value());
    m_projMgr->ProjectChildren();
    gEve->Redraw3D();
  }
#endif
}

void FWRPZView::shiftOrigin(TEveVector& center) {
#ifdef TEVEPROJECTIONS_DISPLACE_ORIGIN_MODE
  // re-project with new center
  m_projMgr->GetProjection()->SetCenter(center);
  m_projMgr->ProjectChildren();

  // draw projected center
  float* pc = m_projMgr->GetProjection()->GetProjectedCenter();
  viewerGL()->CurrentCamera().SetExternalCenter(true);
  viewerGL()->CurrentCamera().SetCenterVec(pc[0], pc[1], pc[2]);
  viewerGL()->SetDrawCameraCenter(true);

  gEve->Redraw3D();
#endif
}

void FWRPZView::resetOrigin() {
  // set center back to beam spot

#ifdef TEVEPROJECTIONS_DISPLACE_ORIGIN_MODE
  FWBeamSpot& b = *(context().getBeamSpot());
  TEveVector center(b.x0(), b.y0(), b.z0());
  m_projMgr->GetProjection()->SetCenter(center);

  m_projMgr->ProjectChildren();
  gEve->Redraw3D();
#endif
}

void FWRPZView::doFishEyeDistortion() {
  TEveProjection* p = m_projMgr->GetProjection();
  if (p->GetDistortion() != m_fishEyeDistortion.value() * s_distortFInv)
    p->SetDistortion(m_fishEyeDistortion.value() * s_distortF);
  if (p->GetFixR() != m_fishEyeR.value())
    p->SetFixR(m_fishEyeR.value());

  m_projMgr->ProjectChildren();
  gEve->Redraw3D();
}

void FWRPZView::doPreScaleDistortion() {
  if (typeId() == FWViewType::kRhoPhi || typeId() == FWViewType::kRhoPhiPF) {
    m_projMgr->GetProjection()->ChangePreScaleEntry(0, 1, m_caloDistortion.value());
    m_projMgr->GetProjection()->ChangePreScaleEntry(0, 2, m_muonDistortion.value());
  } else {
    m_projMgr->GetProjection()->ChangePreScaleEntry(0, 1, m_caloDistortion.value());
    m_projMgr->GetProjection()->ChangePreScaleEntry(0, 2, m_muonDistortion.value());
    m_projMgr->GetProjection()->ChangePreScaleEntry(1, 1, m_caloDistortion.value());
    m_projMgr->GetProjection()->ChangePreScaleEntry(1, 2, m_muonDistortion.value());
  }
  m_projMgr->UpdateName();
  m_projMgr->ProjectChildren();
  gEve->Redraw3D();
}

void FWRPZView::doCompression(bool flag) {
  m_projMgr->GetProjection()->SetUsePreScale(flag);
  m_projMgr->UpdateName();
  m_projMgr->ProjectChildren();
  gEve->Redraw3D();
}

void FWRPZView::importElements(TEveElement* iChildren, float iLayer, TEveElement* iProjectedParent) {
  float oldLayer = m_projMgr->GetCurrentDepth();
  m_projMgr->SetCurrentDepth(iLayer);
  //make sure current depth is reset even if an exception is thrown
  std::shared_ptr<TEveProjectionManager> sentry(
      m_projMgr, std::bind(&TEveProjectionManager::SetCurrentDepth, std::placeholders::_1, oldLayer));
  m_projMgr->ImportElements(iChildren, iProjectedParent);
}

void FWRPZView::addTo(FWConfiguration& iTo) const {
  FWEveView::addTo(iTo);
  TGLOrthoCamera* camera = dynamic_cast<TGLOrthoCamera*>(&(viewerGL()->CurrentCamera()));
  if (camera)
    addToOrthoCamera(camera, iTo);
}

void FWRPZView::setFrom(const FWConfiguration& iFrom) {
  FWEveView::setFrom(iFrom);

  TGLOrthoCamera* camera = dynamic_cast<TGLOrthoCamera*>(&(viewerGL()->CurrentCamera()));
  if (camera)
    setFromOrthoCamera(camera, iFrom);

  if (iFrom.version() < 7) {
    const FWConfiguration* value = iFrom.valueForKey("Show projection axes");
    if (value)
      m_showProjectionAxes.set(value->value() == "1");
  }
}

void FWRPZView::setEtaRng() {
  if (typeId() != FWViewType::kRhoZ) {
    // rng controllers only in RhoPhi
    double eta_range = context().caloMaxEta();
    if (!m_showHF->value())
      eta_range = 3.0;
    if (!m_showEndcaps->value())
      eta_range = context().caloTransEta();
    m_calo->SetEta(-eta_range, eta_range);
  }

  FWEveView::setupEnergyScale();
}

void FWRPZView::voteCaloMaxVal() {
  if (!m_calo->GetData()->Empty()) {
    m_calo->AssertCellIdCache();
    Float_t sumEt, sumE;
    TEveCaloData::CellData_t cellData;
    typedef std::vector<TEveCaloData::vCellId_t*> vBinCells_t;
    typedef std::vector<TEveCaloData::vCellId_t*>::iterator vBinCells_i;

    vBinCells_t cellLists = m_calo->GetBinLists();
    for (vBinCells_i it = cellLists.begin(); it != cellLists.end(); it++) {
      TEveCaloData::vCellId_t* binCells = *it;
      if (binCells) {
        sumEt = 0;
        sumE = 0;
        TEveCaloData::vCellId_i a = binCells->end();

        for (TEveCaloData::vCellId_i k = binCells->begin(); k != a; ++k) {
          m_calo->GetData()->GetCellData((*k), cellData);
          sumEt += cellData.Value(true);
          sumE += cellData.Value(false);
        }
        // printf("vote sum %f %f \n", sumEt , sumE);
        context().voteMaxEtAndEnergy(sumEt, sumE);
      }
    }
  }
}

void FWRPZView::showProjectionAxes() {
  m_axes->SetRnrState(m_showProjectionAxes.value());
  gEve->Redraw3D();
  viewerGL()->RequestDraw();
}

void FWRPZView::projectionAxesLabelSize() {
  m_axes->SetLabelSize(m_projectionAxesLabelSize.value());
  viewerGL()->RequestDraw();
}

void FWRPZView::populateController(ViewerParameterGUI& gui) const {
  FWEveView::populateController(gui);

  ViewerParameterGUI& det = gui.requestTab("Detector");
  ;
  det.addParam(&m_showPixelBarrel);

  if (typeId() == FWViewType::kRhoZ) {
    det.addParam(&m_showTrackerBarrel);
    det.addParam(&m_showPixelEndcap);
    det.addParam(&m_showRpcEndcap);
    bool showGEM = m_context->getGeom()->versionInfo().haveExtraDet("GEM");
    if (showGEM)
      det.addParam(&m_showGEM);
    bool showME0 = m_context->getGeom()->versionInfo().haveExtraDet("ME0");
    if (showME0)
      det.addParam(&m_showME0);
  }

#ifdef TEVEPROJECTIONS_DISPLACE_ORIGIN_MODE
  gui.requestTab("Projection").addParam(&m_shiftOrigin);
#endif

  gui.requestTab("Projection").addParam(&m_showProjectionAxes).addParam(&m_projectionAxesLabelSize).separator();

  TGCompositeFrame* f = gui.getTabContainer();

  f->AddFrame(new TGLabel(f, "FishEye:"));
  gui.addParam(&m_fishEyeDistortion).addParam(&m_fishEyeR).separator();

  f->AddFrame(new TGLabel(f, "PreScales:"));

  gui.requestTab("Projection").addParam(&m_compressMuon).addParam(&m_muonDistortion).addParam(&m_caloDistortion);

  if (typeId() == FWViewType::kRhoPhi || typeId() == FWViewType::kRhoPhiPF) {
    gui.requestTab("Calo").addParam(m_showHF).addParam(m_showEndcaps);
  }
}