CreateDetectorTable.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2019 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 +
#pragma once
 
#include "MantidAPI/Algorithm.h"
#include "MantidAPI/EnabledWhenWorkspaceIsType.h"
#include "MantidAPI/ExperimentInfo.h"
#include "MantidAPI/IPeaksWorkspace.h"
#include "MantidAPI/ITableWorkspace.h"
#include "MantidAPI/MatrixWorkspace.h"
#include "MantidAPI/SpectrumInfo.h"
#include "MantidAPI/TableRow.h"
#include "MantidAPI/WorkspaceFactory.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidDataObjects/TableWorkspace.h"
#include "MantidGeometry/IComponent.h"
#include "MantidGeometry/Instrument.h"
#include "MantidGeometry/Instrument/DetectorInfo.h"
#include "MantidGeometry/Instrument/ReferenceFrame.h"
#include "MantidKernel/ArrayProperty.h"
#include "MantidKernel/UnitConversion.h"
 
namespace Mantid {
namespace Algorithms {
 
class MANTID_ALGORITHMS_DLL CreateDetectorTable final : public API::Algorithm {
public:
  CreateDetectorTable() : API::Algorithm() {}
  const std::string name() const override { return "CreateDetectorTable"; }
  int version() const override { return 1; }
  const std::string category() const override { return "Utility\\Workspaces"; }
  const std::string summary() const override {
    return "Create a table showing detector information for the given "
           "workspace and optionally the data for that detector";
  }
  std::map<std::string, std::string> validateInputs() override;
 
private:
  void init() override;
  void exec() override;
};
 
API::ITableWorkspace_sptr createDetectorTableWorkspace(const API::MatrixWorkspace_sptr &ws,
                                                       const std::vector<int> &indices, const bool includeData,
                                                       Kernel::Logger &logger);
 
std::string createTruncatedList(const std::set<int> &elements);
 
void populateTable(Mantid::API::ITableWorkspace_sptr &t, const Mantid::API::MatrixWorkspace_sptr &ws, const int nrows,
                   const std::vector<int> &indices, const Mantid::API::SpectrumInfo &spectrumInfo,
                   bool signedThetaParamRetrieved, bool showSignedTwoTheta,
                   const Mantid::Geometry::PointingAlong &beamAxisIndex, const double sampleDist, const bool isScanning,
                   const bool include_data, const bool calcQ, const bool includeDiffConstants, Kernel::Logger &logger);
std::vector<std::pair<std::string, std::string>> createColumns(const bool isScanning, const bool includeData,
                                                               const bool calcQ, const bool hasDiffConstants);
 
} // namespace Algorithms
} // namespace Mantid