LoadRawBin0.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/LoadRawBin0.h"
#include "LoadRaw/isisraw2.h"
#include "MantidAPI/FileProperty.h"
#include "MantidAPI/WorkspaceGroup_fwd.h"
#include "MantidDataHandling/LoadLog.h"
#include "MantidDataObjects/Workspace2D.h"
#include "MantidKernel/ArrayProperty.h"
#include "MantidKernel/BoundedValidator.h"
#include "MantidKernel/ConfigService.h"
#include "MantidKernel/TimeSeriesProperty.h"
#include "MantidKernel/UnitFactory.h"
 
#include <cmath>
#include <cstdio> //Required for gcc 4.4
#include <memory>
 
namespace Mantid::DataHandling {
// Register the algorithm into the algorithm factory
DECLARE_ALGORITHM(LoadRawBin0)
 
using namespace Kernel;
using namespace API;
 
LoadRawBin0::LoadRawBin0()
    : isisRaw(), m_filename(), m_numberOfSpectra(0), m_noTimeRegimes(0), m_cache_options(), m_specTimeRegimes(),
      m_prog(0.0), m_lengthIn(0), m_perioids(), m_total_specs(0), m_timeChannelsVec() {}
 
void LoadRawBin0::init() {
  LoadRawHelper::init();
  auto mustBePositive = std::make_shared<BoundedValidator<int>>();
  mustBePositive->setLower(1);
  declareProperty("SpectrumMin", 1, mustBePositive, "The number of the first spectrum to read.");
  declareProperty("SpectrumMax", EMPTY_INT(), mustBePositive, "The number of the last spectrum to read.");
  declareProperty(std::make_unique<ArrayProperty<specnum_t>>("SpectrumList"),
                  "A comma-separated list of individual spectra to read.  Only used if "
                  "explicitly set.");
}
 
void LoadRawBin0::exec() {
  // Retrieve the filename from the properties
  m_filename = getPropertyValue("Filename");
 
  bool bLoadlogFiles = getProperty("LoadLogFiles");
 
  // open the raw file
  FILE *file = openRawFile(m_filename);
 
  // Need to check that the file is not a text file as the ISISRAW routines
  // don't deal with these very well, i.e
  // reading continues until a bad_alloc is encountered.
  if (Kernel::FileDescriptor::isAscii(file)) {
    g_log.error() << "File \"" << m_filename << "\" is not a valid RAW file.\n";
    throw std::invalid_argument("Incorrect file type encountered.");
  }
  std::string title;
  readTitle(file, title);
 
  readworkspaceParameters(m_numberOfSpectra, m_numberOfPeriods, m_lengthIn, m_noTimeRegimes);
 
  setOptionalProperties();
 
  // to validate the optional parameters, if set
  checkOptionalProperties();
 
  // Calculate the size of a workspace, given its number of periods & spectra to
  // read
  m_total_specs = calculateWorkspaceSize();
 
  // no real X values for bin 0,so initialize this to zero
  auto channelsVec = std::make_shared<HistogramData::HistogramX>(1, 0);
  m_timeChannelsVec.emplace_back(channelsVec);
 
  auto histTotal = static_cast<double>(m_total_specs * m_numberOfPeriods);
  int64_t histCurrent = -1;
 
  // Create the 2D workspace for the output xlength and ylength is one
  DataObjects::Workspace2D_sptr localWorkspace = createWorkspace(m_total_specs, 1, 1, title);
  Run &run = localWorkspace->mutableRun();
  if (bLoadlogFiles) {
    runLoadLog(m_filename, localWorkspace, 0.0, 0.0);
    const int period_number = 1;
    createPeriodLogs(period_number, localWorkspace);
  }
  // Set the total proton charge for this run
  setProtonCharge(run);
 
  WorkspaceGroup_sptr ws_grp = createGroupWorkspace();
  setWorkspaceProperty("OutputWorkspace", title, ws_grp, localWorkspace, m_numberOfPeriods, false, this);
 
  // Loop over the number of periods in the raw file, putting each period in a
  // separate workspace
  for (int period = 0; period < m_numberOfPeriods; ++period) {
    if (period > 0) {
      localWorkspace = createWorkspace(localWorkspace);
 
      if (bLoadlogFiles) {
        // remove previous period data
        std::stringstream prevPeriod;
        prevPeriod << "PERIOD " << (period);
        Run &runObj = localWorkspace->mutableRun();
        runObj.removeLogData(prevPeriod.str());
        runObj.removeLogData("current_period");
        // add current period data
        const int period_number = period + 1;
        createPeriodLogs(period_number, localWorkspace);
      }
    }
 
    const int64_t periodTimesNSpectraP1 = period * (static_cast<int64_t>(m_numberOfSpectra) + 1);
    skipData(file, periodTimesNSpectraP1);
    int64_t wsIndex = 0;
    for (specnum_t i = 1; i <= m_numberOfSpectra; ++i) {
      int64_t histToRead = i + periodTimesNSpectraP1;
      if ((i >= m_spec_min && i < m_spec_max) ||
          (m_list && find(m_spec_list.begin(), m_spec_list.end(), i) != m_spec_list.end())) {
        progress(m_prog, "Reading raw file data...");
        // readData(file, histToRead);
        // read spectrum
        if (!readData(file, histToRead)) {
          throw std::runtime_error("Error reading raw file");
        }
        int64_t binStart = 0;
        setWorkspaceData(localWorkspace, m_timeChannelsVec, wsIndex, i, m_noTimeRegimes, 1, binStart);
        ++wsIndex;
 
        if (m_numberOfPeriods == 1) {
          if (++histCurrent % 100 == 0) {
            m_prog = double(histCurrent) / histTotal;
          }
          interruption_point();
        }
 
      } else {
        skipData(file, histToRead);
      }
    }
 
    if (m_numberOfPeriods > 1) {
      setWorkspaceProperty(localWorkspace, ws_grp, period, false, this);
      // progress for workspace groups
      m_prog = static_cast<double>(period) / static_cast<double>(m_numberOfPeriods - 1);
    }
 
  } // loop over periods
  // Clean up
  isisRaw.reset();
  fclose(file);
}
 
void LoadRawBin0::setOptionalProperties() {
  // read in the settings passed to the algorithm
  m_spec_list = getProperty("SpectrumList");
  m_spec_max = getProperty("SpectrumMax");
  m_spec_min = getProperty("SpectrumMin");
}
 
} // namespace Mantid::DataHandling