BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
SpectrumUtils.h
Go to the documentation of this file.
1 // ************************************************************************** //
2 //
3 // BornAgain: simulate and fit scattering at grazing incidence
4 //
5 //! @file Device/Instrument/SpectrumUtils.h
6 //! @brief PyObvject forward declaration.
7 //!
8 //! @homepage http://www.bornagainproject.org
9 //! @license GNU General Public License v3 or higher (see COPYING)
10 //! @copyright Forschungszentrum Jülich GmbH 2018
11 //! @authors Scientific Computing Group at MLZ (see CITATION, AUTHORS)
12 //
13 // ************************************************************************** //
14 
15 #ifndef BORNAGAIN_CORE_INSTRUMENT_SPECTRUMUTILS_H
16 #define BORNAGAIN_CORE_INSTRUMENT_SPECTRUMUTILS_H
17 
19 #include <string>
20 #include <vector>
21 
22 class Histogram2D;
23 
24 //! Collection of utils for 1D and 2D spectrum processing (background, peaks, ets).
25 
26 namespace SpectrumUtils
27 {
28 
29 std::vector<std::pair<double, double>> FindPeaks(const Histogram2D& hist, double sigma = 2,
30  const std::string& option = {},
31  double threshold = 0.05);
32 }
33 
34 #endif // BORNAGAIN_CORE_INSTRUMENT_SPECTRUMUTILS_H
Defines class Histogram2D.
Two dimensional histogram.
Definition: Histogram2D.h:25
Collection of utils for 1D and 2D spectrum processing (background, peaks, ets).
Definition: SpectrumUtils.h:27
std::vector< std::pair< double, double > > FindPeaks(const Histogram2D &hist, double sigma=2, const std::string &option={}, double threshold=0.05)