Mantid
Loading...
Searching...
No Matches
IntegratePeaksMDHKL.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
4// NScD Oak Ridge National Laboratory, European Spallation Source,
5// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
6// SPDX - License - Identifier: GPL - 3.0 +
7#pragma once
8
15#include "MantidMDAlgorithms/DllConfig.h"
16
17namespace Mantid {
18namespace MDAlgorithms {
19
25class MANTID_MDALGORITHMS_DLL IntegratePeaksMDHKL final : public API::Algorithm {
26public:
28 const std::string name() const override { return "IntegratePeaksMDHKL"; };
30 const std::string summary() const override {
31 return "Integrate single-crystal peaks in reciprocal space, for "
32 "MDHistoWorkspaces.";
33 }
34
36 int version() const override { return 1; };
37 const std::vector<std::string> seeAlso() const override {
38 return {"IntegratePeaksHybrid", "IntegratePeaksUsingClusters", "IntegratePeaksMD", "IntegratePeaksCWSD"};
39 }
41 const std::string category() const override { return "MDAlgorithms\\Peaks;Crystal\\Integration"; }
42
43private:
45 void init() override;
47 void exec() override;
48
49 DataObjects::MDHistoWorkspace_sptr normalize(int h, int k, int l, double box, int gridPts,
50 const API::MatrixWorkspace_sptr &flux,
53 DataObjects::MDHistoWorkspace_sptr binEvent(int h, int k, int l, double box, int gridPts,
54 const API::IMDWorkspace_sptr &ws);
55 DataObjects::MDHistoWorkspace_sptr cropHisto(int h, int k, int l, double box, const API::IMDWorkspace_sptr &ws);
56 void integratePeak(const int neighborPts, const DataObjects::MDHistoWorkspace_sptr &out, double &intensity,
57 double &errorSquared);
58};
59
60} // namespace MDAlgorithms
61} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
Integrate single-crystal peaks in reciprocal-space.
const std::string summary() const override
Summary of algorithms purpose.
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm....
int version() const override
Algorithm's version for identification.
const std::string category() const override
Algorithm's category for identification.
const std::string name() const override
Algorithm's name for identification.
std::shared_ptr< IMDEventWorkspace > IMDEventWorkspace_sptr
Shared pointer to Mantid::API::IMDEventWorkspace.
std::shared_ptr< IMDWorkspace > IMDWorkspace_sptr
Shared pointer to the IMDWorkspace base class.
Definition: IMDWorkspace.h:146
std::shared_ptr< MatrixWorkspace > MatrixWorkspace_sptr
shared pointer to the matrix workspace base class
std::shared_ptr< MDHistoWorkspace > MDHistoWorkspace_sptr
A shared pointer to a MDHistoWorkspace.
MANTID_KERNEL_DLL V3D normalize(V3D v)
Normalizes a V3D.
Definition: V3D.h:341
Helper class which provides the Collimation Length for SANS instruments.