PolarizationCorrectionWildes.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 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 "MantidAPI/MatrixWorkspace.h"
#include "MantidAPI/WorkspaceGroup_fwd.h"
#include "MantidAlgorithms/DllConfig.h"
 
namespace Mantid {
namespace API {
class ISpectrum;
}
 
namespace Algorithms {
 
class MANTID_ALGORITHMS_DLL PolarizationCorrectionWildes final : public API::Algorithm {
public:
  const std::string name() const override;
  int version() const override;
  const std::string category() const override;
  const std::string summary() const override;
  const std::vector<std::string> seeAlso() const override;
 
private:
  struct WorkspaceMap {
    API::MatrixWorkspace_sptr mmWS{nullptr};
    API::MatrixWorkspace_sptr mpWS{nullptr};
    API::MatrixWorkspace_sptr pmWS{nullptr};
    API::MatrixWorkspace_sptr ppWS{nullptr};
    size_t size() const noexcept;
  };
 
  struct EfficiencyMap {
    const API::ISpectrum *P1{nullptr};
    const API::ISpectrum *P2{nullptr};
    const API::ISpectrum *F1{nullptr};
    const API::ISpectrum *F2{nullptr};
  };
 
  void init() override;
  void exec() override;
  std::map<std::string, std::string> validateInputs() override;
  void checkConsistentNumberHistograms(const WorkspaceMap &inputs);
  void checkConsistentX(const WorkspaceMap &inputs, const EfficiencyMap &efficiencies);
  EfficiencyMap efficiencyFactors();
  WorkspaceMap directBeamCorrections(const WorkspaceMap &inputs, const EfficiencyMap &efficiencies);
  WorkspaceMap analyzerlessCorrections(const WorkspaceMap &inputs, const EfficiencyMap &efficiencies);
  WorkspaceMap twoInputCorrections(const WorkspaceMap &inputs, const EfficiencyMap &efficiencies);
  WorkspaceMap threeInputCorrections(const WorkspaceMap &inputs, const EfficiencyMap &efficiencies);
  WorkspaceMap fullCorrections(const WorkspaceMap &inputs, const EfficiencyMap &efficiencies);
  API::WorkspaceGroup_sptr groupOutput(const WorkspaceMap &outputs, const bool hasAnalyser);
  WorkspaceMap mapInputsToDirections(const std::vector<std::string> &flippers);
  void threeInputsSolve01(WorkspaceMap &inputs, const EfficiencyMap &efficiencies);
  void threeInputsSolve10(WorkspaceMap &inputs, const EfficiencyMap &efficiencies);
  void twoInputsSolve01And10(WorkspaceMap &fullInputs, const WorkspaceMap &inputs, const EfficiencyMap &efficiencies);
  void addSpinStateOutput(std::vector<std::string> &names, const std::string &spinStateOrder,
                          const std::string &baseName, const API::MatrixWorkspace_sptr &ws,
                          const std::string &spinState, const bool addSpinStateLog, const bool hasAnalyser);
  void addSpinStateLogToWs(const API::MatrixWorkspace_sptr &ws, const std::string &spinState, const bool hasAnalyser);
};
} // namespace Algorithms
} // namespace Mantid