PolarizationCorrectionWildes.h

// 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/WorkspaceGroup_fwd.h"
#include "MantidAlgorithms/DllConfig.h"

namespace Mantid {
namespace API {
class ISpectrum;
}

namespace Algorithms {

/** PolarizationCorrectionWildes : This algorithm corrects for non-ideal
  component efficiencies in polarized neutron analysis. It is based on
  [A. R. Wildes (2006) Neutron News, 17:2, 17-25,
  DOI: 10.1080/10448630600668738]
*/
class MANTID_ALGORITHMS_DLL PolarizationCorrectionWildes
    : 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;

private:
  /// A convenience set of workspaces corresponding flipper configurations.
  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;
  };

  /// A convenience set of efficiency factors.
  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);
  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);
};
} // namespace Algorithms
} // namespace Mantid