DiffractionFocussing2.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2009 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/Algorithm.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidDataObjects/EventWorkspace.h"
#include "MantidDataObjects/GroupingWorkspace.h"
#include "MantidIndexing/SpectrumNumber.h"
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL DiffractionFocussing2 final : public API::Algorithm {
public:
  const std::string name() const override { return "DiffractionFocussing"; }
  const std::string summary() const override {
    return "Algorithm to focus powder diffraction data into a number of "
           "histograms according to a grouping scheme defined in a CalFile.";
  }
 
  int version() const override { return 2; }
  const std::vector<std::string> seeAlso() const override { return {"AlignAndFocusPowder", "LoadCalFile"}; }
  const std::string category() const override { return "Diffraction\\Focussing"; }
 
private:
  // Overridden Algorithm methods
  void init() override;
  std::map<std::string, std::string> validateInputs() override;
  void exec() override;
  void cleanup();
 
  void getGroupingWorkspace();
  std::size_t setupGroupToWSIndices();
 
  // For events
  void execEvent();
 
  void determineRebinParameters(const std::vector<int> &udet2group);
  void determineRebinParametersFromParameters(const std::vector<int> &udet2group);
  int validateSpectrumInGroup(const std::vector<int> &udet2group, size_t wi);
  void validateInputWorkspaceUnit(API::MatrixWorkspace_const_sptr inputWS, std::map<std::string, std::string> &issues);
 
  API::MatrixWorkspace_const_sptr m_matrixInputW;
 
  Mantid::DataObjects::GroupingWorkspace_sptr m_groupWS;
 
  // This map needs to be ordered to process the groups in order.
  using group2vectormap = std::map<int, std::shared_ptr<MantidVec>>;
  std::vector<int> groupAtWorkspaceIndex;
  std::map<int, HistogramData::BinEdges> group2xvector;
  std::map<int, double> group2xstep;
  group2vectormap group2wgtvector;
  int64_t nGroups = 0;
  int nHist = 0;
  int nPoints = 0;
  std::vector<std::vector<std::size_t>> m_wsIndices;
  std::vector<Indexing::SpectrumNumber> m_validGroups;
};
 
} // namespace Algorithms
} // namespace Mantid