Mantid
Loading...
Searching...
No Matches
CompactMD.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2015 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
16#include "MantidAPI/Algorithm.h"
20#include "MantidMDAlgorithms/DllConfig.h"
21#include "boost/shared_ptr.hpp"
22
23namespace Mantid {
24namespace MDAlgorithms {
25class MANTID_MDALGORITHMS_DLL CompactMD final : public API::Algorithm {
26public:
27 void init() override;
28 void exec() override;
30 const std::string name() const override { return "CompactMD"; }
32 const std::string summary() const override {
33 return "Crops an MDHistoWorkspace based on the first non-zero signals "
34 "giving a more focussed area of interest.";
35 }
36 const std::string category() const override { return "MDAlgorithms\\Utility\\Workspaces"; }
38 int version() const override { return 1; }
40 void findFirstNonZeroMinMaxExtents(const Mantid::API::IMDHistoWorkspace_sptr &inputWs,
41 std::vector<Mantid::coord_t> &minVec, std::vector<Mantid::coord_t> &maxVec);
42};
43} // namespace MDAlgorithms
44} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
int version() const override
Algorithm's version for identification.
Definition: CompactMD.h:38
const std::string summary() const override
Summary of algorithms purpose.
Definition: CompactMD.h:32
const std::string category() const override
function to return a category of the algorithm.
Definition: CompactMD.h:36
const std::string name() const override
Algorithm's name for identification.
Definition: CompactMD.h:30
std::shared_ptr< IMDHistoWorkspace > IMDHistoWorkspace_sptr
shared pointer to Mantid::API::IMDHistoWorkspace
Helper class which provides the Collimation Length for SANS instruments.