PeakParameterHelper.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2021 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/FunctionValues.h"
#include "MantidAPI/IBackgroundFunction.h"
#include "MantidAPI/IPeakFunction.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidHistogramData/Histogram.h"
 
#include <algorithm>
#include <utility>
 
namespace Mantid {
namespace Algorithms {
 
namespace PeakParameterHelper {
enum EstimatePeakWidth { NoEstimation, Observation, InstrumentResolution };
enum PeakFitResult { NOSIGNAL, LOWPEAK, OUTOFBOUND, GOOD };
 
template <typename vector_like>
MANTID_ALGORITHMS_DLL size_t findXIndex(const vector_like &vecx, const double x, const size_t startindex = 0);
 
MANTID_ALGORITHMS_DLL int observePeakCenter(const HistogramData::Histogram &histogram,
                                            const API::FunctionValues &bkgd_values, size_t start_index,
                                            size_t stop_index, double &peak_center, size_t &peak_center_index,
                                            double &peak_height);
 
MANTID_ALGORITHMS_DLL double observePeakFwhm(const HistogramData::Histogram &histogram,
                                             const API::FunctionValues &bkgd_values, size_t ipeak, size_t istart,
                                             size_t istop, const EstimatePeakWidth peakWidthEstimateApproach,
                                             const double peakWidthPercentage);
 
MANTID_ALGORITHMS_DLL int
estimatePeakParameters(const HistogramData::Histogram &histogram, const std::pair<size_t, size_t> &peak_window,
                       const API::IPeakFunction_sptr &peakfunction, const API::IBackgroundFunction_sptr &bkgdfunction,
                       bool observe_peak_width, const EstimatePeakWidth peakWidthEstimateApproach,
                       const double peakWidthPercentage, const double minPeakHeight);
} // namespace PeakParameterHelper
 
} // namespace Algorithms
} // namespace Mantid