PolSANSWorkspaceValidator.cpp

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2025 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 +
 
#include "MantidAPI/PolSANSWorkspaceValidator.h"
#include "MantidAPI/Axis.h"
#include "MantidAPI/Run.h"
#include "MantidKernel/Strings.h"
#include "MantidKernel/Unit.h"
 
namespace Mantid {
namespace API {
 
PolSANSWorkspaceValidator::PolSANSWorkspaceValidator(bool expectHistogramData, bool allowMultiPeriodData,
                                                     const std::unordered_set<int> &allowedNumberOfPeriods)
    : m_expectHistogramData(expectHistogramData), m_allowMultiPeriodData(allowMultiPeriodData),
      m_allowedNumberOfPeriods(allowedNumberOfPeriods) {};
 
Kernel::IValidator_sptr PolSANSWorkspaceValidator::clone() const {
  return std::make_shared<PolSANSWorkspaceValidator>(*this);
}
 
std::string PolSANSWorkspaceValidator::validateGroupItem(API::MatrixWorkspace_sptr const &workspace) const {
  std::vector<std::string> workspaceIssues;
  if (!workspace) {
    return "All workspaces must be of type MatrixWorkspace.";
  }
 
  Kernel::Unit_const_sptr unit = workspace->getAxis(0)->unit();
  if (unit->unitID() != "Wavelength") {
    workspaceIssues.push_back("All workspaces must be in units of Wavelength.");
  }
 
  if (!m_allowMultiPeriodData && workspace->getNumberHistograms() != 1) {
    workspaceIssues.push_back("All workspaces must contain a single histogram.");
  }
 
  if (workspace->isHistogramData() != m_expectHistogramData) {
    if (m_expectHistogramData) {
      workspaceIssues.push_back("All workspaces must be histogram data.");
    } else {
      workspaceIssues.push_back("All workspaces must not be histogram data.");
    }
  }
 
  if (!workspaceIssues.empty()) {
    return Kernel::Strings::join(workspaceIssues.cbegin(), workspaceIssues.cend(), " ");
  }
 
  return "";
}
 
std::string PolSANSWorkspaceValidator::checkValidity(const WorkspaceGroup_sptr &workspace) const {
 
  const int numberOfEntries = workspace->getNumberOfEntries();
  if (m_allowedNumberOfPeriods.find(numberOfEntries) == m_allowedNumberOfPeriods.cend()) {
    return "The number of periods within the input workspace is not an allowed value.";
  }
 
  for (const API::Workspace_sptr &ws : workspace->getAllItems()) {
    const auto groupItem = std::dynamic_pointer_cast<API::MatrixWorkspace>(ws);
    const std::string errors = validateGroupItem(groupItem);
    if (errors != "") {
      return errors;
    }
  }
 
  return "";
}
 
} // namespace API
} // namespace Mantid