MDHistoWorkspace.h

#ifndef MANTID_DATAOBJECTS_MDHISTOWORKSPACE_H_
#define MANTID_DATAOBJECTS_MDHISTOWORKSPACE_H_

#include "MantidAPI/IMDIterator.h"
#include "MantidAPI/IMDWorkspace.h"
#include "MantidAPI/MDGeometry.h"
#include "MantidGeometry/MDGeometry/IMDDimension.h"
#include "MantidGeometry/MDGeometry/MDHistoDimension.h"
#include "MantidGeometry/MDGeometry/MDImplicitFunction.h"
#include "MantidKernel/Exception.h"
#include "MantidKernel/System.h"
#include "MantidDataObjects/WorkspaceSingleValue.h"
#include "MantidAPI/IMDHistoWorkspace.h"

// using Mantid::DataObjects::WorkspaceSingleValue;
// using Mantid::API::MDNormalization;

namespace Mantid {
namespace DataObjects {

/** MDHistoWorkspace:
*
* An implementation of IMDWorkspace that contains a (normally dense) histogram
* representation in multiple dimensions.
*
* This will be the result of a slice or rebin of another workspace, e.g. a
* MDEventWorkspace. Typically it has 3 or 4 dimensions, but there is no
* real limit to it.
*
* This will be used by ParaView e.g. for visualization.
*
* @author Janik Zikovsky
* @date 2011-03-24 11:21:06.280523
*/
class DLLExport MDHistoWorkspace : public API::IMDHistoWorkspace {
public:
  MDHistoWorkspace(Mantid::Geometry::MDHistoDimension_sptr dimX,
                   Mantid::Geometry::MDHistoDimension_sptr dimY =
                       Mantid::Geometry::MDHistoDimension_sptr(),
                   Mantid::Geometry::MDHistoDimension_sptr dimZ =
                       Mantid::Geometry::MDHistoDimension_sptr(),
                   Mantid::Geometry::MDHistoDimension_sptr dimT =
                       Mantid::Geometry::MDHistoDimension_sptr(),
                   Mantid::API::MDNormalization displayNormalization =
                       Mantid::API::NoNormalization);

  MDHistoWorkspace(
      std::vector<Mantid::Geometry::MDHistoDimension_sptr> &dimensions,
      Mantid::API::MDNormalization displayNormalization =
          Mantid::API::NoNormalization);
  MDHistoWorkspace(std::vector<Mantid::Geometry::IMDDimension_sptr> &dimensions,
                   Mantid::API::MDNormalization displayNormalization =
                       Mantid::API::NoNormalization);
  MDHistoWorkspace &operator=(const MDHistoWorkspace &other) = delete;
  ~MDHistoWorkspace() override;

  /// Returns a clone of the workspace
  std::unique_ptr<MDHistoWorkspace> clone() const {
    return std::unique_ptr<MDHistoWorkspace>(doClone());
  }

  /// Returns a default-initialized clone of the workspace
  std::unique_ptr<MDHistoWorkspace> cloneEmpty() const {
    return std::unique_ptr<MDHistoWorkspace>(doCloneEmpty());
  }

  void init(std::vector<Mantid::Geometry::MDHistoDimension_sptr> &dimensions);
  void init(std::vector<Mantid::Geometry::IMDDimension_sptr> &dimensions);

  void cacheValues();

  const std::string id() const override { return "MDHistoWorkspace"; }

  size_t getMemorySize() const override;

  /// Get the number of points (bins in this case) associated with the
  /// workspace;
  uint64_t getNPoints() const override { return m_length; }
  /// get number of contributed events
  uint64_t getNEvents() const override;
  std::vector<Mantid::API::IMDIterator *> createIterators(
      size_t suggestedNumCores = 1,
      Mantid::Geometry::MDImplicitFunction *function = nullptr) const override;

  LinePlot getLinePlot(const Mantid::Kernel::VMD &start,
                       const Mantid::Kernel::VMD &end,
                       Mantid::API::MDNormalization normalize) const override;

  LinePlot getLineData(const Mantid::Kernel::VMD &start,
                       const Mantid::Kernel::VMD &end,
                       Mantid::API::MDNormalization normalize) const override;

  void checkWorkspaceSize(const MDHistoWorkspace &other, std::string operation);

  // --------------------------------------------------------------------------------------------
  MDHistoWorkspace &operator+=(const MDHistoWorkspace &b);
  void add(const MDHistoWorkspace &b);
  void add(const signal_t signal, const signal_t error);

  MDHistoWorkspace &operator-=(const MDHistoWorkspace &b);
  void subtract(const MDHistoWorkspace &b);
  void subtract(const signal_t signal, const signal_t error);

  MDHistoWorkspace &operator*=(const MDHistoWorkspace &b_ws);
  void multiply(const MDHistoWorkspace &b_ws);
  void multiply(const signal_t signal, const signal_t error);

  MDHistoWorkspace &operator/=(const MDHistoWorkspace &b_ws);
  void divide(const MDHistoWorkspace &b_ws);
  void divide(const signal_t signal, const signal_t error);

  void log(double filler = 0.0);
  void log10(double filler = 0.0);
  void exp();
  void power(double exponent);

  // --------------------------------------------------------------------------------------------
  MDHistoWorkspace &operator&=(const MDHistoWorkspace &b);
  MDHistoWorkspace &operator|=(const MDHistoWorkspace &b);
  MDHistoWorkspace &operator^=(const MDHistoWorkspace &b);
  void operatorNot();

  void lessThan(const MDHistoWorkspace &b);
  void lessThan(const signal_t signal);
  void greaterThan(const MDHistoWorkspace &b);
  void greaterThan(const signal_t signal);
  void equalTo(const MDHistoWorkspace &b, const signal_t tolerance = 1e-5);
  void equalTo(const signal_t signal, const signal_t tolerance = 1e-5);

  void setUsingMask(const MDHistoWorkspace &mask,
                    const MDHistoWorkspace &values);
  void setUsingMask(const MDHistoWorkspace &mask, const signal_t signal,
                    const signal_t error);

  // --------------------------------------------------------------------------------------------
  /** @return a const reference to the indexMultiplier array.
   * To find the index into the linear array, dim0 + indexMultiplier[0]*dim1 +
   * ...
   */
  const size_t *getIndexMultiplier() const { return indexMultiplier; }

  /** @return the direct pointer to the signal array. For speed */
  signal_t *getSignalArray() const override { return m_signals; }

  /** @return the inverse of volume of EACH cell in the workspace. For
   * normalizing. */
  coord_t getInverseVolume() const override { return m_inverseVolume; }

  /** @return the direct pointer to the error squared array. For speed */
  signal_t *getErrorSquaredArray() const override { return m_errorsSquared; }

  /** @return the direct pointer to the array of the number of events. For speed
   */
  signal_t *getNumEventsArray() const override { return m_numEvents; }

  /** @return the direct pointer to the array of mask bits (bool). For
   * speed/testing */
  bool *getMaskArray() const { return m_masks; }

  /** Return the aray of bin withs  (the linear length of a box) for each
   * dimension */
  const coord_t *getBinWidths() const { return m_boxLength; }

  /// Get the special coordinate system.
  Kernel::SpecialCoordinateSystem getSpecialCoordinateSystem() const override;

  /// Set the special coordinate system.
  void setCoordinateSystem(
      const Kernel::SpecialCoordinateSystem coordinateSystem) override;

  void setTo(signal_t signal, signal_t errorSquared,
             signal_t numEvents) override;

  void applyImplicitFunction(Mantid::Geometry::MDImplicitFunction *function,
                             signal_t signal, signal_t errorSquared);

  coord_t *getVertexesArray(size_t linearIndex, size_t &numVertices) const;

  Kernel::VMD getCenter(size_t linearIndex) const override;

  /// Returns the (normalized) signal at a given coordinates
  signal_t getSignalAtCoord(
      const coord_t *coords,
      const Mantid::API::MDNormalization &normalization) const override;

  /// Returns the (normalized) signal at a given coordinates
  // or 0 if masked
  signal_t getSignalWithMaskAtCoord(
      const coord_t *coords,
      const Mantid::API::MDNormalization &normalization) const override;

  /// Sets the signal at the specified index.
  void setSignalAt(size_t index, signal_t value) override {
    m_signals[index] = value;
  }

  /// Sets the error (squared) at the specified index.
  void setErrorSquaredAt(size_t index, signal_t value) override {
    m_errorsSquared[index] = value;
  }

  /// Sets the number of contributing events in the bin at the specified index.
  void setNumEventsAt(size_t index, signal_t value) {
    m_numEvents[index] = value;
  }

  /// Returns the number of contributing events from the bin at the specified
  /// index.
  signal_t getNumEventsAt(size_t index) const { return m_numEvents[index]; }

  /// Get the error of the signal at the specified index.
  signal_t getErrorAt(size_t index) const override {
    return std::sqrt(m_errorsSquared[index]);
  }

  /// Get the error at the specified index given in 4 dimensions (typically
  /// X,Y,Z,t)
  signal_t getErrorAt(size_t index1, size_t index2) const override {
    return std::sqrt(m_errorsSquared[index1 + indexMultiplier[0] * index2]);
  }

  /// Get the error at the specified index given in 4 dimensions (typically
  /// X,Y,Z,t)
  signal_t getErrorAt(size_t index1, size_t index2,
                      size_t index3) const override {
    return std::sqrt(m_errorsSquared[index1 + indexMultiplier[0] * index2 +
                                     indexMultiplier[1] * index3]);
  }

  /// Get the error at the specified index given in 4 dimensions (typically
  /// X,Y,Z,t)
  signal_t getErrorAt(size_t index1, size_t index2, size_t index3,
                      size_t index4) const override {
    return std::sqrt(m_errorsSquared[index1 + indexMultiplier[0] * index2 +
                                     indexMultiplier[1] * index3 +
                                     indexMultiplier[2] * index4]);
  }

  /**
  Getter for the masking at a specified linear index.
  */
  bool getIsMaskedAt(size_t index) const { return m_masks[index]; }

  /// Get the signal at the specified index.
  signal_t getSignalAt(size_t index) const override { return m_signals[index]; }

  /// Get the signal at the specified index given in 4 dimensions (typically
  /// X,Y,Z,t)
  signal_t getSignalAt(size_t index1, size_t index2) const override {
    return m_signals[index1 + indexMultiplier[0] * index2];
  }

  /// Get the signal at the specified index given in 4 dimensions (typically
  /// X,Y,Z,t)
  signal_t getSignalAt(size_t index1, size_t index2,
                       size_t index3) const override {
    return m_signals[index1 + indexMultiplier[0] * index2 +
                     indexMultiplier[1] * index3];
  }

  /// Get the signal at the specified index given in 4 dimensions (typically
  /// X,Y,Z,t)
  signal_t getSignalAt(size_t index1, size_t index2, size_t index3,
                       size_t index4) const override {
    return m_signals[index1 + indexMultiplier[0] * index2 +
                     indexMultiplier[1] * index3 + indexMultiplier[2] * index4];
  }

  /// Get the signal at the specified index, normalized by cell volume
  signal_t getSignalNormalizedAt(size_t index) const override {
    return m_signals[index] * m_inverseVolume;
  }

  /// Get the signal at the specified index given in 4 dimensions (typically
  /// X,Y,Z,t), normalized by cell volume
  signal_t getSignalNormalizedAt(size_t index1, size_t index2) const override {
    return m_signals[index1 + indexMultiplier[0] * index2] * m_inverseVolume;
  }

  /// Get the signal at the specified index given in 4 dimensions (typically
  /// X,Y,Z,t), normalized by cell volume
  signal_t getSignalNormalizedAt(size_t index1, size_t index2,
                                 size_t index3) const override {
    return m_signals[index1 + indexMultiplier[0] * index2 +
                     indexMultiplier[1] * index3] *
           m_inverseVolume;
  }

  /// Get the signal at the specified index given in 4 dimensions (typically
  /// X,Y,Z,t), normalized by cell volume
  signal_t getSignalNormalizedAt(size_t index1, size_t index2, size_t index3,
                                 size_t index4) const override {
    return m_signals[index1 + indexMultiplier[0] * index2 +
                     indexMultiplier[1] * index3 +
                     indexMultiplier[2] * index4] *
           m_inverseVolume;
  }

  /// Get the error of the signal at the specified index, normalized by cell
  /// volume
  signal_t getErrorNormalizedAt(size_t index) const override {
    return std::sqrt(m_errorsSquared[index]) * m_inverseVolume;
  }

  /// Get the signal at the specified index given in 4 dimensions (typically
  /// X,Y,Z,t), normalized by cell volume
  signal_t getErrorNormalizedAt(size_t index1, size_t index2) const override {
    return getErrorAt(index1, index2) * m_inverseVolume;
  }

  /// Get the signal at the specified index given in 4 dimensions (typically
  /// X,Y,Z,t), normalized by cell volume
  signal_t getErrorNormalizedAt(size_t index1, size_t index2,
                                size_t index3) const override {
    return getErrorAt(index1, index2, index3) * m_inverseVolume;
  }

  /// Get the signal at the specified index given in 4 dimensions (typically
  /// X,Y,Z,t), normalized by cell volume
  signal_t getErrorNormalizedAt(size_t index1, size_t index2, size_t index3,
                                size_t index4) const override {
    return getErrorAt(index1, index2, index3, index4) * m_inverseVolume;
  }

  //---------------------------------------------------------------------------------------------
  /** @return a reference to the error (squared) at the linear index
   * @param index :: linear index (see getLinearIndex).  */
  signal_t &errorSquaredAt(size_t index) override {
    if (index < m_length)
      return m_errorsSquared[index];
    else
      throw std::invalid_argument("MDHistoWorkspace::array index out of range");
  }

  /** @return a reference to the signal at the linear index
   * @param index :: linear index (see getLinearIndex).  */
  signal_t &signalAt(size_t index) override {
    if (index < m_length)
      return m_signals[index];
    else
      throw std::invalid_argument("MDHistoWorkspace::array index out of range");
  }

  //---------------------------------------------------------------------------------------------
  size_t getLinearIndex(size_t index1, size_t index2) const override {
    if (this->getNumDims() != 2)
      throw std::runtime_error("Workspace does not have 2 dimensions!");
    return index1 + indexMultiplier[0] * index2;
  }

  size_t getLinearIndex(size_t index1, size_t index2,
                        size_t index3) const override {
    if (this->getNumDims() != 3)
      throw std::runtime_error("Workspace does not have 3 dimensions!");
    return index1 + indexMultiplier[0] * index2 + indexMultiplier[1] * index3;
  }

  size_t getLinearIndex(size_t index1, size_t index2, size_t index3,
                        size_t index4) const override {
    if (this->getNumDims() != 4)
      throw std::runtime_error("Workspace does not have 4 dimensions!");
    return index1 + indexMultiplier[0] * index2 + indexMultiplier[1] * index3 +
           indexMultiplier[2] * index4;
  }

  /** Get the linear index into the array
   * @param index :: array of indexes, length = number of dimensions
   * @return linear index into m_signals
   */
  size_t getLinearIndex(size_t *index) const {
    size_t nd = this->getNumDims();
    size_t out = index[0];
    for (size_t d = 1; d < nd; d++)
      out += indexMultiplier[d - 1] * index[d];
    return out;
  }

  size_t getLinearIndexAtCoord(const coord_t *coords) const;

  /** Array subscript operator
   * @param index :: linear index into array
   * @return the signal (not normalized) at that index.
   */
  signal_t &operator[](const size_t &index)override {
    if (index < m_length)
      return m_signals[index];
    else
      throw std::invalid_argument("MDHistoWorkspace::array index out of range");
  }

  /// Return a vector containing a copy of the signal data in the workspace.
  /// TODO: Make this more efficient if needed.
  virtual std::vector<signal_t> getSignalDataVector() const;
  virtual std::vector<signal_t> getErrorDataVector() const;

  /// Apply masking.
  void
  setMDMasking(Mantid::Geometry::MDImplicitFunction *maskingRegion) override;
  /// Apply masking.
  void setMDMaskAt(const size_t &index, bool mask);

  /// Clear masking.
  void clearMDMasking() override;
  /// sum the array of contributing events m_numEvents array
  uint64_t sumNContribEvents() const;
  void updateSum() { m_nEventsContributed = sumNContribEvents(); }

  /// Get the size of an element in the HistoWorkspace.
  static size_t sizeOfElement();

  /// Preferred visual normalization method.
  Mantid::API::MDNormalization displayNormalization() const override;

  /// Preferred visual normalization method.
  Mantid::API::MDNormalization displayNormalizationHisto() const override;

  void setDisplayNormalization(
      const Mantid::API::MDNormalization &preferredNormalization) override;

  /// Return if this workspace is a MDHistoWorkspace. Will always return true.
  bool isMDHistoWorkspace() const override { return true; }

private:
  MDHistoWorkspace *doClone() const override {
    return new MDHistoWorkspace(*this);
  }

  MDHistoWorkspace *doCloneEmpty() const override {
    return new MDHistoWorkspace(nullptr);
  }

  void makeSingleBinWithNaN(std::vector<coord_t> &x, std::vector<signal_t> &y,
                            std::vector<signal_t> &e) const;

  void initVertexesArray();

  /// Number of dimensions in this workspace
  size_t numDimensions;

  /// Linear array of signals for each bin
  signal_t *m_signals;

  /// Linear array of errors for each bin
  signal_t *m_errorsSquared;

  /// Number of contributing events for each bin.
  signal_t *m_numEvents;

  /// Length of the m_signals / m_errorsSquared arrays.
  size_t m_length;

  /// To find the index into the linear array, dim0 + indexMultiplier[0]*dim1 +
  /// ...
  size_t *indexMultiplier;
  /// For converting to/from linear index to tdimensions
  size_t *m_indexMaker;
  /// Max index into each dimension
  size_t *m_indexMax;

  /// Inverse of the volume of EACH cell
  coord_t m_inverseVolume;

  /// Pre-calculated vertexes array for the 0th box
  coord_t *m_vertexesArray;

  /// Vector of the length of the box in each dimension
  coord_t *m_boxLength;

  /// Vector of the origin in each dimension
  coord_t *m_origin;
  /// the number of events, contributed into the workspace;
  mutable uint64_t m_nEventsContributed;

  Kernel::SpecialCoordinateSystem m_coordSystem;

  /// Display normalization to use
  Mantid::API::MDNormalization m_displayNormalization;

  // Get ordered list of boundaries in position-along-the-line coordinates
  std::set<coord_t> getBinBoundariesOnLine(const Kernel::VMD &start,
                                           const Kernel::VMD &end, size_t nd,
                                           const Kernel::VMD &dir,
                                           coord_t length) const;

  signal_t getNormalizationFactor(const API::MDNormalization &normalize,
                                  size_t linearIndex) const;

protected:
  LinePlot getLinePoints(const Mantid::Kernel::VMD &start,
                         const Mantid::Kernel::VMD &end,
                         Mantid::API::MDNormalization normalize,
                         const bool bin_centres) const;

  /// Protected copy constructor. May be used by childs for cloning.
  MDHistoWorkspace(const MDHistoWorkspace &other);

  /// Linear array of masks for each bin
  bool *m_masks;
};

/// A shared pointer to a MDHistoWorkspace
using MDHistoWorkspace_sptr = boost::shared_ptr<MDHistoWorkspace>;

/// A shared pointer to a const MDHistoWorkspace
using MDHistoWorkspace_const_sptr = boost::shared_ptr<const MDHistoWorkspace>;

} // namespace Mantid
} // namespace DataObjects

#endif /* MANTID_DATAOBJECTS_MDHISTOWORKSPACE_H_ */