LoadMask.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2011 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_fwd.h"
#include "MantidDataHandling/DllConfig.h"
#include "MantidDataObjects/MaskWorkspace.h"
#include "MantidGeometry/IDTypes.h"
 
#include <Poco/AutoPtr.h>
#include <Poco/DOM/Document.h>
 
namespace Poco {
namespace XML {
class Document;
class Element;
} // namespace XML
} // namespace Poco
 
namespace Mantid {
namespace DataHandling {
 
class MANTID_DATAHANDLING_DLL LoadMask : public API::Algorithm {
public:
  const std::string name() const override { return "LoadMask"; };
  const std::string summary() const override {
    return "Load file containing masking information to a SpecialWorkspace2D "
           "(masking workspace).";
  }
 
  int version() const override { return 1; };
  const std::vector<std::string> seeAlso() const override { return {"ExportSpectraMask", "LoadMask"}; }
  const std::string category() const override { return "DataHandling\\Masking;Transforms\\Masking"; }
 
private:
  void init() override;
  void exec() override;
  std::vector<std::string> validExtensions() const { return {"xml", "msk"}; }
  std::map<std::string, std::string> validateInputs() override;
  void initializeXMLParser(const std::string &filename);
  void parseXML();
  void intializeMaskWorkspace();
  void componentToDetectors(const std::vector<std::string> &componentnames, std::vector<detid_t> &detectors);
  void bankToDetectors(const std::vector<std::string> &singlebanks, std::vector<detid_t> &detectors);
 
  void processMaskOnDetectors(const detid2index_map &indexmap, bool tomask, const std::vector<detid_t> &singledetids);
  void processMaskOnWorkspaceIndex(bool mask, std::vector<specnum_t> &maskedSpecID, std::vector<detid_t> &singleDetIds);
 
  void initDetectors();
 
  void convertSpMasksToDetIDs(const API::MatrixWorkspace &sourceWS, const std::vector<specnum_t> &maskedSpecID,
                              std::vector<detid_t> &singleDetIds);
 
  void reset();
 
  DataObjects::MaskWorkspace_sptr m_maskWS;
  std::string m_instrumentPropValue;
  API::MatrixWorkspace_sptr m_sourceMapWS;
  Poco::AutoPtr<Poco::XML::Document> m_pDoc;
  Poco::XML::Element *m_pRootElem{nullptr};
 
  bool m_defaultToUse{true};
 
  // detector id-s to mask
  std::vector<detid_t> m_maskDetID;
  // spectrum id-s to unmask
  std::vector<detid_t> m_unMaskDetID;
 
  // spectra mask provided
  std::vector<specnum_t> m_maskSpecID;
  // spectra unmask provided NOT IMPLEMENTED
  // std::vector<specnum_t> m_unMaskSpecID;
 
  std::vector<std::string> m_maskCompIdSingle;
  std::vector<std::string> m_uMaskCompIdSingle;
};
 
} // namespace DataHandling
} // namespace Mantid