Mantid
Loading...
Searching...
No Matches
FindUBUsingIndexedPeaks.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2011 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
10#include "MantidCrystal/DllConfig.h"
13
14namespace Mantid {
15namespace Crystal {
22class MANTID_CRYSTAL_DLL FindUBUsingIndexedPeaks final : public API::Algorithm {
23public:
25 const std::string name() const override { return "FindUBUsingIndexedPeaks"; };
26
28 int version() const override { return 1; };
29 const std::vector<std::string> seeAlso() const override {
30 return {"SetUB", "FindUBUsingFFT", "FindUBUsingLatticeParameters", "FindUBUsingMinMaxD"};
31 }
32
34 const std::string category() const override { return "Crystal\\UBMatrix"; }
35
37 const std::string summary() const override {
38 return "Calculate the UB matrix from a peaks workspace, containing indexed "
39 "peaks.";
40 }
41
42private:
44 void init() override;
45
47 void exec() override;
48 void logLattice(const Geometry::OrientedLattice &o_lattice, const int &ModDim);
50 bool isPeakIndexed(const Geometry::IPeak &peak);
51};
52
53} // namespace Crystal
54} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
FindUBUsingIndexedPeaks : Algorithm to calculate a UB matrix, given a list of peaks that have already...
const std::string summary() const override
Summary of algorithms purpose.
const std::string name() const override
Algorithm's name for identification.
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.
int getModulationDimension(Kernel::V3D &mnp)
Structure describing a single-crystal peak.
Definition: IPeak.h:26
Class to implement UB matrix.
Class for 3D vectors.
Definition: V3D.h:34
Helper class which provides the Collimation Length for SANS instruments.