MultiPeriodLoadMuonStrategy.cpp

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2020 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/MultiPeriodLoadMuonStrategy.h"
#include "MantidAPI/Run.h"
#include "MantidAPI/WorkspaceGroup.h"
#include "MantidDataHandling/LoadMuonNexusV2NexusHelper.h"
#include "MantidDataObjects/TableWorkspace.h"
#include "MantidDataObjects/Workspace2D.h"
#include "MantidNexus/NexusClasses.h"
 
namespace Mantid::DataHandling {
 
using namespace API;
using namespace Nexus;
using namespace DataObjects;
 
namespace {
const std::string GOODFRAMESPROP{"goodfrm"};
constexpr bool MULTIPERIODSLOADED = true;
} // namespace
 
// Constructor
MultiPeriodLoadMuonStrategy::MultiPeriodLoadMuonStrategy(Kernel::Logger &g_log, const std::string &filename,
                                                         LoadMuonNexusV2NexusHelper &nexusLoader,
                                                         API::WorkspaceGroup &workspace)
    : LoadMuonStrategy(g_log, filename, nexusLoader), m_workspaceGroup(workspace), m_detectors(getLoadedDetectors()) {}
 
void MultiPeriodLoadMuonStrategy::loadMuonLogData() {
  auto sampleInformation = m_nexusLoader.loadSampleInformationFromNexus();
  std::string mainFieldDirection = m_nexusLoader.loadMainFieldDirectionFromNexus();
  double firstGoodData = m_nexusLoader.loadFirstGoodDataFromNexus();
 
  for (int i = 0; i < m_workspaceGroup.getNumberOfEntries(); ++i) {
    auto workspace = std::dynamic_pointer_cast<Workspace2D>(m_workspaceGroup.getItem(i));
    auto &run = workspace->mutableRun();
    run.addProperty("main_field_direction", mainFieldDirection);
    run.addProperty("FirstGoodData", firstGoodData);
    run.addProperty("sample_temp", sampleInformation.temperature);
    run.addProperty("sample_magn_field", sampleInformation.magneticField);
  }
}
void MultiPeriodLoadMuonStrategy::loadGoodFrames() {
  NXInt goodframes = m_nexusLoader.loadGoodFramesDataFromNexus(MULTIPERIODSLOADED);
  for (int i = 0; i < m_workspaceGroup.getNumberOfEntries(); ++i) {
    auto workspace = std::dynamic_pointer_cast<Workspace2D>(m_workspaceGroup.getItem(i));
    auto &run = workspace->mutableRun();
    run.removeProperty(GOODFRAMESPROP);
    run.addProperty(GOODFRAMESPROP, goodframes[i]);
  }
}
 
Workspace_sptr MultiPeriodLoadMuonStrategy::loadDetectorGrouping() const {
  // Each period could in theory have its own grouping, which is reflected in
  // the nexus file which has (periods*numDetectors) entries in the Nexus
  // grouping entry.
  WorkspaceGroup_sptr tableGroup = std::make_shared<WorkspaceGroup>();
  for (int i = 0; i < m_workspaceGroup.getNumberOfEntries(); ++i) {
    int periodNumber = i + 1;
    auto const grouping = m_nexusLoader.loadDetectorGroupingFromNexus(m_detectors, MULTIPERIODSLOADED, periodNumber);
    auto const table = createDetectorGroupingTable(m_detectors, grouping);
    // if any of the tables are empty we'll load grouping from the IDF
    if (!table || (*table)->rowCount() == 0) {
      return loadDefaultDetectorGrouping(*std::dynamic_pointer_cast<Workspace2D>(m_workspaceGroup.getItem(i)));
    }
    tableGroup->addWorkspace(*table);
  }
  return tableGroup;
}
void MultiPeriodLoadMuonStrategy::applyTimeZeroCorrection() {
  double timeZero = m_nexusLoader.loadTimeZeroFromNexusFile();
  for (int wsIndex = 0; wsIndex < m_workspaceGroup.getNumberOfEntries(); ++wsIndex) {
    auto workspace = std::dynamic_pointer_cast<Workspace2D>(m_workspaceGroup.getItem(wsIndex));
    auto numHistograms = workspace->getNumberHistograms();
    for (size_t i = 0; i < numHistograms; ++i) {
      auto &timeAxis = workspace->mutableX(i);
      timeAxis = timeAxis - timeZero;
    }
  }
}
// Load dead time table
API::Workspace_sptr MultiPeriodLoadMuonStrategy::loadDeadTimeTable() const {
  WorkspaceGroup_sptr tableGroup = std::make_shared<WorkspaceGroup>();
  for (int i = 0; i < m_workspaceGroup.getNumberOfEntries(); ++i) {
    int periodNumber = i + 1;
    auto deadTimes = m_nexusLoader.loadDeadTimesFromNexus(m_detectors, MULTIPERIODSLOADED, periodNumber);
    tableGroup->addWorkspace(createDeadTimeTable(m_detectors, deadTimes));
  }
  return tableGroup;
}
 
Workspace_sptr MultiPeriodLoadMuonStrategy::getTimeZeroTable() {
  auto workspace = std::dynamic_pointer_cast<Workspace2D>(m_workspaceGroup.getItem(0));
  const auto numSpec = workspace->getNumberHistograms();
  auto timeZeros = m_nexusLoader.loadTimeZeroListFromNexusFile(numSpec);
  return createTimeZeroTable(numSpec, timeZeros);
}
 
std::vector<detid_t> MultiPeriodLoadMuonStrategy::getLoadedDetectors() {
  // Assume each spectrum maps to the same detector in each period.
  auto workspace = std::dynamic_pointer_cast<Workspace2D>(m_workspaceGroup.getItem(0));
  return getLoadedDetectorsFromWorkspace(*workspace);
}
 
} // namespace Mantid::DataHandling