Mantid
Loading...
Searching...
No Matches
IntegrateEllipsoidsV1.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
18
19namespace Mantid {
20namespace Geometry {
21class DetectorInfo;
22}
23namespace MDAlgorithms {
24
25class MANTID_MDALGORITHMS_DLL IntegrateEllipsoidsV1 final : public API::Algorithm {
26public:
27 static void initInstance(API::Algorithm &alg);
28 const std::string name() const override;
30 const std::string summary() const override {
31 return "Integrate Single Crystal Diffraction Bragg peaks using 3D "
32 "ellipsoids.";
33 }
34
35 int version() const override;
36 const std::vector<std::string> seeAlso() const override { return {"IntegrateEllipsoidsTwoStep"}; }
37 const std::string category() const override;
38
39private:
40 using PrincipleAxes = std::array<std::vector<double>, 3>;
41
42 void init() override;
43 void exec() override;
44 void qListFromEventWS(Integrate3DEvents &integrator, API::Progress &prog, DataObjects::EventWorkspace_sptr &wksp,
45 Kernel::DblMatrix const &UBinv, bool hkl_integ);
46 void qListFromHistoWS(Integrate3DEvents &integrator, API::Progress &prog, DataObjects::Workspace2D_sptr &wksp,
47 Kernel::DblMatrix const &UBinv, bool hkl_integ);
48
50 void calculateE1(const Geometry::DetectorInfo &detectorInfo);
51
52 void runMaskDetectors(const Mantid::DataObjects::PeaksWorkspace_sptr &peakWS, const std::string &property,
53 const std::string &values);
54
56 std::vector<Kernel::V3D> E1Vec;
57
59
60 void initTargetWSDescr(API::MatrixWorkspace_sptr &wksp);
61};
62
63} // namespace MDAlgorithms
64} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
Helper class for reporting progress from algorithms.
Definition: Progress.h:25
Geometry::DetectorInfo is an intermediate step towards a DetectorInfo that is part of Instrument-2....
Definition: DetectorInfo.h:49
This is a low-level class to construct a map with lists of events near each peak Q-vector,...
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm....
std::array< std::vector< double >, 3 > PrincipleAxes
std::vector< Kernel::V3D > E1Vec
save for all detector pixels
const std::string summary() const override
Summary of algorithms purpose.
helper class describes the properties of target MD workspace, which should be obtained as the result ...
std::shared_ptr< MatrixWorkspace > MatrixWorkspace_sptr
shared pointer to the matrix workspace base class
std::shared_ptr< Workspace2D > Workspace2D_sptr
shared pointer to Mantid::DataObjects::Workspace2D
std::shared_ptr< PeaksWorkspace > PeaksWorkspace_sptr
Typedef for a shared pointer to a peaks workspace.
std::shared_ptr< EventWorkspace > EventWorkspace_sptr
shared pointer to the EventWorkspace class
Helper class which provides the Collimation Length for SANS instruments.