MDTransfModQ.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 "MantidMDAlgorithms/MDTransfFactory.h"
#include "MantidMDAlgorithms/MDTransfInterface.h"
//
namespace Mantid {
namespace MDAlgorithms {
 
class MANTID_MDALGORITHMS_DLL MDTransfModQ : public MDTransfInterface {
public:
  const std::string transfID() const override; // {return "ModQ"; }
  std::vector<std::string> getEmodes() const override;
 
  bool calcGenericVariables(std::vector<coord_t> &Coord, size_t nd) override;
  bool calcYDepCoordinates(std::vector<coord_t> &Coord, size_t i) override;
  bool calcMatrixCoord(const double &deltaEOrK0, std::vector<coord_t> &Coord, double &signal,
                       double &ErrSq) const override;
  // constructor;
  MDTransfModQ();
  /* clone method allowing to provide the copy of the particular class */
  MDTransfInterface *clone() const override { return new MDTransfModQ(*this); }
  //
  void initialize(const MDWSDescription &ConvParams) override;
 
  std::vector<double> getExtremumPoints(const double eMin, const double eMax, size_t det_num) const override;
 
  // 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)
  unsigned int
  getNMatrixDimensions(Kernel::DeltaEMode::Type mode,
                       API::MatrixWorkspace_const_sptr inWS = API::MatrixWorkspace_const_sptr()) const override;
  std::vector<std::string>
  outputUnitID(Kernel::DeltaEMode::Type dEmode,
               API::MatrixWorkspace_const_sptr inWS = API::MatrixWorkspace_const_sptr()) const override;
  std::vector<std::string>
  getDefaultDimID(Kernel::DeltaEMode::Type dEmode,
                  API::MatrixWorkspace_const_sptr inWS = API::MatrixWorkspace_const_sptr()) const override;
  const std::string
  inputUnitID(Kernel::DeltaEMode::Type dEmode,
              API::MatrixWorkspace_const_sptr inWS = API::MatrixWorkspace_const_sptr()) const override;
  void setDisplayNormalization(Mantid::API::IMDWorkspace_sptr mdWorkspace,
                               Mantid::API::MatrixWorkspace_sptr underlyingWorkspace) const override;
 
protected:
  //  directions to the detectors
  double m_ex, m_ey, m_ez;
  // the matrix which transforms the neutron momentums from laboratory to
  // crystal coordinate system.
  std::vector<double> m_RotMat;
  // min-max values, some modified to work with squared values:
  std::vector<double> m_DimMin, m_DimMax;
  // pointer to the array of V3D unit vectors, directed from the sample to the
  // positions, where preprocessed detectors are.
  Kernel::V3D const *m_DetDirecton;
 
  // number of dimensions, calculated from a matrix workspace, which is one in
  // elastic and two in inelastic mode here.
  unsigned int m_NMatrixDim;
  // the variable which describes current conversion mode:
  Kernel::DeltaEMode::Type m_Emode;
  std::vector<coord_t> m_AddDimCoordinates;
  //************* The variables below are relevant to inelastic modes only and
  // will be used in inelastic cases:
  // the wavevector of incident neutrons
  double m_kFixed;
  // the energy of the incident neutrons
  double m_eFixed;
  // pointer to detector specific input energy (eFixed) defined for indirect
  // instruments; This one is relewant to indirect instruments only;
  float *m_pEfixedArray;
  // pointer to the array which contains detectors masks. TODO: It is here
  // untill Mantid masks spectra by 0 instead of NaNs, when switched to NaN-s --
  // remove
  int *m_pDetMasks;
 
private:
  inline bool calcMatrixCoordElastic(const double &k0, std::vector<coord_t> &Coord) const;
  inline bool calcMatrixCoordInelastic(const double &deltaE, std::vector<coord_t> &Coord) const;
};
 
} // namespace MDAlgorithms
} // namespace Mantid