ScalarUtils.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2012 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 +
/* File: Scalar_Utils.h */
 
#pragma once
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidGeometry/Crystal/ConventionalCell.h"
#include "MantidGeometry/DllConfig.h"
#include "MantidKernel/Matrix.h"
 
namespace Mantid {
namespace Geometry {
class MANTID_GEOMETRY_DLL ScalarUtils {
public:
  static std::vector<ConventionalCell> GetCells(const Kernel::DblMatrix &UB, bool best_only,
                                                bool allowPermutations = false);
 
  static std::vector<ConventionalCell> GetCells(const Kernel::DblMatrix &UB, const std::string &cell_type,
                                                const std::string &centering, bool allowPermutations = false);
 
  static std::vector<ConventionalCell> GetCellsUBOnly(const Kernel::DblMatrix &UB, const std::string &cell_type,
                                                      const std::string &centering, bool allowPermutations = false);
 
  static ConventionalCell GetCellForForm(const Kernel::DblMatrix &UB, size_t form_num, bool allowPermutations = false);
  static void RemoveHighErrorForms(std::vector<ConventionalCell> &list, double level);
 
  static ConventionalCell GetCellBestError(const std::vector<ConventionalCell> &list, bool use_triclinic);
 
  static std::vector<Kernel::DblMatrix> GetRelatedUBs(const Kernel::DblMatrix &UB, double factor,
                                                      double angle_tolerance);
 
private:
  static void AddIfBest(std::vector<ConventionalCell> &list, ConventionalCell &info);
};
 
} // namespace Geometry
} // namespace Mantid