#include <FindSXPeaksHelper.h>
Public Member Functions | |
| PeakList | findSXPeaks (const HistogramData::HistogramX &x, const HistogramData::HistogramY &y, const HistogramData::HistogramE &e, const int workspaceIndex) const |
| PeakFindingStrategy (const BackgroundStrategy *backgroundStrategy, const API::SpectrumInfo &spectrumInfo, const double minValue=EMPTY_DBL(), const double maxValue=EMPTY_DBL(), const XAxisUnit units=XAxisUnit::TOF) | |
| void | setMinNBinsPerPeak (int minBinsPerPeak) |
| virtual | ~PeakFindingStrategy ()=default |
Protected Member Functions | |
| double | calculatePhi (size_t workspaceIndex) const |
| Calculates the average phi value if the workspace contains multiple detectors per spectrum, or returns the value of phi if it is a single detector to spectrum mapping. | |
| PeakList | convertToSXPeaks (const HistogramData::HistogramX &x, const HistogramData::HistogramY &y, const std::vector< std::unique_ptr< PeakContainer > > &peaks, const int workspaceIndex) const |
| double | convertToTOF (const double xValue, const size_t workspaceIndex) const |
| virtual PeakList | dofindSXPeaks (const HistogramData::HistogramX &x, const HistogramData::HistogramY &y, const HistogramData::HistogramE &e, Bound low, Bound high, const int workspaceIndex) const =0 |
| void | filterPeaksForMinBins (std::vector< std::unique_ptr< PeakContainer > > &inputPeakList) const |
| BoundsIterator | getBounds (const HistogramData::HistogramX &x) const |
| double | getXValue (const HistogramData::HistogramX &x, const size_t peakLocation) const |
Protected Attributes | |
| const BackgroundStrategy * | m_backgroundStrategy |
| const double | m_maxValue = EMPTY_DBL() |
| int | m_minNBinsPerPeak = EMPTY_INT() |
| const double | m_minValue = EMPTY_DBL() |
| const API::SpectrumInfo & | m_spectrumInfo |
| const XAxisUnit | m_units |
Detailed Description
Definition at line 153 of file FindSXPeaksHelper.h.
Constructor & Destructor Documentation
◆ PeakFindingStrategy()
| Mantid::Crystal::FindSXPeaksHelper::PeakFindingStrategy::PeakFindingStrategy | ( | const BackgroundStrategy * | backgroundStrategy, |
| const API::SpectrumInfo & | spectrumInfo, | ||
| const double | minValue = EMPTY_DBL(), |
||
| const double | maxValue = EMPTY_DBL(), |
||
| const XAxisUnit | units = XAxisUnit::TOF |
||
| ) |
Definition at line 278 of file FindSXPeaksHelper.cpp.
◆ ~PeakFindingStrategy()
|
virtualdefault |
Member Function Documentation
◆ calculatePhi()
|
protected |
Calculates the average phi value if the workspace contains multiple detectors per spectrum, or returns the value of phi if it is a single detector to spectrum mapping.
- Parameters
-
workspaceIndex :: The index to return the phi value of
- Returns
- :: The averaged or exact value of phi
Definition at line 341 of file FindSXPeaksHelper.cpp.
References Mantid::API::SpectrumInfo::detector(), Mantid::Geometry::IDetector::getPhi(), m_spectrumInfo, and Mantid::API::SpectrumInfo::spectrumDefinition().
Referenced by convertToSXPeaks(), and Mantid::Crystal::FindSXPeaksHelper::StrongestPeaksStrategy::dofindSXPeaks().
◆ convertToSXPeaks()
|
protected |
Definition at line 387 of file FindSXPeaksHelper.cpp.
References calculatePhi(), convertToTOF(), getXValue(), m_spectrumInfo, Mantid::Geometry::x, and Mantid::Geometry::y.
Referenced by Mantid::Crystal::FindSXPeaksHelper::AllPeaksStrategy::dofindSXPeaks(), and Mantid::Crystal::FindSXPeaksHelper::NSigmaPeaksStrategy::dofindSXPeaks().
◆ convertToTOF()
|
protected |
Definition at line 372 of file FindSXPeaksHelper.cpp.
References Mantid::Kernel::DeltaEMode::Elastic, Mantid::API::SpectrumInfo::getDetectorValues(), Mantid::API::SpectrumInfo::l1(), m_spectrumInfo, m_units, and Mantid::Crystal::FindSXPeaksHelper::TOF.
Referenced by convertToSXPeaks(), and Mantid::Crystal::FindSXPeaksHelper::StrongestPeaksStrategy::dofindSXPeaks().
◆ dofindSXPeaks()
◆ filterPeaksForMinBins()
|
protected |
Definition at line 309 of file FindSXPeaksHelper.cpp.
References Mantid::EMPTY_INT(), and m_minNBinsPerPeak.
Referenced by Mantid::Crystal::FindSXPeaksHelper::AllPeaksStrategy::dofindSXPeaks(), and Mantid::Crystal::FindSXPeaksHelper::NSigmaPeaksStrategy::dofindSXPeaks().
◆ findSXPeaks()
| PeakList Mantid::Crystal::FindSXPeaksHelper::PeakFindingStrategy::findSXPeaks | ( | const HistogramData::HistogramX & | x, |
| const HistogramData::HistogramY & | y, | ||
| const HistogramData::HistogramE & | e, | ||
| const int | workspaceIndex | ||
| ) | const |
Definition at line 284 of file FindSXPeaksHelper.cpp.
References dofindSXPeaks(), getBounds(), Mantid::Geometry::x, and Mantid::Geometry::y.
◆ getBounds()
|
protected |
Definition at line 323 of file FindSXPeaksHelper.cpp.
References Mantid::EMPTY_DBL(), m_maxValue, m_minValue, and Mantid::Geometry::x.
Referenced by findSXPeaks().
◆ getXValue()
|
protected |
Definition at line 365 of file FindSXPeaksHelper.cpp.
References Mantid::Geometry::x.
Referenced by convertToSXPeaks(), and Mantid::Crystal::FindSXPeaksHelper::StrongestPeaksStrategy::dofindSXPeaks().
◆ setMinNBinsPerPeak()
| void Mantid::Crystal::FindSXPeaksHelper::PeakFindingStrategy::setMinNBinsPerPeak | ( | int | minBinsPerPeak | ) |
Definition at line 307 of file FindSXPeaksHelper.cpp.
References m_minNBinsPerPeak.
Member Data Documentation
◆ m_backgroundStrategy
|
protected |
◆ m_maxValue
|
protected |
Definition at line 178 of file FindSXPeaksHelper.h.
Referenced by getBounds().
◆ m_minNBinsPerPeak
|
protected |
Definition at line 181 of file FindSXPeaksHelper.h.
Referenced by filterPeaksForMinBins(), and setMinNBinsPerPeak().
◆ m_minValue
|
protected |
Definition at line 177 of file FindSXPeaksHelper.h.
Referenced by getBounds().
◆ m_spectrumInfo
|
protected |
Definition at line 179 of file FindSXPeaksHelper.h.
Referenced by calculatePhi(), convertToSXPeaks(), convertToTOF(), and Mantid::Crystal::FindSXPeaksHelper::StrongestPeaksStrategy::dofindSXPeaks().
◆ m_units
|
protected |
Definition at line 180 of file FindSXPeaksHelper.h.
Referenced by convertToTOF().
The documentation for this class was generated from the following files:
- Framework/Crystal/inc/MantidCrystal/FindSXPeaksHelper.h
- Framework/Crystal/src/FindSXPeaksHelper.cpp
