ComponentHelper.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/ComponentHelper.h"
#include "MantidGeometry/IComponent.h"
#include "MantidGeometry/Instrument/Detector.h"
#include "MantidGeometry/Instrument/ParameterMap.h"
#include "MantidGeometry/Instrument/ReferenceFrame.h"
#include "MantidGeometry/Objects/CSGObject.h"
#include "MantidGeometry/Objects/ShapeFactory.h"
 
#include <memory>
 
namespace Mantid::Geometry::ComponentHelper {
using Kernel::V3D;
 
Geometry::Instrument_sptr createMinimalInstrument(const Mantid::Kernel::V3D &sourcePos,
                                                  const Mantid::Kernel::V3D &samplePos,
                                                  const Mantid::Kernel::V3D &detectorPos) {
  Instrument_sptr instrument = std::make_shared<Instrument>();
  instrument->setReferenceFrame(
      std::make_shared<ReferenceFrame>(Mantid::Geometry::Y /*up*/, Mantid::Geometry::X /*along*/, Left, "0,0,0"));
 
  // A source
  ObjComponent *source = new ObjComponent("source");
  source->setPos(sourcePos);
  source->setShape(createSphere(0.01 /*1cm*/, V3D(0, 0, 0), "1"));
  instrument->add(source);
  instrument->markAsSource(source);
 
  // A sample
  Component *sample = new Component("some-surface-holder");
  sample->setPos(samplePos);
  instrument->add(sample);
  instrument->markAsSamplePos(sample);
 
  // A detector
  Detector *det = new Detector("point-detector", 1 /*detector id*/, nullptr);
  det->setPos(detectorPos);
  det->setShape(createSphere(0.01 /*1cm*/, V3D(0, 0, 0), "1"));
  instrument->add(det);
  instrument->markAsDetector(det);
 
  return instrument;
}
 
Geometry::Instrument_sptr createVirtualInstrument(Kernel::V3D sourcePos, Kernel::V3D samplePos,
                                                  const std::vector<Kernel::V3D> &vecdetpos,
                                                  const std::vector<detid_t> &vecdetid) {
  Instrument_sptr instrument = std::make_shared<Instrument>();
  instrument->setReferenceFrame(
      std::make_shared<ReferenceFrame>(Mantid::Geometry::Y /*up*/, Mantid::Geometry::Z /*along*/, Right, "0,0,0"));
 
  // A source
  ObjComponent *source = new ObjComponent("source");
  source->setPos(sourcePos);
  source->setShape(createSphere(0.01 /*1cm*/, V3D(0, 0, 0), "1"));
  instrument->add(source);
  instrument->markAsSource(source);
 
  // A sample
  Component *sample = new Component("some-surface-holder");
  sample->setPos(samplePos);
  instrument->add(sample);
  instrument->markAsSamplePos(sample);
 
  // A detector
  size_t numdets = vecdetpos.size();
  for (size_t i = 0; i < numdets; ++i) {
    Detector *det = new Detector("point-detector", vecdetid[i] /*detector id*/, nullptr);
    det->setPos(vecdetpos[i]);
    // FIXME - should be cubi... pixel
    det->setShape(createSphere(0.01 /*1cm*/, V3D(0, 0, 0), "1"));
    instrument->add(det);
    instrument->markAsDetector(det);
  }
 
  return instrument;
}
 
std::shared_ptr<CSGObject> createSphere(double radius, const V3D &centre, const std::string &id) {
  ShapeFactory shapeMaker;
  return shapeMaker.createShape(sphereXML(radius, centre, id));
}
 
std::string sphereXML(double radius, const Kernel::V3D &centre, const std::string &id) {
  std::ostringstream xml;
  xml << "<sphere id=\"" << id << "\">"
      << "<centre x=\"" << centre.X() << "\"  y=\"" << centre.Y() << "\" z=\"" << centre.Z() << "\" />"
      << "<radius val=\"" << radius << "\" />"
      << "</sphere>";
  return xml.str();
}
 
} // namespace Mantid::Geometry::ComponentHelper