LoadParameterFile.cpp

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 +
#include "MantidDataHandling/LoadParameterFile.h"
#include "MantidAPI/FileProperty.h"
#include "MantidAPI/MatrixWorkspace.h"
#include "MantidAPI/Progress.h"
#include "MantidGeometry/Instrument.h"
#include "MantidGeometry/Instrument/Component.h"
#include "MantidGeometry/Instrument/ComponentInfo.h"
#include "MantidGeometry/Instrument/InstrumentDefinitionParser.h"
#include "MantidKernel/ConfigService.h"
 
#include <Poco/DOM/AutoPtr.h>
#include <Poco/DOM/DOMParser.h>
#include <Poco/DOM/Document.h>
#include <Poco/DOM/Element.h>
#include <Poco/DOM/NodeFilter.h>
#include <Poco/DOM/NodeIterator.h>
#include <Poco/DOM/NodeList.h>
#include <chrono>
#include <filesystem>
 
using Mantid::Geometry::InstrumentDefinitionParser;
using Poco::XML::AutoPtr;
using Poco::XML::Document;
using Poco::XML::DOMParser;
using Poco::XML::Element;
 
namespace Mantid::DataHandling {
 
DECLARE_ALGORITHM(LoadParameterFile)
 
using namespace Kernel;
using namespace API;
using Geometry::Instrument;
using Geometry::InstrumentParameterCache;
 
void LoadParameterFile::init() {
  // When used as a Child Algorithm the workspace name is not used - hence the
  // "Anonymous" to satisfy the validator
  declareProperty(std::make_unique<WorkspaceProperty<MatrixWorkspace>>("Workspace", "Anonymous", Direction::InOut),
                  "The name of the workspace to load the instrument parameters into.");
  declareProperty(std::make_unique<FileProperty>("Filename", "", FileProperty::OptionalLoad, ".xml"),
                  "The filename (including its full or relative path) of a parameter "
                  "definition file. The file extension must either be .xml or .XML.");
  declareProperty("ParameterXML", "", "The parameter definition XML as a string.");
}
 
void LoadParameterFile::exec() {
  // Retrieve the filename from the properties
  std::string filename = getPropertyValue("Filename");
 
  // Retrieve the parameter XML string from the properties
  const Property *const parameterXMLProperty = getProperty("ParameterXML"); // to check whether it is default
  const std::string parameterXML = getPropertyValue("ParameterXML");
 
  // Check the two properties (at least one must be set)
  if (filename.empty() && parameterXMLProperty->isDefault()) {
    throw Kernel::Exception::FileError("Either the Filename or ParameterXML "
                                       "property of LoadParameterFile most be "
                                       "specified to load an IDF",
                                       filename);
  }
 
  // Get the input workspace
  const MatrixWorkspace_sptr localWorkspace = getProperty("Workspace");
 
  const auto instrument = localWorkspace->getInstrument()->baseInstrument();
 
  // Set up the DOM parser and parse xml file
  DOMParser pParser;
  AutoPtr<Document> pDoc;
 
  // Progress reporting object
  Progress prog(this, 0.0, 1.0, 100);
 
  prog.report("Parsing XML");
 
  const auto parseStartTime = std::chrono::high_resolution_clock::now();
  // If we've been given an XML string parse that instead
  if (!parameterXMLProperty->isDefault()) {
    try {
      g_log.information("Parsing from ParameterXML property.");
      pDoc = pParser.parseString(parameterXML);
    } catch (Poco::Exception &exc) {
      throw Kernel::Exception::FileError(exc.displayText() + ". Unable to parse parameter XML string", "ParameterXML");
    } catch (...) {
      throw Kernel::Exception::FileError("Unable to parse parameter XML string", "ParameterXML");
    }
  } else {
    try {
      // First see if the file exists
      std::filesystem::path ipfFile(filename);
      if (!std::filesystem::exists(ipfFile)) {
        std::filesystem::path filePath(filename);
        filename =
            (std::filesystem::path(Kernel::ConfigService::Instance().getInstrumentDirectory()) / filePath.filename())
                .string();
      }
      g_log.information() << "Parsing from XML file: " << filename << '\n';
      pDoc = pParser.parse(filename);
    } catch (Poco::Exception &exc) {
      throw Kernel::Exception::FileError(exc.displayText() + ". Unable to parse File:", filename);
    } catch (...) {
      throw Kernel::Exception::FileError("Unable to parse File:", std::move(filename));
    }
  }
  addTimer("xmlParsing", parseStartTime, std::chrono::high_resolution_clock::now());
 
  // Get pointer to root element
  Element *pRootElem = pDoc->documentElement();
  if (!pRootElem->hasChildNodes()) {
    throw Kernel::Exception::InstrumentDefinitionError("No root element in XML Parameter file", filename);
  }
 
  // Set all parameters that specified in all component-link elements of pRootElem
  const auto linkStartTime = std::chrono::high_resolution_clock::now();
  InstrumentDefinitionParser loadInstr;
  InstrumentParameterCache logfileCache;
  loadInstr.setComponentLinks(instrument, pRootElem, logfileCache, &prog, localWorkspace->getWorkspaceStartDate());
  // The parameters belong to this workspace only, not to the instrument it shares with others
  auto &componentInfo = localWorkspace->mutableComponentInfo();
  for (const auto &[key, parameter] : logfileCache) {
    const auto index = componentInfo.indexOfOrInvalid(key.second);
    if (index != Geometry::ComponentInfo::invalidIndex) {
      componentInfo.addLogfileParameter(index, key.first, parameter);
    }
  }
  addTimer("setComponentLinks", linkStartTime, std::chrono::high_resolution_clock::now());
 
  // populate parameter map of workspace
  const auto populateStartTime = std::chrono::high_resolution_clock::now();
  localWorkspace->populateInstrumentParameters();
  addTimer("populateInstrumentParameters", populateStartTime, std::chrono::high_resolution_clock::now());
 
  if (!filename.empty()) {
    localWorkspace->instrumentParameters().addParameterFilename(filename);
  }
 
  prog.resetNumSteps(1, 0.0, 1.0);
  prog.report("Done");
}
 
} // namespace Mantid::DataHandling