SpectrumInfo.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 "MantidAPI/DllConfig.h"
#include "MantidAPI/SpectrumInfoIterator.h"
#include "MantidKernel/DeltaEMode.h"
#include "MantidKernel/Unit.h"
#include "MantidKernel/V3D.h"
#include "MantidKernel/cow_ptr.h"
 
#include <memory>
 
#include <vector>
 
namespace Mantid {
using detid_t = int32_t;
class SpectrumDefinition;
namespace Beamline {
class SpectrumInfo;
}
namespace Geometry {
class BoundingBox;
class DetectorInfo;
class IDetector;
class Instrument;
class ParameterMap;
} // namespace Geometry
namespace API {
class ExperimentInfo;
 
class MANTID_API_DLL SpectrumInfo {
public:
  SpectrumInfo(const Beamline::SpectrumInfo &spectrumInfo, const ExperimentInfo &experimentInfo,
               Geometry::DetectorInfo &detectorInfo);
  ~SpectrumInfo();
 
  size_t size() const;
  size_t detectorCount() const;
 
  const SpectrumDefinition &spectrumDefinition(const size_t index) const;
  const Kernel::cow_ptr<std::vector<SpectrumDefinition>> &sharedSpectrumDefinitions() const;
 
  bool isMonitor(const size_t index) const;
  bool isMasked(const size_t index) const;
  double l2(const size_t index) const;
  double twoTheta(const size_t index) const;
  double signedTwoTheta(const size_t index) const;
  double azimuthal(const size_t index) const;
  double twoTheta(const size_t index, const Kernel::V3D &observer, const Kernel::V3D &axis) const;
  double signedTwoTheta(const size_t index, const Kernel::V3D &observer, const Kernel::V3D &axis,
                        const Kernel::V3D &instrumentUp) const;
  double signedTwoTheta(const size_t index, const Kernel::V3D &observer, const Kernel::V3D &axis) const;
  double phi(const size_t index) const;
  double phiOffset(const size_t index, const double offset) const;
  std::pair<double, double> geographicalAngles(const size_t index) const;
  Kernel::V3D position(const size_t index) const;
  Kernel::UnitParametersMap diffractometerConstants(const size_t index, std::vector<detid_t> &uncalibratedDets) const;
  Kernel::UnitParametersMap diffractometerConstants(const size_t index) const;
  double difcUncalibrated(const size_t index) const;
  bool hasDetectors(const size_t index) const;
  bool hasUniqueDetector(const size_t index) const;
  detid_t firstDetectorID(const size_t index) const;
  size_t firstDetectorIndex(const size_t index) const;
  Geometry::BoundingBox boundingBox(const size_t index) const;
 
  void setMasked(const size_t index, bool masked);
 
  // This is likely to be deprecated/removed with the introduction of
  // Instrument-2.0: The concept of detector groups will probably be dropped so
  // returning a single detector for a spectrum will not be possible anymore.
  const Geometry::IDetector &detector(const size_t index) const;
 
  // This does not really belong into SpectrumInfo, but it seems to be useful
  // while Instrument-2.0 does not exist.
  Kernel::V3D sourcePosition() const;
  Kernel::V3D samplePosition() const;
  double l1() const;
 
  void getDetectorValues(const Kernel::Unit &inputUnit, const Kernel::Unit &outputUnit,
                         const Kernel::DeltaEMode::Type emode, const bool signedTheta, int64_t wsIndex,
                         Kernel::UnitParametersMap &pmap) const;
  void createDetectorIdLogMessages(const std::vector<detid_t> &detids, int64_t wsIndex) const;
 
  SpectrumInfoIterator<SpectrumInfo> begin();
  SpectrumInfoIterator<SpectrumInfo> end();
  const SpectrumInfoIterator<const SpectrumInfo> cbegin() const;
  const SpectrumInfoIterator<const SpectrumInfo> cend() const;
 
  friend class ExperimentInfo;
 
private:
  [[deprecated("SpectrumInfo::getDetector has been deprecated in Mantid 7.1."
               "See the 'Instrument Access via SpectrumInfo, DetectorInfo, ComponentInfo' concept page, "
               "located at: https://docs.mantidproject.org/nightly/concepts/InstrumentAccessLayers.html")]]
  const Geometry::IDetector &getDetector(const size_t index) const;
  const SpectrumDefinition &checkAndGetSpectrumDefinition(const size_t index) const;
 
  const ExperimentInfo &m_experimentInfo;
  Geometry::DetectorInfo &m_detectorInfo;
  const Beamline::SpectrumInfo &m_spectrumInfo;
  mutable std::vector<std::shared_ptr<const Geometry::IDetector>> m_lastDetector;
  mutable std::vector<size_t> m_lastIndex;
};
 
using SpectrumInfoIt = SpectrumInfoIterator<SpectrumInfo>;
using SpectrumInfoConstIt = SpectrumInfoIterator<const SpectrumInfo>;
 
} // namespace API
} // namespace Mantid