PolarizationEfficienciesWildes.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2024 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.h"
#include "MantidAlgorithms/DllConfig.h"
#include <unordered_map>
 
namespace Mantid::Algorithms {
 
using namespace API;
 
class MANTID_ALGORITHMS_DLL PolarizationEfficienciesWildes : public API::Algorithm {
public:
  std::string const name() const override { return "PolarizationEfficienciesWildes"; }
 
  std::string const summary() const override;
 
  std::string const category() const override { return "Reflectometry\\PolarizationCorrections"; }
 
  const std::vector<std::string> seeAlso() const override { return {"PolarizationCorrectionWildes"}; }
 
  int version() const override { return 1; }
 
private:
  void init() override;
 
  void exec() override;
 
  std::map<std::string, std::string> validateInputs() override;
 
  void calculateFlipperEfficienciesAndPhi();
 
  MatrixWorkspace_sptr calculateTPMO();
 
  void calculatePolarizerAndAnalyserEfficiencies(const bool solveForP, const bool solveForA);
 
  void setOutputs();
 
  void resetMemberVariables();
 
  void resetPropertyValue(const std::string &propertyName);
 
  void populateSpinStateWorkspaces(const WorkspaceGroup_sptr &wsGrp, const std::string &keyPrefix = "");
 
  void mapSpinStateWorkspaces();
 
  // Convenience struct for handling of flipper workspaces
  struct FlipperWorkspaces {
    const MatrixWorkspace_sptr &ws00;
    const MatrixWorkspace_sptr &ws01;
    const MatrixWorkspace_sptr &ws10;
    const MatrixWorkspace_sptr &ws11;
  };
 
  FlipperWorkspaces getFlipperWorkspaces(const bool mag = false);
 
  MatrixWorkspace_sptr m_wsFp = nullptr;
  MatrixWorkspace_sptr m_wsFa = nullptr;
  MatrixWorkspace_sptr m_wsPhi = nullptr;
  MatrixWorkspace_sptr m_wsP = nullptr;
  MatrixWorkspace_sptr m_wsA = nullptr;
  std::unordered_map<std::string, MatrixWorkspace_sptr> m_spinStateWorkspaces;
  bool m_magWsProvided = false;
};
} // namespace Mantid::Algorithms