LoadEmptyInstrument.cpp

#include "MantidAPI/FileProperty.h"
#include "MantidAPI/RegisterFileLoader.h"
#include "MantidAPI/WorkspaceFactory.h"
#include "MantidDataHandling/LoadEmptyInstrument.h"
#include "MantidDataObjects/EventWorkspace.h"
#include "MantidDataObjects/Workspace2D.h"
#include "MantidGeometry/Instrument.h"
#include "MantidKernel/ConfigService.h"
#include "MantidKernel/BoundedValidator.h"

namespace Mantid {
namespace DataHandling {
// Register the algorithm into the algorithm factory as a file loading algorithm
DECLARE_FILELOADER_ALGORITHM(LoadEmptyInstrument)

using namespace Kernel;
using namespace API;
using namespace Geometry;
using namespace DataObjects;
using HistogramData::Counts;
using HistogramData::CountStandardDeviations;

/// Empty default constructor
LoadEmptyInstrument::LoadEmptyInstrument() {}

/**
* Return the confidence with with this algorithm can load the file
* @param descriptor A descriptor for the file
* @returns An integer specifying the confidence level. 0 indicates it will not
* be used
*/
int LoadEmptyInstrument::confidence(Kernel::FileDescriptor &descriptor) const {
  const std::string &filePath = descriptor.filename();

  int confidence(0);
  if (descriptor.isAscii()) // Only consider an Ascii file
  {
    // Filename must contain "Definition"
    std::string::size_type stripPath = filePath.find_last_of("\\/");
    if (stripPath == std::string::npos)
      stripPath = 0;
    if (filePath.find("Definition", stripPath) != std::string::npos) {
      // We have some confidence and it depends on the filetype.
      if (descriptor.extension() == "xml") {
        confidence = 80;
      } else {
        confidence = 20;
      }
    } // Has "Definition"
  }   // Ascii file
  return confidence;
}

/// Initialisation method.
void LoadEmptyInstrument::init() {
  declareProperty(
      make_unique<FileProperty>("Filename", "", FileProperty::Load, ".xml"),
      "The filename (including its full or relative path) of an instrument\n"
      "definition file");
  declareProperty(
      make_unique<WorkspaceProperty<MatrixWorkspace>>("OutputWorkspace", "",
                                                      Direction::Output),
      "The name of the workspace in which to store the imported instrument");

  auto mustBePositive = boost::make_shared<BoundedValidator<double>>();
  mustBePositive->setLower(0.0);
  declareProperty(
      "DetectorValue", 1.0, mustBePositive,
      "This value affects the colour of the detectors in the instrument\n"
      "display window (default 1)");
  declareProperty(
      "MonitorValue", 2.0, mustBePositive,
      "This value affects the colour of the monitors in the instrument\n"
      "display window (default 2)");

  declareProperty(
      make_unique<PropertyWithValue<bool>>("MakeEventWorkspace", false),
      "Set to True to create an EventWorkspace (with no events) "
      "instead of a Workspace2D.");
}

/** Executes the algorithm. Reading in the file and creating and populating
 *  the output workspace
 *
 *  @throw std::runtime_error If the instrument cannot be loaded by the
 *LoadInstrument ChildAlgorithm
 *  @throw InstrumentDefinitionError Thrown if issues with the content of XML
 *instrument file not covered by LoadInstrument
 *  @throw std::invalid_argument If the optional properties are set to invalid
 *values
 */
void LoadEmptyInstrument::exec() {
  // Get other properties
  const double detector_value = getProperty("DetectorValue");
  const double monitor_value = getProperty("MonitorValue");

  // load the instrument into this workspace
  MatrixWorkspace_sptr ws = this->runLoadInstrument();
  Instrument_const_sptr instrument = ws->getInstrument();

  // Get number of detectors stored in instrument
  const size_t number_spectra = instrument->getNumberDetectors();

  // Check that we have some spectra for the workspace
  if (number_spectra == 0) {
    g_log.error(
        "Instrument has no detectors, unable to create workspace for it");
    throw Kernel::Exception::InstrumentDefinitionError(
        "No detectors found in instrument");
  }

  bool MakeEventWorkspace = getProperty("MakeEventWorkspace");

  MatrixWorkspace_sptr outWS;

  if (MakeEventWorkspace) {
    // Make a brand new EventWorkspace
    outWS = WorkspaceFactory::Instance().create("EventWorkspace",
                                                number_spectra, 2, 1);
    // Copy geometry over.
    WorkspaceFactory::Instance().initializeFromParent(ws, outWS, true);
  } else {
    // Now create the outputworkspace and copy over the instrument object
    outWS = WorkspaceFactory::Instance().create(ws, number_spectra, 2, 1);
  }

  outWS->rebuildSpectraMapping(true /* include monitors */);

  // ---- Set the values ----------
  if (!MakeEventWorkspace) {
    auto ws2D = boost::dynamic_pointer_cast<Workspace2D>(outWS);
    Counts v_y(1, detector_value);
    Counts v_monitor_y(1, monitor_value);
    CountStandardDeviations v_e(1, detector_value);
    CountStandardDeviations v_monitor_e(1, monitor_value);

    for (size_t i = 0; i < ws2D->getNumberHistograms(); i++) {
      IDetector_const_sptr det = ws2D->getDetector(i);
      if (det->isMonitor()) {
        ws2D->setCounts(i, v_monitor_y);
        ws2D->setCountStandardDeviations(i, v_monitor_e);
      } else {
        ws2D->setCounts(i, v_y);
        ws2D->setCountStandardDeviations(i, v_e);
      }
    }
  }
  // Save in output
  this->setProperty("OutputWorkspace", outWS);
}

/// Run the Child Algorithm LoadInstrument (or LoadInstrumentFromRaw)
API::MatrixWorkspace_sptr LoadEmptyInstrument::runLoadInstrument() {
  const std::string filename = getPropertyValue("Filename");
  // Determine the search directory for XML instrument definition files (IDFs)
  std::string directoryName =
      Kernel::ConfigService::Instance().getInstrumentDirectory();
  const std::string::size_type stripPath = filename.find_last_of("\\/");

  std::string fullPathIDF;
  if (stripPath != std::string::npos) {
    fullPathIDF =
        filename; // since if path already provided don't modify m_filename
  } else {
    // std::string instrumentID = m_filename.substr(stripPath+1);
    fullPathIDF = directoryName + "/" + filename;
  }

  IAlgorithm_sptr loadInst = createChildAlgorithm("LoadInstrument", 0, 1);
  loadInst->setPropertyValue("Filename", fullPathIDF);
  loadInst->setProperty("RewriteSpectraMap", OptionalBool(true));
  MatrixWorkspace_sptr ws =
      WorkspaceFactory::Instance().create("Workspace2D", 1, 2, 1);
  loadInst->setProperty<MatrixWorkspace_sptr>("Workspace", ws);

  // Now execute the Child Algorithm. Catch and log any error and stop,
  // because there is no point in continuing without a valid instrument.
  try {
    loadInst->execute();
  } catch (std::runtime_error &exc) {
    std::ostringstream os;
    os << "Unable to run LoadInstrument: '" << exc.what() << "'\n";
    throw std::runtime_error(os.str());
  }

  return ws;
}

} // namespace DataHandling
} // namespace Mantid