ComponentInfoBankHelpers.cpp

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2020 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/ComponentInfoBankHelpers.h"
#include "MantidBeamline/ComponentType.h"
#include "MantidGeometry/Instrument/ComponentInfo.h"
#include "MantidGeometry/Instrument/DetectorInfo.h"
#include "MantidKernel/EigenConversionHelpers.h"
 
#include <algorithm>
 
using Mantid::Beamline::ComponentType;
 
namespace Mantid::Geometry::ComponentInfoBankHelpers {
bool isDetectorFixedInBank(const ComponentInfo &compInfo, const size_t detIndex) {
  auto parent = compInfo.parent(detIndex);
  auto grandParent = compInfo.parent(parent);
  auto grandParentType = compInfo.componentType(grandParent);
  auto greatGrandParent = compInfo.parent(parent); // bank
  auto greatGrandParentType = compInfo.componentType(greatGrandParent);
 
  if (compInfo.isDetector(detIndex) &&
      (grandParentType == ComponentType::Rectangular || grandParentType == ComponentType::Structured ||
       greatGrandParentType == ComponentType::Grid)) {
    return true;
  }
 
  return false;
}
 
bool isSaveableBank(const ComponentInfo &compInfo, const DetectorInfo &detInfo, const size_t idx) {
  // return false if is a detector.
  if (compInfo.isDetector(idx))
    return false;
  // needs to ignore if index is the sample
  if (compInfo.sample() == idx)
    return false;
  // needs to ignore if index is the source
  if (compInfo.source() == idx)
    return false;
  if (!compInfo.hasDetectors(idx))
    return false;
 
  // banks containing monitors are not considered saveable as are not
  // NXDetectors
  auto detectors = compInfo.detectorsInSubtree(idx);
 
  return std::none_of(detectors.cbegin(), detectors.cend(),
                      [&detInfo](const auto &det) { return detInfo.isMonitor(det); });
}
 
bool isAncestorOf(const ComponentInfo &compInfo, const size_t possibleAncestor, const size_t current) {
  size_t next = current;
  while (next != compInfo.root()) {
    if (next == possibleAncestor)
      return true;
    next = compInfo.parent(next);
  }
  return false;
}
 
Eigen::Vector3d offsetFromAncestor(const Mantid::Geometry::ComponentInfo &compInfo, const size_t ancestorIdx,
                                   const size_t currentIdx) {
 
  if ((ancestorIdx <= currentIdx)) {
    throw std::invalid_argument("Index of ancestor component is not higher than current Index.");
  }
 
  if (ancestorIdx == currentIdx) {
    return Mantid::Kernel::toVector3d(compInfo.position(currentIdx));
  } else {
    const auto ancestorPos = Mantid::Kernel::toVector3d(compInfo.position(ancestorIdx));
    auto transformation = Eigen::Affine3d(
        Mantid::Kernel::toQuaterniond(compInfo.rotation(ancestorIdx)).conjugate()); // Inverse ancestor rotation
    transformation.translate(-ancestorPos);
    return transformation * Mantid::Kernel::toVector3d(compInfo.position(currentIdx));
  }
}
 
} // namespace Mantid::Geometry::ComponentInfoBankHelpers