MaxentCalculator.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2016 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 "MantidAlgorithms/DllConfig.h"
#include "MantidAlgorithms/MaxEnt/MaxentCoefficients.h"
#include "MantidAlgorithms/MaxEnt/MaxentEntropy.h"
#include "MantidAlgorithms/MaxEnt/MaxentTransform.h"
 
namespace Mantid {
namespace Algorithms {
 
class MANTID_ALGORITHMS_DLL MaxentCalculator final {
public:
  // Constructor
  MaxentCalculator(MaxentEntropy_sptr entropy, MaxentTransform_sptr transform);
  // Deleted default constructor
  MaxentCalculator() = delete;
  // Destructor
  virtual ~MaxentCalculator() = default;
 
  // Runs maxent iteration
  void iterate(const std::vector<double> &data, const std::vector<double> &errors, const std::vector<double> &image,
               double background, const std::vector<double> &linearAdjustments,
               const std::vector<double> &constAdjustments);
 
  // Getters
  // Returns the reconstructed (calculated) data
  std::vector<double> getReconstructedData() const;
  // Returns the image
  std::vector<double> getImage() const;
  // Returns the quadratic coefficients
  QuadraticCoefficients getQuadraticCoefficients() const;
  // Returns the search directions
  std::vector<std::vector<double>> getSearchDirections() const;
  // Returns the angle between Grad(S) and Grad(C)
  double getAngle() const;
  // Returns the chi-square
  double getChisq();
 
  std::vector<double> calculateData(const std::vector<double> &image) const;
  std::vector<double> calculateImage(const std::vector<double> &data) const;
  double calculateChiSquared(const std::vector<double> &data) const;
 
private:
  // Calculates the gradient of chi
  std::vector<double> calculateChiGrad() const;
  // Calculates chi-square
  void calculateChisq();
 
  // Member variables
  // The experimental (measured) data
  std::vector<double> m_data;
  // The experimental (measured) errors
  std::vector<double> m_errors;
  // The image
  std::vector<double> m_image;
  // The reconstructed (calculated) data
  std::vector<double> m_dataCalc;
  // The background
  double m_background;
  // The angle between Grad(C) and Grad(S)
  double m_angle;
  // Chi-square
  double m_chisq;
  // The search directions
  std::vector<std::vector<double>> m_directionsIm;
  // The quadratic coefficients
  QuadraticCoefficients m_coeffs;
 
  // The type of entropy
  MaxentEntropy_sptr m_entropy;
  // The type of transform
  MaxentTransform_sptr m_transform;
};
 
} // namespace Algorithms
} // namespace Mantid