StructuredDetector.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2016 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/CSGObject.h"
#include <string>
#include <vector>
 
namespace Mantid {
namespace Geometry {
class ComponentVisitor;
class MANTID_GEOMETRY_DLL StructuredDetector : public CompAssembly, public IObjComponent {
public:
  std::string type() const override { return "StructuredDetector"; }
 
  static bool compareName(const std::string &proposedMatch);
 
  StructuredDetector();
 
  StructuredDetector(const std::string &name, IComponent *reference = nullptr);
 
  StructuredDetector(const StructuredDetector *base, const ParameterMap *map);
 
  void initialize(size_t xPixels, size_t yPixels, std::vector<double> &&x, std::vector<double> &&y, bool isZBeam,
                  detid_t idStart, bool idFillByFirstY, int idStepByRow, int idStep = 1);
 
  IComponent *clone() const override;
 
  std::shared_ptr<Detector> getAtXY(const size_t x, const size_t y) const;
 
  detid_t getDetectorIDAtXY(const size_t X, const size_t Y) const;
  std::pair<size_t, size_t> getXYForDetectorID(const detid_t detectorID) const;
 
  std::vector<double> const &getXValues() const;
  std::vector<double> const &getYValues() const;
 
  void setColors(const std::vector<int> &r, const std::vector<int> &g, const std::vector<int> &b) const;
 
  std::vector<int> const &getR() const;
  std::vector<int> const &getG() const;
  std::vector<int> const &getB() const;
 
  size_t xPixels() const;
  size_t yPixels() const;
  detid_t idStart() const;
  bool idFillByFirstY() const;
  int idStepByRow() const;
  int idStep() const;
 
  detid_t minDetectorID();
  detid_t maxDetectorID();
 
  std::shared_ptr<const IComponent> getComponentByName(const std::string &cname, int nlevels = 0) const override;
 
  // 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;
 
  // ------------ 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;
 
  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;
 
  // ------------ End of IObjComponent methods ----------------
private:
  void init();
 
  void createDetectors();
 
  Detector *addDetector(CompAssembly *parent, const std::string &name, size_t x, size_t y, detid_t id);
  const StructuredDetector *m_base;
  StructuredDetector &operator=(const ICompAssembly &);
 
  size_t m_xPixels;
  size_t m_yPixels;
 
  detid_t m_minDetId;
  detid_t m_maxDetId;
 
  detid_t m_idStart;
  bool m_idFillByFirstY;
  int m_idStepByRow;
  int m_idStep;
 
  std::vector<double> m_xvalues;
  std::vector<double> m_yvalues;
 
  mutable std::vector<int> r;
  mutable std::vector<int> g;
  mutable std::vector<int> b;
};
 
MANTID_GEOMETRY_DLL std::ostream &operator<<(std::ostream &, const StructuredDetector &);
 
using StructuredDetector_sptr = std::shared_ptr<StructuredDetector>;
using StructuredDetector_const_sptr = std::shared_ptr<const StructuredDetector>;
} // namespace Geometry
} // namespace Mantid