ScaleInstrumentComponent.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2024 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 "MantidDataHandling/DllConfig.h"
#include "MantidGeometry/IComponent.h"
#include "MantidGeometry/Instrument/Component.h"
 
namespace Mantid {
 
namespace DataHandling {
 
class MANTID_DATAHANDLING_DLL ScaleInstrumentComponent : public API::Algorithm {
public:
  ScaleInstrumentComponent();
  const std::string name() const override { return "ScaleInstrumentComponent"; };
  const std::string summary() const override {
    return "Scales all detectors in a component around the component position.";
  }
 
  int version() const override { return 1; };
  const std::vector<std::string> seeAlso() const override {
    return {"RotateInstrumentComponent", "SetInstrumentParameter", "MoveInstrumentComponent"};
  }
  const std::string category() const override { return "DataHandling\\Instrument"; }
 
  std::map<std::string, std::string> validateInputs() override;
 
private:
  void init() override;
 
  void exec() override;
 
  Mantid::Geometry::ComponentInfo *m_componentInfo = nullptr;
  Mantid::Geometry::IComponent_const_sptr m_comp;
};
 
} // namespace DataHandling
} // namespace Mantid