ReplaceSpecialValues.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2009 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 "MantidAlgorithms/UnaryOperation.h"
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL ReplaceSpecialValues : public UnaryOperation {
public:
  ReplaceSpecialValues();
  const std::string name() const override { return "ReplaceSpecialValues"; }
  const std::string summary() const override {
    return "Replaces instances of NaN and infinity in the workspace with user "
           "defined numbers. If a replacement value is not provided the check "
           "will not occur. This algorithm can also be used to replace numbers "
           "whose value is larger than a user-defined threshold.";
  }
 
  int version() const override { return 1; }
  const std::string category() const override { return "CorrectionFunctions\\SpecialCorrections"; }
 
private:
  // Overridden UnaryOperation methods
  void defineProperties() override;
  void retrieveProperties() override;
  void performUnaryOperation(const double XIn, const double YIn, const double EIn, double &YOut, double &EOut) override;
 
  bool checkIfNan(const double value) const;
  bool checkIfInfinite(const double value) const;
  bool checkIfBig(const double value) const;
  bool checkIfSmall(const double value) const;
  bool checkifPropertyEmpty(const double value) const;
 
  double m_NaNValue;      
  double m_NaNError;      
  double m_InfiniteValue; 
  double m_InfiniteError; 
  double m_bigThreshold;  
  double m_bigValue;       
  double m_bigError;       
  double m_smallThreshold; 
  double m_smallValue;     
  double m_smallError;     
 
  bool m_performNaNCheck; 
  bool m_performInfiniteCheck; 
  bool m_performBigCheck; 
  bool m_performSmallCheck; 
  bool m_checkErrors;
  bool m_useAbsolute; 
};
 
} // namespace Algorithms
} // namespace Mantid