InstrumentVisitor.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2017 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 +
#pragma once
 
#include "MantidBeamline/ComponentType.h"
#include "MantidBeamline/PixelGridComponent.h"
#include "MantidBeamline/StructuredGridComponent.h"
#include "MantidGeometry/DllConfig.h"
#include "MantidGeometry/Instrument/ComponentVisitor.h"
#include <Eigen/Geometry>
#include <Eigen/StdVector>
#include <cstddef>
#include <map>
#include <memory>
#include <unordered_map>
#include <utility>
 
namespace Mantid {
using detid_t = int32_t;
namespace Beamline {
class ComponentInfo;
class DetectorInfo;
} // namespace Beamline
namespace Geometry {
class ComponentInfo;
class DetectorInfo;
class ICompAssembly;
class IComponent;
class IDetector;
class IObjComponent;
class Instrument;
class IObject;
class ParameterInfo;
class ParameterMap;
class RectangularDetector;
class ObjCompAssembly;
 
class MANTID_GEOMETRY_DLL InstrumentVisitor : public Mantid::Geometry::ComponentVisitor {
private:
  std::shared_ptr<std::vector<detid_t>> m_orderedDetectorIds;
 
  std::shared_ptr<std::vector<Mantid::Geometry::IComponent *>> m_componentIds;
 
  std::shared_ptr<std::vector<size_t>> m_assemblySortedDetectorIndices;
 
  std::shared_ptr<std::vector<size_t>> m_assemblySortedComponentIndices;
 
  std::shared_ptr<std::vector<size_t>> m_parentComponentIndices;
 
  std::shared_ptr<std::vector<std::vector<size_t>>> m_children;
 
  std::shared_ptr<std::vector<std::pair<size_t, size_t>>> m_detectorRanges;
 
  std::shared_ptr<std::vector<std::pair<size_t, size_t>>> m_componentRanges;
 
  std::shared_ptr<std::unordered_map<Mantid::Geometry::IComponent const *, size_t>> m_componentIdToIndexMap;
 
  std::shared_ptr<const std::unordered_map<detid_t, size_t>> m_detectorIdToIndexMap;
 
  std::shared_ptr<std::vector<Eigen::Vector3d>> m_positions;
 
  std::shared_ptr<std::vector<Eigen::Vector3d>> m_detectorPositions;
 
  std::shared_ptr<std::vector<Eigen::Quaterniond, Eigen::aligned_allocator<Eigen::Quaterniond>>> m_rotations;
 
  std::shared_ptr<std::vector<Eigen::Quaterniond, Eigen::aligned_allocator<Eigen::Quaterniond>>> m_detectorRotations;
 
  std::shared_ptr<std::vector<size_t>> m_monitorIndices;
 
  std::shared_ptr<const Mantid::Geometry::Instrument> m_instrument;
 
  Mantid::Geometry::ParameterMap *m_pmap;
 
  Mantid::Geometry::IComponent *m_sourceId;
 
  Mantid::Geometry::IComponent *m_sampleId;
 
  int64_t m_sourceIndex = -1;
 
  int64_t m_sampleIndex = -1;
 
  std::shared_ptr<const Mantid::Geometry::IObject> m_nullShape;
 
  std::shared_ptr<std::vector<std::shared_ptr<const Mantid::Geometry::IObject>>> m_shapes;
 
  std::shared_ptr<std::vector<Eigen::Vector3d>> m_scaleFactors;
 
  std::shared_ptr<std::vector<Beamline::ComponentType>> m_componentType;
 
  std::shared_ptr<std::vector<std::string>> m_names;
 
  std::shared_ptr<std::map<size_t, Eigen::Vector2d>> m_sideBySideViewPositions;
 
  std::shared_ptr<std::map<size_t, Beamline::PixelGridComponent>> m_pixelGridComponents;
 
  std::shared_ptr<std::map<size_t, Beamline::StructuredGridComponent>> m_structuredGridComponents;
 
  void markAsSourceOrSample(Mantid::Geometry::IComponent *componentId, const size_t componentIndex);
 
  std::shared_ptr<ParameterInfo> makeParameterInfo() const;
 
  size_t commonRegistration(const Mantid::Geometry::IComponent &component);
 
public:
  InstrumentVisitor(std::shared_ptr<const Instrument> instrument);
 
  void walkInstrument();
 
  virtual size_t registerComponentAssembly(const Mantid::Geometry::ICompAssembly &assembly) override;
 
  virtual size_t registerGenericComponent(const Mantid::Geometry::IComponent &component) override;
 
  virtual size_t registerInfiniteComponent(const Mantid::Geometry::IComponent &component) override;
 
  virtual size_t registerGenericObjComponent(const Mantid::Geometry::IObjComponent &objComponent) override;
 
  virtual size_t registerGridBank(const Mantid::Geometry::ICompAssembly &bank) override;
 
  virtual size_t registerRectangularBank(const Mantid::Geometry::ICompAssembly &bank) override;
 
  virtual size_t registerInfiniteObjComponent(const IObjComponent &objComponent) override;
 
  virtual size_t registerStructuredBank(const Mantid::Geometry::ICompAssembly &bank) override;
 
  virtual size_t registerDetector(const Mantid::Geometry::IDetector &detector) override;
 
  virtual size_t registerObjComponentAssembly(const ObjCompAssembly &obj) override;
 
  std::shared_ptr<const std::vector<Mantid::Geometry::IComponent *>> componentIds() const;
 
  std::shared_ptr<const std::unordered_map<Mantid::Geometry::IComponent const *, size_t>> componentIdToIndexMap() const;
 
  std::shared_ptr<const std::unordered_map<detid_t, size_t>> detectorIdToIndexMap() const;
  size_t size() const;
 
  bool isEmpty() const;
 
  std::unique_ptr<Beamline::ComponentInfo> componentInfo() const;
  std::unique_ptr<Beamline::DetectorInfo> detectorInfo() const;
 
  std::shared_ptr<std::vector<detid_t>> detectorIds() const;
 
  std::pair<std::unique_ptr<ComponentInfo>, std::unique_ptr<DetectorInfo>> makeWrappers() const;
 
  static std::pair<std::unique_ptr<ComponentInfo>, std::unique_ptr<DetectorInfo>>
  makeWrappers(const Instrument &instrument, ParameterMap *pmap = nullptr);
};
} // namespace Geometry
} // namespace Mantid