RingProfile.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 "MantidAPI/ISpectrum.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidGeometry/IDetector.h"
#include <vector>
 
namespace Mantid {
namespace Algorithms {
 
class MANTID_ALGORITHMS_DLL RingProfile final : public API::Algorithm {
public:
  RingProfile();
 
  const std::string name() const override { return "RingProfile"; };
  const std::string summary() const override { return "Calculates the sum of the counts against a circular ring."; }
 
  int version() const override { return 1; };
  const std::vector<std::string> seeAlso() const override { return {"LineProfile"}; }
  const std::string category() const override { return "Transforms\\Grouping"; };
 
protected:
  std::shared_ptr<API::Progress> m_progress;
 
private:
  void init() override;
  void exec() override;
  int fromAngleToBin(double angle, bool degree = true);
  void checkInputsForSpectraWorkspace(const API::MatrixWorkspace_sptr &);
  void checkInputsForNumericWorkspace(const API::MatrixWorkspace_sptr &);
  void processInstrumentRingProfile(const API::MatrixWorkspace_sptr &inputWS, std::vector<double> &output_bins);
  void processNumericImageRingProfile(const API::MatrixWorkspace_sptr &inputWS, std::vector<double> &output_bins);
  void getBinForPixel(const API::MatrixWorkspace_sptr &, int, std::vector<int> &);
  int getBinForPixel(const Kernel::V3D &position);
  double min_radius;
  double max_radius;
  double start_angle;
  bool clockwise;
  int num_bins;
  double centre_x;
  double centre_y;
  double centre_z;
  double bin_size;
};
 
} // namespace Algorithms
} // namespace Mantid