GridDetector.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2011 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 "MantidGeometry/DllConfig.h"
#include "MantidGeometry/IObjComponent.h"
#include "MantidGeometry/Instrument/CompAssembly.h"
#include "MantidGeometry/Instrument/Detector.h"
#include "MantidGeometry/Objects/IObject.h"
#include <string>
#include <tuple>
#include <vector>
 
namespace Mantid {
namespace Geometry {
 
class ComponentVisitor;
class MANTID_GEOMETRY_DLL GridDetector : public CompAssembly, public IObjComponent {
  friend class GridDetectorPixel;
 
public:
  std::string type() const override { return "GridDetector"; }
 
  GridDetector(const std::string &name, IComponent *reference = nullptr);
 
  GridDetector(const GridDetector *base, const ParameterMap *map);
 
  static bool compareName(const std::string &proposedMatch);
 
  void initialize(std::shared_ptr<IObject> shape, int xpixels, double xstart, double xstep, int ypixels, double ystart,
                  double ystep, int zpixels, double zstart, double zstep, int idstart, const std::string &idFillOrder,
                  int idstepbyrow, int idstep = 1);
 
  GridDetector *clone() const override;
 
  detid_t getDetectorIDAtXYZ(const int x, const int y, const int z) const;
  std::tuple<int, int, int> getXYZForDetectorID(const detid_t detectorID) const;
 
  int const &xpixels() const;
  int const &ypixels() const;
  int const &zpixels() const;
 
  double xstep() const;
  double ystep() const;
  double zstep() const;
 
  double xstart() const;
  double ystart() const;
  double zstart() const;
 
  double xsize() const;
  double ysize() const;
  double zsize() const;
 
  int const &idstart() const;
  int const &idstepbyrow() const;
  int const &idstep() const;
  bool const &idfillbyfirst_y() const;
 
  Kernel::V3D getRelativePosAtXYZ(int const x, int const y, int const z) const;
  detid_t const &minDetectorID() const;
  detid_t const &maxDetectorID() const;
  std::shared_ptr<const IComponent> getComponentByName(const std::string &cname, int nlevels = 0) const override;
 
  Kernel::V3D getPosAtXYZ(int const x, int const y, int const z) const;
 
  // This should inherit the getBoundingBox implementation from  CompAssembly
  // but the multiple inheritance seems to confuse it so we'll explicityly tell
  // it that here
  using CompAssembly::getBoundingBox;
 
  void testIntersectionWithChildren(Track &testRay, std::deque<IComponent_const_sptr> &searchQueue) const override;
 
  // ------------ IObjComponent methods ----------------
 
  bool isValid(const Kernel::V3D &point) const override;
 
  bool isOnSide(const Kernel::V3D &point) const override;
 
  int interceptSurface(Track &track) const override;
 
  double solidAngle(const Geometry::SolidAngleParams &params) const override;
  void getBoundingBox(BoundingBox &assemblyBox) const override;
 
  void getBoundingBoxAtXYZ(int const x, int const y, int const z, BoundingBox &box) const;
 
  int getPointInObject(Kernel::V3D &point) const override;
 
  // Rendering member functions
  void draw() const override;
 
  void drawObject() const override;
 
  void initDraw() const override;
 
  const std::shared_ptr<const IObject> shape() const override;
  const Kernel::Material material() const override;
 
  virtual size_t registerContents(class ComponentVisitor &componentVisitor) const override;
 
  std::array<char, 3UL> const &idFillOrder() const;
 
  bool inBoundsXYZ(const int x, const int y, const int z) const;
 
  // ------------ End of IObjComponent methods ----------------
protected:
  void init();
  void createLayer(const std::string &name, CompAssembly *parent, int iz, int &minDetID, int &maxDetID);
 
  std::shared_ptr<Detector> getAtXYZ(const int x, const int y, const int z) const;
 
private:
  void initializeValues(std::shared_ptr<IObject> shape, int xpixels, double xstart, double xstep, int ypixels,
                        double ystart, double ystep, int zpixels, double zstart, double zstep, int idstart,
                        const std::string &idFillOrder, int idstepbyrow, int idstep);
 
  void validateInput() const;
  const GridDetector *m_gridBase;
  bool isParametrized() const override { return m_map && m_gridBase; }
  GridDetector &operator=(const ICompAssembly &);
 
  int m_xpixels;
  int m_ypixels;
  int m_zpixels;
 
  double m_xsize;
  double m_ysize;
  double m_zsize;
 
  double m_xstart;
  double m_ystart;
  double m_zstart;
 
  double m_xstep;
  double m_ystep;
  double m_zstep;
 
  std::shared_ptr<IObject> m_shape;
  detid_t m_minDetId;
  detid_t m_maxDetId;
 
  int m_idstart;
  bool m_idfillbyfirst_y;
  std::array<char, 3UL> m_idFillOrder;
  int m_idstepbyrow;
  int m_idstep;
};
 
MANTID_GEOMETRY_DLL std::ostream &operator<<(std::ostream &, const GridDetector &);
 
using GridDetector_sptr = std::shared_ptr<GridDetector>;
using GridDetector_const_sptr = std::shared_ptr<const GridDetector>;
 
} // Namespace Geometry
} // Namespace Mantid