WorkspaceBoundingBox.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2021 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 "MantidAPI/SpectrumInfo.h"
#include "MantidHistogramData/Histogram.h"
#include "MantidKernel/Logger.h"
#include "MantidKernel/V3D.h"
 
namespace Mantid {
namespace Algorithms {
namespace {
// static logger
Kernel::Logger g_log("WorkspaceBoundingBox");
} // namespace
 
/* This is a simple class originally intended for use solely with FindCenterOfMassPosition2.cpp
 *
 */
class WorkspaceBoundingBox {
public:
  WorkspaceBoundingBox(const API::MatrixWorkspace_const_sptr &workspace, const double integrationRadius,
                       const double beamRadius, const bool ignoreDirectBeam, const double cenX, const double cenY);
  ~WorkspaceBoundingBox();
 
  double getCenterX() const { return m_centerXPosPrev; }
  double getCenterY() const { return m_centerYPosPrev; }
 
  bool centerOfMassWithinBeamCenter();
  void prepareCenterCalculation();
 
  double distanceFromPrevious() const;
 
  void findNewCenterPosition();
 
private:
  void initOverallRangeAndFindFirstCenter();
  Kernel::V3D position(const std::size_t index) const;
  void resetIntermediatePosition();
  double countsValue(const std::size_t index) const;
  bool isValidIndex(const std::size_t index) const;
  void updateMinMax(const std::size_t index);
  bool includeInIntegration(const std::size_t index);
  bool includeInIntegration(const Kernel::V3D &position);
  bool symmetricRegionContainsPoint(double x, double y);
  void setCenterPrev(const double x, const double y);
  void setBounds(const double xMin, const double xMax, const double yMin, const double yMax);
  void normalizePosition(const double totalCounts);
  double updatePositionAndReturnCount(const std::size_t index);
  double calculateRadiusX() const;
  double calculateRadiusY() const;
  API::MatrixWorkspace_const_sptr m_workspace;
  const API::SpectrumInfo *m_spectrumInfo;
  std::size_t m_numSpectra;
  double m_integrationRadiusSq;
  double m_beamRadiusSq;
  bool m_ignoreDirectBeam;
  double m_centerXPosCurr{0};
  double m_centerYPosCurr{0};
  double m_centerXPosPrev{0};
  double m_centerYPosPrev{0};
  // overall range to consider
  double m_xPosMin{0};
  double m_xPosMax{0};
  double m_yPosMin{0};
  double m_yPosMax{0};
  // range for current search
  double m_xBoxMin{0};
  double m_xBoxMax{0};
  double m_yBoxMin{0};
  double m_yBoxMax{0};
};
 
} // namespace Algorithms
} // namespace Mantid