InstrumentVisitor.cpp

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#include "MantidGeometry/Instrument/InstrumentVisitor.h"
#include "MantidBeamline/ComponentInfo.h"
#include "MantidBeamline/DetectorInfo.h"
#include "MantidGeometry/ICompAssembly.h"
#include "MantidGeometry/IComponent.h"
#include "MantidGeometry/IDetector.h"
#include "MantidGeometry/IObjComponent.h"
#include "MantidGeometry/Instrument.h"
#include "MantidGeometry/Instrument/ComponentInfo.h"
#include "MantidGeometry/Instrument/DetectorInfo.h"
#include "MantidGeometry/Instrument/GridDetector.h"
#include "MantidGeometry/Instrument/ObjCompAssembly.h"
#include "MantidGeometry/Instrument/ParComponentFactory.h"
#include "MantidGeometry/Instrument/ParameterMap.h"
#include "MantidGeometry/Instrument/StructuredDetector.h"
#include "MantidGeometry/Objects/CSGObject.h"
#include "MantidKernel/EigenConversionHelpers.h"
 
#include <algorithm>
#include <memory>
#include <numeric>
 
namespace Mantid::Geometry {
 
namespace {
std::shared_ptr<const std::unordered_map<detid_t, size_t>> makeDetIdToIndexMap(const std::vector<detid_t> &detIds) {
 
  const size_t nDetIds = detIds.size();
  auto detIdToIndex = std::make_shared<std::unordered_map<detid_t, size_t>>();
  detIdToIndex->reserve(nDetIds);
  for (size_t i = 0; i < nDetIds; ++i) {
    (*detIdToIndex)[detIds[i]] = i;
  }
  return detIdToIndex;
}
 
void clearLegacyParameters(ParameterMap *pmap, const IComponent &comp) {
  if (!pmap)
    return;
  pmap->clearParametersByName(ParameterMap::pos(), &comp);
  pmap->clearParametersByName(ParameterMap::posx(), &comp);
  pmap->clearParametersByName(ParameterMap::posy(), &comp);
  pmap->clearParametersByName(ParameterMap::posz(), &comp);
  pmap->clearParametersByName(ParameterMap::rot(), &comp);
  pmap->clearParametersByName(ParameterMap::rotx(), &comp);
  pmap->clearParametersByName(ParameterMap::roty(), &comp);
  pmap->clearParametersByName(ParameterMap::rotz(), &comp);
  pmap->clearParametersByName(ParameterMap::scale(), &comp);
}
 
bool hasValidShape(const ObjCompAssembly &obj) {
  const auto *shape = obj.shape().get();
  return shape != nullptr && shape->hasValidShape();
}
 
Beamline::PixelGridComponent makePixelGridComponent(const GridDetector &grid) {
  Beamline::PixelGridComponent pixelGrid;
  pixelGrid.nX = grid.xpixels();
  pixelGrid.nY = grid.ypixels();
  pixelGrid.nZ = grid.zpixels();
  pixelGrid.xStart = grid.xstart();
  pixelGrid.yStart = grid.ystart();
  pixelGrid.zStart = grid.zstart();
  pixelGrid.xStep = grid.xstep();
  pixelGrid.yStep = grid.ystep();
  pixelGrid.zStep = grid.zstep();
  pixelGrid.idStart = grid.idstart();
  pixelGrid.idStep = grid.idstep();
  pixelGrid.idStepByRow = grid.idstepbyrow();
  pixelGrid.idFillOrder = grid.idFillOrder();
  pixelGrid.minDetectorID = grid.minDetectorID();
  pixelGrid.maxDetectorID = grid.maxDetectorID();
  return pixelGrid;
}
 
Beamline::StructuredGridComponent makeStructuredGridComponent(const StructuredDetector &bank) {
  Beamline::StructuredGridComponent structuredGrid;
  structuredGrid.nX = static_cast<int>(bank.xPixels());
  structuredGrid.nY = static_cast<int>(bank.yPixels());
  structuredGrid.idStart = bank.idStart();
  structuredGrid.idStep = bank.idStep();
  structuredGrid.idStepByRow = bank.idStepByRow();
  structuredGrid.idFillByFirstY = bank.idFillByFirstY();
  structuredGrid.xVertices = bank.getXValues();
  structuredGrid.yVertices = bank.getYValues();
  return structuredGrid;
}
} // namespace
 
InstrumentVisitor::InstrumentVisitor(std::shared_ptr<const Instrument> instrument)
    : m_orderedDetectorIds(
          std::make_shared<std::vector<detid_t>>(instrument->getDetectorIDs(false /*Do not skip monitors*/))),
      m_componentIds(std::make_shared<std::vector<ComponentID>>(m_orderedDetectorIds->size(), nullptr)),
      m_assemblySortedDetectorIndices(std::make_shared<std::vector<size_t>>()),
      m_assemblySortedComponentIndices(std::make_shared<std::vector<size_t>>()),
      m_parentComponentIndices(std::make_shared<std::vector<size_t>>(m_orderedDetectorIds->size(), 0)),
      m_children(std::make_shared<std::vector<std::vector<size_t>>>()),
      m_detectorRanges(std::make_shared<std::vector<std::pair<size_t, size_t>>>()),
      m_componentRanges(std::make_shared<std::vector<std::pair<size_t, size_t>>>()),
      m_componentIdToIndexMap(std::make_shared<std::unordered_map<Mantid::Geometry::IComponent const *, size_t>>()),
      m_detectorIdToIndexMap(makeDetIdToIndexMap(*m_orderedDetectorIds)),
      m_positions(std::make_shared<std::vector<Eigen::Vector3d>>()),
      m_detectorPositions(std::make_shared<std::vector<Eigen::Vector3d>>(m_orderedDetectorIds->size())),
      m_rotations(std::make_shared<std::vector<Eigen::Quaterniond, Eigen::aligned_allocator<Eigen::Quaterniond>>>()),
      m_detectorRotations(
          std::make_shared<std::vector<Eigen::Quaterniond, Eigen::aligned_allocator<Eigen::Quaterniond>>>(
              m_orderedDetectorIds->size())),
      m_monitorIndices(std::make_shared<std::vector<size_t>>()), m_instrument(std::move(instrument)), m_pmap(nullptr),
      m_nullShape(std::make_shared<const CSGObject>()),
      m_shapes(
          std::make_shared<std::vector<std::shared_ptr<const IObject>>>(m_orderedDetectorIds->size(), m_nullShape)),
      m_scaleFactors(
          std::make_shared<std::vector<Eigen::Vector3d>>(m_orderedDetectorIds->size(), Eigen::Vector3d{1, 1, 1})),
      m_componentType(std::make_shared<std::vector<Beamline::ComponentType>>()),
      m_names(std::make_shared<std::vector<std::string>>(m_orderedDetectorIds->size())),
      m_sideBySideViewPositions(std::make_shared<std::map<size_t, Eigen::Vector2d>>()),
      m_pixelGridComponents(std::make_shared<std::map<size_t, Beamline::PixelGridComponent>>()),
      m_structuredGridComponents(std::make_shared<std::map<size_t, Beamline::StructuredGridComponent>>()) {
  if (m_instrument->isParametrized()) {
    m_pmap = m_instrument->getParameterMap().get();
  }
 
  m_sourceId = nullptr;
  m_sampleId = nullptr;
 
  // To prevent warning generation. Do not even try to get the source or sample
  // id if the instrument is empty.
  if (!m_instrument->isEmptyInstrument()) {
 
    m_sourceId = m_instrument->getSource() ? m_instrument->getSource()->getComponentID() : nullptr;
    m_sampleId = m_instrument->getSample() ? m_instrument->getSample()->getComponentID() : nullptr;
  }
 
  const auto nDetectors = m_orderedDetectorIds->size();
  m_assemblySortedDetectorIndices->reserve(nDetectors); // Exact
  m_componentIdToIndexMap->reserve(nDetectors);         // Approximation
}
 
void InstrumentVisitor::walkInstrument() {
  if (m_pmap && m_pmap->empty()) {
    // Go through the base instrument for speed.
    m_instrument->baseInstrument()->registerContents(*this);
  } else {
    m_instrument->registerContents(*this);
  }
}
 
size_t InstrumentVisitor::commonRegistration(const IComponent &component) {
  const size_t componentIndex = m_componentIds->size();
  const ComponentID componentId = component.getComponentID();
  markAsSourceOrSample(componentId, componentIndex);
  // Record the ID -> index mapping
  (*m_componentIdToIndexMap)[componentId] = componentIndex;
  // For any non-detector we extend the m_componentIds from the back
  m_componentIds->emplace_back(componentId);
  m_positions->emplace_back(Kernel::toVector3d(component.getPos()));
  m_rotations->emplace_back(Kernel::toQuaterniond(component.getRotation()));
  m_shapes->emplace_back(m_nullShape);
  m_scaleFactors->emplace_back(Kernel::toVector3d(component.getScaleFactor()));
  m_names->emplace_back(component.getName());
  if (const auto &sideBySideViewPos = component.getSideBySideViewPos()) {
    (*m_sideBySideViewPositions)[componentIndex] = Kernel::toVector2d(*sideBySideViewPos);
  }
  clearLegacyParameters(m_pmap, component);
  return componentIndex;
}
 
size_t InstrumentVisitor::registerComponentAssembly(const ICompAssembly &assembly) {
 
  std::vector<IComponent_const_sptr> assemblyChildren;
  assembly.getChildren(assemblyChildren, false /*is recursive*/);
 
  const size_t detectorStart = m_assemblySortedDetectorIndices->size();
  const size_t componentStart = m_assemblySortedComponentIndices->size();
  std::vector<size_t> children(assemblyChildren.size());
  for (size_t i = 0; i < assemblyChildren.size(); ++i) {
    // register everything under this assembly
    children[i] = assemblyChildren[i]->registerContents(*this);
  }
  const size_t detectorStop = m_assemblySortedDetectorIndices->size();
  const size_t componentIndex = commonRegistration(assembly);
  m_componentType->emplace_back(Beamline::ComponentType::Unstructured);
  m_assemblySortedComponentIndices->emplace_back(componentIndex);
  // Unless this is the root component this parent is not correct and will be
  // updated later in the register call of the parent.
  m_parentComponentIndices->emplace_back(componentIndex);
  const size_t componentStop = m_assemblySortedComponentIndices->size();
 
  m_detectorRanges->emplace_back(detectorStart, detectorStop);
  m_componentRanges->emplace_back(componentStart, componentStop);
 
  // Now that we know what the index of the parent is we can apply it to the children
  for (const auto &child : children) {
    (*m_parentComponentIndices)[child] = componentIndex;
  }
  m_children->emplace_back(std::move(children));
  return componentIndex;
}
 
size_t InstrumentVisitor::registerGenericComponent(const IComponent &component) {
  /*
   * For a generic leaf component we extend the component ids list, but
   * the detector indexes entries will of course be empty
   */
  m_detectorRanges->emplace_back(std::make_pair(0, 0)); // Represents an empty range
  // Record the ID -> index mapping
  const size_t componentIndex = commonRegistration(component);
  m_componentType->emplace_back(Beamline::ComponentType::Generic);
 
  const size_t componentStart = m_assemblySortedComponentIndices->size();
  m_componentRanges->emplace_back(std::make_pair(componentStart, componentStart + 1));
  m_assemblySortedComponentIndices->emplace_back(componentIndex);
  // Unless this is the root component this parent is not correct and will be
  // updated later in the register call of the parent.
  m_parentComponentIndices->emplace_back(componentIndex);
  // Generic components are not assemblies and do not therefore have children.
  m_children->emplace_back();
  return componentIndex;
}
 
size_t InstrumentVisitor::registerInfiniteComponent(const Mantid::Geometry::IComponent &component) {
  /*
   * For a generic leaf component we extend the component ids list, but
   * the detector indexes entries will of course be empty
   */
  m_detectorRanges->emplace_back(0, 0); // Represents an empty range
                                        // Record the ID -> index mapping
  const size_t componentIndex = commonRegistration(component);
  m_componentType->emplace_back(Beamline::ComponentType::Infinite);
 
  const size_t componentStart = m_assemblySortedComponentIndices->size();
  m_componentRanges->emplace_back(componentStart, componentStart + 1);
  m_assemblySortedComponentIndices->emplace_back(componentIndex);
  // Unless this is the root component this parent is not correct and will be
  // updated later in the register call of the parent.
  m_parentComponentIndices->emplace_back(componentIndex);
  // Generic components are not assemblies and do not therefore have children.
  m_children->emplace_back();
  return componentIndex;
}
 
size_t InstrumentVisitor::registerGenericObjComponent(const Mantid::Geometry::IObjComponent &objComponent) {
  auto index = registerGenericComponent(objComponent);
  (*m_shapes)[index] = objComponent.shape();
  return index;
}
 
size_t InstrumentVisitor::registerRectangularBank(const ICompAssembly &bank) {
  auto index = registerComponentAssembly(bank);
  size_t rangesIndex = index - m_orderedDetectorIds->size();
  (*m_componentType)[rangesIndex] = Beamline::ComponentType::Rectangular;
  (*m_pixelGridComponents)[index] = makePixelGridComponent(dynamic_cast<const GridDetector &>(bank));
  return index;
}
 
size_t InstrumentVisitor::registerGridBank(const ICompAssembly &bank) {
  auto index = registerComponentAssembly(bank);
  size_t rangesIndex = index - m_orderedDetectorIds->size();
  (*m_componentType)[rangesIndex] = Beamline::ComponentType::Grid;
  (*m_pixelGridComponents)[index] = makePixelGridComponent(dynamic_cast<const GridDetector &>(bank));
  return index;
}
 
size_t InstrumentVisitor::registerInfiniteObjComponent(const IObjComponent &objComponent) {
  auto index = registerInfiniteComponent(objComponent);
  (*m_shapes)[index] = objComponent.shape();
  return index;
}
 
size_t InstrumentVisitor::registerStructuredBank(const ICompAssembly &bank) {
  auto index = registerComponentAssembly(bank);
  size_t rangesIndex = index - m_orderedDetectorIds->size();
  (*m_componentType)[rangesIndex] = Beamline::ComponentType::Structured;
  (*m_structuredGridComponents)[index] = makeStructuredGridComponent(dynamic_cast<const StructuredDetector &>(bank));
  return index;
}
 
size_t InstrumentVisitor::registerObjComponentAssembly(const ObjCompAssembly &obj) {
  auto index = registerComponentAssembly(obj);
  (*m_shapes)[index] = obj.shape();
  if (hasValidShape(obj)) {
    size_t rangesIndex = index - m_orderedDetectorIds->size();
    (*m_componentType)[rangesIndex] = Beamline::ComponentType::OutlineComposite;
  }
  return index;
}
 
void InstrumentVisitor::markAsSourceOrSample(ComponentID componentId, const size_t componentIndex) {
  if (componentId == m_sampleId) {
    m_sampleIndex = componentIndex;
  } else if (componentId == m_sourceId) {
    m_sourceIndex = componentIndex;
  }
}
 
size_t InstrumentVisitor::registerDetector(const IDetector &detector) {
  auto detectorIndex = m_detectorIdToIndexMap->at(detector.getID());
 
  /* Already allocated we just need to index into the inital front-detector
   * part of the collection.
   * 1. Guarantee on grouping detectors by type such that the first n
   * components
   * are detectors.
   * 2. Guarantee on ordering such that the
   * detectorIndex == componentIndex for all detectors.
   */
  // Record the ID -> component index mapping
  (*m_componentIdToIndexMap)[detector.getComponentID()] = detectorIndex;
  (*m_componentIds)[detectorIndex] = detector.getComponentID();
  m_assemblySortedDetectorIndices->emplace_back(detectorIndex);
  (*m_detectorPositions)[detectorIndex] = Kernel::toVector3d(detector.getPos());
  (*m_detectorRotations)[detectorIndex] = Kernel::toQuaterniond(detector.getRotation());
  (*m_shapes)[detectorIndex] = detector.shape();
  (*m_scaleFactors)[detectorIndex] = Kernel::toVector3d(detector.getScaleFactor());
  if (m_instrument->isMonitor(detector.getID())) {
    m_monitorIndices->emplace_back(detectorIndex);
  }
  (*m_names)[detectorIndex] = detector.getName();
  if (const auto &sideBySideViewPos = detector.getSideBySideViewPos()) {
    (*m_sideBySideViewPositions)[detectorIndex] = Kernel::toVector2d(*sideBySideViewPos);
  }
  clearLegacyParameters(m_pmap, detector);
 
  /* Note that positions and rotations for detectors are currently
  NOT stored! These go into DetectorInfo at present. emplace_back works for
  other Component types because Detectors are always come first in the resultant
  component list
  forming a contiguous block.
  */
  markAsSourceOrSample(detector.getComponentID(),
                       detectorIndex); // TODO. Optimisation. Cannot have a
                                       // detector that is either source or
                                       // sample. So delete this.
  return detectorIndex;
}
 
std::shared_ptr<const std::vector<Mantid::Geometry::ComponentID>> InstrumentVisitor::componentIds() const {
  return m_componentIds;
}
 
size_t InstrumentVisitor::size() const { return m_componentIds->size(); }
 
bool InstrumentVisitor::isEmpty() const { return size() == 0; }
 
std::shared_ptr<const std::unordered_map<Mantid::Geometry::IComponent const *, size_t>>
InstrumentVisitor::componentIdToIndexMap() const {
  return m_componentIdToIndexMap;
}
 
std::shared_ptr<const std::unordered_map<detid_t, size_t>> InstrumentVisitor::detectorIdToIndexMap() const {
  return m_detectorIdToIndexMap;
}
 
std::unique_ptr<Beamline::ComponentInfo> InstrumentVisitor::componentInfo() const {
  return std::make_unique<Mantid::Beamline::ComponentInfo>(
      m_assemblySortedDetectorIndices, m_detectorRanges, m_assemblySortedComponentIndices, m_componentRanges,
      m_parentComponentIndices, m_children, m_positions, m_rotations, m_scaleFactors, m_componentType, m_names,
      m_sideBySideViewPositions, m_pixelGridComponents, m_sourceIndex, m_sampleIndex, m_structuredGridComponents);
}
 
std::unique_ptr<Beamline::DetectorInfo> InstrumentVisitor::detectorInfo() const {
  return std::make_unique<Mantid::Beamline::DetectorInfo>(*m_detectorPositions, *m_detectorRotations,
                                                          *m_monitorIndices);
}
 
std::shared_ptr<std::vector<detid_t>> InstrumentVisitor::detectorIds() const { return m_orderedDetectorIds; }
 
std::shared_ptr<ParameterInfo> InstrumentVisitor::makeParameterInfo() const {
  // The ParameterMap does the rekeying itself
  return m_pmap ? m_pmap->rekey(m_componentIds, m_componentIdToIndexMap) : std::make_shared<ParameterInfo>();
}
 
std::pair<std::unique_ptr<ComponentInfo>, std::unique_ptr<DetectorInfo>> InstrumentVisitor::makeWrappers() const {
  auto compInfo = componentInfo();
  auto detInfo = detectorInfo();
  // Cross link Component and Detector info objects
  compInfo->setDetectorInfo(detInfo.get());
 
  // Both wrappers must share the same parameter store and reference frame
  auto const parameterInfo = makeParameterInfo();
  auto const referenceFrame = m_instrument->getReferenceFrame();
  auto compInfoWrapper = std::make_unique<ComponentInfo>(std::move(compInfo), componentIds(), componentIdToIndexMap(),
                                                         m_shapes, parameterInfo, referenceFrame);
  auto detInfoWrapper = std::make_unique<DetectorInfo>(std::move(detInfo), m_instrument, detectorIds(),
                                                       detectorIdToIndexMap(), parameterInfo, referenceFrame);
 
  return {std::move(compInfoWrapper), std::move(detInfoWrapper)};
}
 
std::pair<std::unique_ptr<ComponentInfo>, std::unique_ptr<DetectorInfo>>
InstrumentVisitor::makeWrappers(const Instrument &instrument, ParameterMap *pmap) {
  std::shared_ptr<const Instrument> visiteeInstrument;
  if (pmap) {
    visiteeInstrument =
        ParComponentFactory::createInstrument(std::shared_ptr<const Instrument>(&instrument, NoDeleting()),
                                              std::shared_ptr<ParameterMap>(pmap, NoDeleting()));
  } else if (instrument.isParametrized()) {
    // Walk a copy of the instrument's map. The visitor rekeys the map it walks and strips the legacy
    // position parameters from it, which must not happen to a map the caller has only lent with the
    // instrument, e.g. a workspace's map lent with its physical instrument.
    auto const mapCopy = std::make_shared<ParameterMap>(*instrument.getParameterMap());
    visiteeInstrument = ParComponentFactory::createInstrument(instrument.baseInstrument(), mapCopy);
  } else {
    visiteeInstrument = std::shared_ptr<const Instrument>(&instrument, NoDeleting());
  }
  InstrumentVisitor visitor(visiteeInstrument);
  visitor.walkInstrument();
  return visitor.makeWrappers();
}
} // namespace Mantid::Geometry