PeakTransform.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 <utility>
 
#include "MantidGeometry/Crystal/PeakTransform.h"
 
namespace Mantid::Geometry {
PeakTransform::PeakTransform(std::string xPlotLabel, std::string yPlotLabel, const boost::regex &regexOne,
                             const boost::regex &regexTwo, const boost::regex &regexThree)
    : m_xPlotLabel(std::move(xPlotLabel)), m_yPlotLabel(std::move(yPlotLabel)), m_indexOfPlotX(0), m_indexOfPlotY(1),
      m_indexOfPlotZ(2), m_indexOfPeakX(0), m_indexOfPeakY(1), m_indexOfPeakZ(2), m_FirstRegex(regexOne),
      m_SecondRegex(regexTwo), m_ThirdRegex(regexThree) {
  const std::string &xLabel = m_xPlotLabel;
  const std::string &yLabel = m_yPlotLabel;
 
  const int FirstIndex = 0; // Maybe more appropriate to call this IndexZero etc.
  const int SecondIndex = 1;
  const int ThirdIndex = 2;
 
  if (boost::regex_match(xLabel, m_FirstRegex) && boost::regex_match(yLabel, m_SecondRegex)) // HKL
  {
    m_indexOfPlotX = FirstIndex;
    m_indexOfPlotY = SecondIndex;
    m_indexOfPlotZ = ThirdIndex;
 
    m_indexOfPeakX = FirstIndex;
    m_indexOfPeakY = SecondIndex;
    m_indexOfPeakZ = ThirdIndex;
  } else if (boost::regex_match(xLabel, m_FirstRegex) && boost::regex_match(yLabel, m_ThirdRegex)) // HLK
  {
    m_indexOfPlotX = FirstIndex;
    m_indexOfPlotY = ThirdIndex;
    m_indexOfPlotZ = SecondIndex;
 
    m_indexOfPeakX = FirstIndex;
    m_indexOfPeakY = ThirdIndex;
    m_indexOfPeakZ = SecondIndex;
  } else if (boost::regex_match(xLabel, m_ThirdRegex) && boost::regex_match(yLabel, m_FirstRegex)) // LHK
  {
    m_indexOfPlotX = ThirdIndex;
    m_indexOfPlotY = FirstIndex;
    m_indexOfPlotZ = SecondIndex;
 
    m_indexOfPeakX = SecondIndex;
    m_indexOfPeakY = ThirdIndex;
    m_indexOfPeakZ = FirstIndex;
  } else if (boost::regex_match(xLabel, m_ThirdRegex) && boost::regex_match(yLabel, m_SecondRegex)) // LKH
  {
    m_indexOfPlotX = ThirdIndex;
    m_indexOfPlotY = SecondIndex;
    m_indexOfPlotZ = FirstIndex;
 
    m_indexOfPeakX = ThirdIndex;
    m_indexOfPeakY = SecondIndex;
    m_indexOfPeakZ = FirstIndex;
  } else if (boost::regex_match(xLabel, m_SecondRegex) && boost::regex_match(yLabel, m_ThirdRegex)) // KLH
  {
    m_indexOfPlotX = SecondIndex;
    m_indexOfPlotY = ThirdIndex;
    m_indexOfPlotZ = FirstIndex;
 
    m_indexOfPeakX = ThirdIndex;
    m_indexOfPeakY = FirstIndex;
    m_indexOfPeakZ = SecondIndex;
  } else if (boost::regex_match(xLabel, m_SecondRegex) && boost::regex_match(yLabel, m_FirstRegex)) // KHL
  {
    m_indexOfPlotX = SecondIndex;
    m_indexOfPlotY = FirstIndex;
    m_indexOfPlotZ = ThirdIndex;
 
    m_indexOfPeakX = SecondIndex;
    m_indexOfPeakY = FirstIndex;
    m_indexOfPeakZ = ThirdIndex;
  } else {
    throw PeakTransformException();
  }
}
 
boost::regex PeakTransform::getFreePeakAxisRegex() const {
  switch (m_indexOfPlotZ) {
  case 0:
    return m_FirstRegex;
  case 1:
    return m_SecondRegex;
  default:
    return m_ThirdRegex;
  }
}
 
Mantid::Kernel::V3D PeakTransform::transform(const Mantid::Kernel::V3D &original) const {
  // Will have the plots x, y, and z aligned to the correct h, k, l value.
  Mantid::Kernel::V3D transformedPeakPosition;
  transformedPeakPosition.setX(original[m_indexOfPlotX]);
  transformedPeakPosition.setY(original[m_indexOfPlotY]);
  transformedPeakPosition.setZ(original[m_indexOfPlotZ]);
  return transformedPeakPosition;
}
 
Mantid::Kernel::V3D PeakTransform::transformBack(const Mantid::Kernel::V3D &transformed) const {
  // Will have the plots x, y, and z aligned to the correct h, k, l value.
  Mantid::Kernel::V3D originalPeakPosition;
  originalPeakPosition.setX(transformed[m_indexOfPeakX]);
  originalPeakPosition.setY(transformed[m_indexOfPeakY]);
  originalPeakPosition.setZ(transformed[m_indexOfPeakZ]);
  return originalPeakPosition;
}
} // namespace Mantid::Geometry