ISISRunLogs.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 +
// Includes
#include "MantidDataHandling/ISISRunLogs.h"
 
#include "MantidKernel/LogFilter.h"
#include "MantidKernel/TimeSeriesProperty.h"
 
namespace Mantid::DataHandling {
namespace {
Kernel::Logger g_log("ISISRunLogs");
} // namespace
 
using Kernel::LogFilter;
using Kernel::LogParser;
using Kernel::TimeSeriesProperty;
 
ISISRunLogs::ISISRunLogs(const API::Run &icpRun) {
  // ICP event either in form icp_event or icpevent
  for (const auto icpLogName : {"icp_event", "icpevent"}) {
    try {
      Kernel::Property *icpLog = icpRun.getLogData(icpLogName);
      m_logParser = std::make_unique<LogParser>(icpLog);
      return;
    } catch (std::runtime_error &) {
    }
  }
  // If it does not exist then pass in a NULL log to indicate that period 1
  // should be assumed
  m_logParser = std::make_unique<LogParser>(nullptr);
}
 
void ISISRunLogs::addStatusLog(API::Run &exptRun) { exptRun.addLogData(m_logParser->createRunningLog()); }
 
void ISISRunLogs::addPeriodLogs(const int period, API::Run &exptRun) {
  auto periodLog = m_logParser->createPeriodLog(period);
 
  exptRun.addProperty(periodLog);
  exptRun.addProperty(m_logParser->createCurrentPeriodLog(period));
  try {
    exptRun.addLogData(m_logParser->createAllPeriodsLog());
  } catch (const std::runtime_error &) {
    // Already has one
  }
 
  ISISRunLogs::applyLogFiltering(exptRun);
}
 
void ISISRunLogs::applyLogFiltering(Mantid::API::Run &exptRun) {
  const TimeSeriesProperty<bool> *maskProp{nullptr};
  std::unique_ptr<LogFilter> logFilter{nullptr};
  try {
    auto runningLog = exptRun.getTimeSeriesProperty<bool>(LogParser::statusLogName());
    logFilter = std::make_unique<LogFilter>(*runningLog);
  } catch (std::exception &) {
    g_log.warning("Cannot find status log. Logs will be not be filtered by run status");
  }
 
  TimeSeriesProperty<bool> *currentPeriodLog = nullptr;
  bool multiperiod = false;
  try {
    auto period = exptRun.getPropertyAsIntegerValue(LogParser::currentPeriodLogName());
    currentPeriodLog = exptRun.getTimeSeriesProperty<bool>(LogParser::currentPeriodLogName(period));
  } catch (const std::exception &) {
    g_log.warning("Cannot find period log. Logs will be not be filtered by "
                  "current period");
  }
 
  try {
    // get the number of periods as the max of the periods log
    auto periodsLog = exptRun.getTimeSeriesProperty<int>(LogParser::periodsLogName());
    multiperiod = (periodsLog->getStatistics().maximum > 1.);
  } catch (const std::exception &) {
    g_log.warning("Cannot find periods log. Logs will be not be filtered by "
                  "current period");
  }
 
  // If there is more than 1 period filter the logs by period as well
  if (multiperiod) {
    if (logFilter) {
      logFilter->addFilter(*currentPeriodLog);
      maskProp = logFilter->filter();
    } else
      maskProp = currentPeriodLog;
  } else if (logFilter) {
    maskProp = logFilter->filter();
  }
 
  // Filter logs if we have anything to filter on
  if (maskProp)
    exptRun.filterByLog(*maskProp, ISISRunLogs::getLogNamesExcludedFromFiltering(exptRun));
}
 
void ISISRunLogs::addPeriodLog(const int period, API::Run &exptRun) {
  exptRun.addLogData(m_logParser->createPeriodLog(period));
}
 
std::vector<std::string> ISISRunLogs::getLogNamesExcludedFromFiltering(const API::Run &run) {
  std::vector<std::string> retVal;
  if (run.hasProperty(LogParser::statusLogName())) {
    retVal.emplace_back(LogParser::statusLogName());
  }
  if (run.hasProperty(LogParser::periodsLogName())) {
    retVal.emplace_back(LogParser::periodsLogName());
  }
  const auto &props = run.getProperties();
  for (const auto prop : props) {
    // add all properties starting with period
    if (prop->name().rfind("period", 0) == 0) {
      // add if not already in the list
      if (std::find(retVal.cbegin(), retVal.cend(), prop->name()) == retVal.cend()) {
        retVal.emplace_back(prop->name());
      }
    }
  }
  return retVal;
}
 
} // namespace Mantid::DataHandling