NormaliseToMonitor.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2008 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 "MantidKernel/IPropertyManager.h"
#include "MantidKernel/IPropertySettings.h"
#include "MantidKernel/cow_ptr.h"
 
namespace Mantid {
namespace HistogramData {
class BinEdges;
class CountStandardDeviations;
class Counts;
} // namespace HistogramData
} // namespace Mantid
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL NormaliseToMonitor final : public API::Algorithm {
public:
  const std::string name() const override { return "NormaliseToMonitor"; }
  const std::string summary() const override {
    return "Normalizes a 2D workspace by a specified spectrum, spectrum, "
           "described by a monitor ID or spectrun provided in a separate "
           "worskspace. ";
  }
 
  int version() const override { return 1; }
  const std::vector<std::string> seeAlso() const override { return {"Divide"}; }
  const std::string category() const override { return "CorrectionFunctions\\NormalisationCorrections"; }
 
private:
  // Overridden Algorithm methods
  void init() override;
  void exec() override;
  std::map<std::string, std::string> validateInputs() override;
 
protected: // for testing
  void checkProperties(const API::MatrixWorkspace_sptr &inputWorkspace);
  API::MatrixWorkspace_sptr getInWSMonitorSpectrum(const API::MatrixWorkspace_sptr &inputWorkspace);
  size_t getInWSMonitorIndex(const API::MatrixWorkspace_sptr &inputWorkspace);
  API::MatrixWorkspace_sptr getMonitorWorkspace(const API::MatrixWorkspace_sptr &inputWorkspace);
  API::MatrixWorkspace_sptr extractMonitorSpectra(const API::MatrixWorkspace_sptr &ws,
                                                  const std::vector<size_t> &workspaceIndexes);
  bool setIntegrationProps(const bool isSingleCountWorkspace);
 
  void normaliseByIntegratedCount(const API::MatrixWorkspace_sptr &inputWorkspace,
                                  API::MatrixWorkspace_sptr &outputWorkspace, const bool isSingleCountWorkspace);
 
  void performHistogramDivision(const API::MatrixWorkspace_sptr &inputWorkspace,
                                API::MatrixWorkspace_sptr &outputWorkspace);
 
  void normaliseBinByBin(const API::MatrixWorkspace_sptr &inputWorkspace, API::MatrixWorkspace_sptr &outputWorkspace);
  void normalisationFactor(const HistogramData::BinEdges &X, HistogramData::Counts &Y,
                           HistogramData::CountStandardDeviations &E);
 
private:
  API::MatrixWorkspace_sptr m_monitor;
  bool m_commonBins = false;
  double m_integrationMin = EMPTY_DBL();
  double m_integrationMax = EMPTY_DBL();
  bool m_scanInput;
  std::vector<size_t> m_workspaceIndexes;
};
 
// the internal class to verify and modify interconnected properties affecting
// the different ways to normalize ws by this ws spectrum.
class MANTID_ALGORITHMS_DLL MonIDPropChanger : public Kernel::IPropertySettings {
 
public:
  //   properties this property depends on:
  //   "InputWorkspace","MonitorSpectrum","MonitorWorkspace"
  MonIDPropChanger(const std::string &WSProperty, const std::string &SpectrToNormByProperty,
                   const std::string &MonitorWorkspace)
      : hostWSname(WSProperty), SpectraNum(SpectrToNormByProperty), MonitorWorkspaceProp(MonitorWorkspace),
        is_enabled(true) {}
  // if input to this property is enabled
  bool isEnabled(const Mantid::Kernel::IPropertyManager *algo) const override;
  bool isConditionChanged(const Mantid::Kernel::IPropertyManager *algo,
                          const std::string &changedPropName = "") const override;
  void applyChanges(const Mantid::Kernel::IPropertyManager *algo, Kernel::Property *const pProp) override;
 
  // interface needs it but if indeed proper clone used -- do not know.
  IPropertySettings *clone() const override {
    return new MonIDPropChanger(hostWSname, SpectraNum, MonitorWorkspaceProp);
  }
 
private:
  // the name of the property, which specifies the workspace which has to be
  // modified
  std::string hostWSname;
  // the name of the property, which specifies the spectra num (from WS) to
  // normalize by
  std::string SpectraNum;
  // the name of the property, which specifies if you want to allow normalizing
  // by any spectra.
  std::string MonitorWorkspaceProp;
 
  // the string with existing allowed monitors indexes
  mutable std::vector<int> iExistingAllowedValues;
  // if the monitors id input string is enabled.
  mutable bool is_enabled;
  // auxiliary function to obtain list of monitor's ID-s (allowed_values) from a
  // workspace;
  bool monitorIdReader(const API::MatrixWorkspace_const_sptr &inputWS) const;
};
 
} // namespace Algorithms
} // namespace Mantid