AddPeakHKL.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 "MantidCrystal/AddPeakHKL.h"
 
#include "MantidGeometry/Crystal/IPeak.h"
 
#include "MantidAPI/IPeaksWorkspace.h"
#include "MantidKernel/ArrayLengthValidator.h"
#include "MantidKernel/ArrayProperty.h"
 
namespace Mantid::Crystal {
 
using namespace Mantid::Kernel;
using namespace Mantid::API;
 
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(AddPeakHKL)
 
//----------------------------------------------------------------------------------------------
 
 
const std::string AddPeakHKL::name() const { return "AddPeakHKL"; }
 
int AddPeakHKL::version() const { return 1; }
 
const std::string AddPeakHKL::category() const { return "Crystal\\Peaks"; }
 
const std::string AddPeakHKL::summary() const { return "Add a peak in the hkl frame"; }
 
//----------------------------------------------------------------------------------------------
void AddPeakHKL::init() {
  declareProperty(std::make_unique<WorkspaceProperty<Mantid::API::IPeaksWorkspace>>("Workspace", "", Direction::InOut),
                  "An input workspace.");
  declareProperty(std::make_unique<ArrayProperty<double>>("HKL", std::make_shared<ArrayLengthValidator<double>>(3)),
                  "HKL point to add");
}
 
//----------------------------------------------------------------------------------------------
void AddPeakHKL::exec() {
  IPeaksWorkspace_sptr peakWS = this->getProperty("Workspace");
  const std::vector<double> hklValue = this->getProperty("HKL");
  auto peak =
      std::unique_ptr<Mantid::Geometry::IPeak>(peakWS->createPeakHKL(V3D(hklValue[0], hklValue[1], hklValue[2])));
  peakWS->addPeak(*peak);
}
 
} // namespace Mantid::Crystal