Min.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 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 +
#pragma once
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidAlgorithms/DllConfig.h"
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL Min final : public API::Algorithm {
public:
  const std::string name() const override { return "Min"; }
  int version() const override { return (1); }
  const std::vector<std::string> seeAlso() const override { return {"Max", "MaxMin"}; }
  const std::string category() const override { return "Arithmetic"; }
  const std::string summary() const override {
    return "Takes a 2D workspace as input and find the minimum in each 1D "
           "spectrum. "
           "The algorithm creates a new 1D workspace containing all minima as "
           "well as their X boundaries and error. "
           "This is used in particular for single crystal as a quick way to "
           "find strong peaks.";
  }
 
private:
  // Overridden Algorithm methods
  void init() override;
  void exec() override;
};
 
} // namespace Algorithms
} // namespace Mantid