MDTransfInterface.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2010 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/MatrixWorkspace_fwd.h"
 
#include "MantidGeometry/MDGeometry/MDTypes.h"
 
#include "MantidKernel/DeltaEMode.h"
#include "MantidKernel/cow_ptr.h"
 
#include "MantidMDAlgorithms/MDWSDescription.h"
 
namespace Mantid {
namespace MDAlgorithms {
class MDTransfInterface {
public:
  virtual const std::string transfID() const = 0;
  virtual std::vector<std::string> getEmodes() const { return std::vector<std::string>(1, std::string("Undefined")); }
 
  //***************> the method below involved in the calculations of MD
  // coordinates
  virtual bool calcGenericVariables(std::vector<coord_t> &Coord, size_t n_ws_variabes) = 0;
 
  virtual bool calcYDepCoordinates(std::vector<coord_t> &Coord, size_t i) = 0;
  virtual bool calcMatrixCoordinates(const MantidVec &X, size_t i, size_t j, std::vector<coord_t> &Coord, double &s,
                                     double &err) const {
    UNUSED_ARG(i);
    double X_ev = double(0.5 * (X[j] + X[j + 1])); // ! POSSIBLE FACTORY HERE
                                                   // !!! if the histogram
                                                   // interpolation is different
    return calcMatrixCoord(X_ev, Coord, s, err);
  }
 
  virtual bool calcMatrixCoord(const double &X, std::vector<coord_t> &Coord, double &signal, double &errSq) const = 0;
 
  /* clone method allowing to provide the copy of the particular class */
  virtual MDTransfInterface *clone() const = 0;
  // destructor
  virtual ~MDTransfInterface() = default;
  virtual void initialize(const MDWSDescription &) = 0;
 
  virtual std::vector<double> getExtremumPoints(const double xMin, const double xMax, size_t det_num) const = 0;
 
  //***************> the methods below are mainly involved in defining the
  // target workspace properties.
  //                 They also can be involved in the preparation to
  //                 calculations of MD coordinates
  // WARNING!!!! THESE METHODS ARE USED BEFORE INITIALIZE IS EXECUTED SO THEY
  // CAN NOT RELY ON THE CONTENTS OF THE CLASS TO BE DEFINED (THEY ARE "VIRTUAL
  // STATIC METHODS")
 
  virtual const std::string inputUnitID(Kernel::DeltaEMode::Type dEmode,
                                        API::MatrixWorkspace_const_sptr inWS) const = 0;
  virtual std::vector<std::string> outputUnitID(Kernel::DeltaEMode::Type dEmode,
                                                API::MatrixWorkspace_const_sptr inWS) const = 0;
 
  virtual std::vector<std::string> getDefaultDimID(Kernel::DeltaEMode::Type dEmode,
                                                   API::MatrixWorkspace_const_sptr inWS) const = 0;
 
  virtual unsigned int getNMatrixDimensions(Kernel::DeltaEMode::Type mode,
                                            API::MatrixWorkspace_const_sptr inWS) const = 0;
 
  virtual void setDisplayNormalization(Mantid::API::IMDWorkspace_sptr mdWorkspace,
                                       Mantid::API::MatrixWorkspace_sptr underlyingWorkspace) const = 0;
};
 
using MDTransf_sptr = std::shared_ptr<MDTransfInterface>;
using MDTransf_const_sptr = std::shared_ptr<const MDTransfInterface>;
 
} // namespace MDAlgorithms
} // namespace Mantid