DetectorDiagnostic.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2008 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
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidDataObjects/MaskWorkspace.h"
#include "MantidGeometry/IComponent.h"
 
#include <set>
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL DetectorDiagnostic : public API::Algorithm {
public:
  DetectorDiagnostic();
  virtual ~DetectorDiagnostic() = default;
  const std::string category() const override;
  const std::string name() const override;
  const std::string summary() const override {
    return "Identifies histograms and their detectors that have total numbers "
           "of counts over a user defined maximum or less than the user define "
           "minimum.";
  }
 
  int version() const override;
  const std::vector<std::string> seeAlso() const override {
    return {"FindDetectorsOutsideLimits", "FindDeadDetectors", "MedianDetectorTest", "DetectorEfficiencyVariation"};
  }
 
private:
  // Overridden Algorithm methods
  void init() override;
  void exec() override;
  void applyMask(const API::MatrixWorkspace_sptr &inputWS, const API::MatrixWorkspace_sptr &maskWS);
  API::MatrixWorkspace_sptr doDetVanTest(const API::MatrixWorkspace_sptr &inputWS, int &nFails);
 
protected:
  API::MatrixWorkspace_sptr integrateSpectra(const API::MatrixWorkspace_sptr &inputWS, const int indexMin,
                                             const int indexMax, const double lower, const double upper,
                                             const bool outputWorkspace2D = false);
 
  DataObjects::MaskWorkspace_sptr generateEmptyMask(const API::MatrixWorkspace_const_sptr &inputWS);
 
  std::vector<double> calculateMedian(const API::MatrixWorkspace &input, bool excludeZeroes,
                                      const std::vector<std::vector<size_t>> &indexmap);
  API::MatrixWorkspace_sptr convertToRate(API::MatrixWorkspace_sptr workspace);
  std::vector<std::vector<size_t>> makeMap(const API::MatrixWorkspace_sptr &countsWS);
  std::vector<std::vector<size_t>> makeInstrumentMap(const API::MatrixWorkspace &countsWS);
 
  enum RunTime {
    RTGetSolidAngle = 15000,
    RTGetTotalCounts = 5000,
    RTGetRate = 100,
    RTMarkDetects = 200,
    RTWriteFile = 200,
    RTTotal = RTGetSolidAngle + RTGetTotalCounts + RTGetRate + RTMarkDetects + RTWriteFile
  };
 
  double advanceProgress(double toAdd);
  void failProgress(RunTime aborted);
 
  double m_fracDone;
  int m_TotalTime;
 
  int m_parents;
  double m_progStepWidth;
  int m_minIndex;
  int m_maxIndex;
  double m_rangeLower;
  double m_rangeUpper;
};
 
} // namespace Algorithms
} // namespace Mantid