SampleLogsBehaviourTest.h

// 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
// SPDX - License - Identifier: GPL - 3.0 +
#ifndef MANTID_ALGORITHMS_SAMPLELOGSBEHAVIOURTEST_H_
#define MANTID_ALGORITHMS_SAMPLELOGSBEHAVIOURTEST_H_

#include "MantidAPI/MatrixWorkspace.h"
#include "MantidAlgorithms/RunCombinationHelpers/SampleLogsBehaviour.h"
#include "MantidDataHandling/LoadParameterFile.h"
#include "MantidTestHelpers/WorkspaceCreationHelper.h"
#include <cxxtest/TestSuite.h>

using Mantid::Algorithms::SampleLogsBehaviour;
using namespace Mantid::API;
using namespace Mantid::DataHandling;
using namespace Mantid::Kernel;
using namespace WorkspaceCreationHelper;

class SampleLogsBehaviourTest : public CxxTest::TestSuite {
public:
  // This pair of boilerplate methods prevent the suite being created statically
  // This means the constructor isn't called when running other tests
  static SampleLogsBehaviourTest *createSuite() {
    return new SampleLogsBehaviourTest();
  }
  static void destroySuite(SampleLogsBehaviourTest *suite) { delete suite; }

  // Please note that many tests are currently present in MergeRunsTest.

  void testMergeRunsIPFNames() {
    // Using default values of the constructor
    Logger log("testLog");
    MatrixWorkspace_sptr ws = create2DWorkspaceWithFullInstrument(
        3, 3, true, false, true, m_instrName);
    // Add sample logs
    ws->mutableRun().addLogData(new PropertyWithValue<double>("A", 2.65));
    ws->mutableRun().addLogData(new PropertyWithValue<double>("B", 1.56));
    ws->mutableRun().addLogData(new PropertyWithValue<double>("C", 8.55));
    // Load test parameter file
    LoadParameterFile addIPF;
    TS_ASSERT_THROWS_NOTHING(addIPF.initialize());
    TS_ASSERT_THROWS_NOTHING(addIPF.setProperty("ParameterXML", m_parameterXML))
    TS_ASSERT_THROWS_NOTHING(addIPF.setProperty("Workspace", ws))
    TS_ASSERT_THROWS_NOTHING(addIPF.execute())
    TS_ASSERT(addIPF.isExecuted())
    SampleLogsBehaviour sbh = SampleLogsBehaviour(ws, log);
    TS_ASSERT_THROWS_NOTHING(sbh.mergeSampleLogs(ws, ws));
    const std::string A = ws->run().getLogData("A")->value();
    const std::string B = ws->run().getLogData("B")->value();
    const std::string C = ws->run().getLogData("C")->value();
    // B summed accprding to IPF
    TS_ASSERT_EQUALS(A, "2.6499999999999999")
    TS_ASSERT_EQUALS(B, "3.1200000000000001")
    TS_ASSERT_EQUALS(C, "8.5500000000000007")
  }

  void testMergeRunsUserNames() {
    // Using default values of the constructor
    Logger log("testLog");
    MatrixWorkspace_sptr ws = create2DWorkspaceWithFullInstrument(
        3, 3, true, false, true, m_instrName);
    // Add sample logs
    ws->mutableRun().addLogData(new PropertyWithValue<double>("A", 2.65));
    ws->mutableRun().addLogData(new PropertyWithValue<double>("B", 1.56));
    ws->mutableRun().addLogData(new PropertyWithValue<double>("C", 8.55));
    // Load test parameter file
    LoadParameterFile addIPF;
    TS_ASSERT_THROWS_NOTHING(addIPF.initialize());
    TS_ASSERT_THROWS_NOTHING(addIPF.setProperty("ParameterXML", m_parameterXML))
    TS_ASSERT_THROWS_NOTHING(addIPF.setProperty("Workspace", ws))
    TS_ASSERT_THROWS_NOTHING(addIPF.execute())
    TS_ASSERT(addIPF.isExecuted())
    SampleLogsBehaviour sbh = SampleLogsBehaviour(ws, log, "A");
    TS_ASSERT_THROWS_NOTHING(sbh.mergeSampleLogs(ws, ws));
    const std::string A = ws->run().getLogData("A")->value();
    const std::string B = ws->run().getLogData("B")->value();
    const std::string C = ws->run().getLogData("C")->value();
    // A summed according to user name and B summed according to IPF
    TS_ASSERT_EQUALS(A, "5.2999999999999998")
    TS_ASSERT_EQUALS(B, "3.1200000000000001")
    TS_ASSERT_EQUALS(C, "8.5500000000000007")
  }

  void testConjoinXRunsIPFNames() {
    // Using suffix conjoin_ + default value names for constructing
    Logger log("testLog");
    MatrixWorkspace_sptr ws = create2DWorkspaceWithFullInstrument(
        3, 3, true, false, true, m_instrName);
    // Add sample logs
    ws->mutableRun().addLogData(new PropertyWithValue<double>("A", 2.65));
    ws->mutableRun().addLogData(new PropertyWithValue<double>("B", 1.56));
    ws->mutableRun().addLogData(new PropertyWithValue<double>("C", 8.55));
    // Load test parameter file
    LoadParameterFile addIPF;
    TS_ASSERT_THROWS_NOTHING(addIPF.initialize())
    TS_ASSERT_THROWS_NOTHING(addIPF.setProperty("ParameterXML", m_parameterXML))
    TS_ASSERT_THROWS_NOTHING(addIPF.setProperty("Workspace", ws))
    TS_ASSERT_THROWS_NOTHING(addIPF.execute())
    TS_ASSERT(addIPF.isExecuted())
    SampleLogsBehaviour sbh = SampleLogsBehaviour(
        ws, log, "", "", "", "", "", "", "", "conjoin_sample_logs_sum");
    sbh.mergeSampleLogs(ws, ws);
    const std::string A = ws->run().getLogData("A")->value();
    const std::string B = ws->run().getLogData("B")->value();
    const std::string C = ws->run().getLogData("C")->value();
    // A and C summed according to IPF
    TS_ASSERT_EQUALS(A, "5.2999999999999998")
    TS_ASSERT_EQUALS(B, "1.5600000000000001")
    TS_ASSERT_EQUALS(C, "17.100000000000001")
  }

  void testConjoinXRunsUserNames() {
    // Using suffix conjoin_ + default value names for constructing
    Logger log("testLog");
    MatrixWorkspace_sptr ws = create2DWorkspaceWithFullInstrument(
        3, 3, true, false, true, m_instrName);
    // Add sample logs
    ws->mutableRun().addLogData(new PropertyWithValue<double>("A", 2.65));
    ws->mutableRun().addLogData(new PropertyWithValue<double>("B", 1.56));
    ws->mutableRun().addLogData(new PropertyWithValue<double>("C", 8.55));
    // Load test parameter file
    LoadParameterFile addIPF;
    TS_ASSERT_THROWS_NOTHING(addIPF.initialize())
    TS_ASSERT_THROWS_NOTHING(addIPF.setProperty("ParameterXML", m_parameterXML))
    TS_ASSERT_THROWS_NOTHING(addIPF.setProperty("Workspace", ws))
    TS_ASSERT_THROWS_NOTHING(addIPF.execute())
    TS_ASSERT(addIPF.isExecuted())
    SampleLogsBehaviour sbh = SampleLogsBehaviour(
        ws, log, "B", "", "", "", "", "", "", "conjoin_sample_logs_sum");
    sbh.mergeSampleLogs(ws, ws);
    const std::string A = ws->run().getLogData("A")->value();
    const std::string B = ws->run().getLogData("B")->value();
    const std::string C = ws->run().getLogData("C")->value();
    // B summed according to user name and A and B summed according to IPF
    TS_ASSERT_EQUALS(A, "5.2999999999999998")
    TS_ASSERT_EQUALS(B, "1.5600000000000001")
    TS_ASSERT_EQUALS(C, "17.100000000000001")
  }

private:
  // Test instrument name
  const std::string m_instrName = "INSTR";
  // Define parameter XML string
  std::string m_parameterXML =
      "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>"
      "<parameter-file instrument=\"INSTR\" valid-from=\"2018-11-07 "
      "12:00:00\">"
      "  <component-link name=\"INSTR\">"
      "    <!-- For MergeRuns.-->"
      "    <parameter name=\"sample_logs_sum\" type=\"string\">"
      "	<value val=\"B\" />"
      "    </parameter>"
      "    <!-- For ConjoinXRuns. -->"
      "    <parameter name=\"conjoin_sample_logs_sum\" type=\"string\">"
      "       <value val=\"A, C\" />"
      "    </parameter>"
      "  </component-link>"
      "</parameter-file>";
};

#endif /* MANTID_ALGORITHMS_SAMPLELOGSBEHAVIOURTEST_H_ */