RadiusSum.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2013 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
 
#include "MantidAPI/Algorithm.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidKernel/V3D.h"
 
namespace Mantid {
namespace Algorithms {
 
class MANTID_ALGORITHMS_DLL RadiusSum final : public API::Algorithm {
public:
  const std::string name() const override;
  const std::string summary() const override {
    return "Sum of all the counts inside a ring against the scattering angle "
           "for each Radius.";
  }
 
  int version() const override;
  const std::vector<std::string> seeAlso() const override { return {"RingProfile", "RadiusSum"}; }
  const std::string category() const override;
 
  static bool inputWorkspaceHasInstrumentAssociated(const API::MatrixWorkspace_sptr &);
 
  static std::vector<double> getBoundariesOfNumericImage(const API::MatrixWorkspace_sptr &);
 
  static std::vector<double> getBoundariesOfInstrument(const API::MatrixWorkspace_sptr &);
 
  static void centerIsInsideLimits(const std::vector<double> &centre, const std::vector<double> &boundaries);
 
private:
  void init() override;
  void exec() override;
 
  std::vector<double> processInstrumentRadiusSum();
  std::vector<double> processNumericImageRadiusSum();
 
  void cacheInputPropertyValues();
  void inputValidationSanityCheck();
  void numBinsIsReasonable();
  std::vector<double> getBoundariesOfInputWorkspace();
 
  double getMaxDistance(const Kernel::V3D &centre, const std::vector<double> &boundary_limits);
 
  void setUpOutputWorkspace(const std::vector<double> &values);
 
  int getBinForPixelPos(const Kernel::V3D &pos);
 
  Kernel::V3D centre;
  int num_bins = 0;
 
  API::MatrixWorkspace_sptr inputWS;
  double min_radius = 0.0, max_radius = 0.0;
 
  double getMinBinSizeForInstrument(const API::MatrixWorkspace_sptr &);
  double getMinBinSizeForNumericImage(const API::MatrixWorkspace_sptr &);
 
  int fromDistanceToBin(double distance) {
    return static_cast<int>(((distance - min_radius) * num_bins) / (max_radius - min_radius));
  }
 
  void normalizeOutputByRadius(std::vector<double> &values, double exp_power);
};
 
} // namespace Algorithms
} // namespace Mantid