Mantid::Crystal::FindSXPeaksHelper::PeakFindingStrategy Class Reference

#include <FindSXPeaksHelper.h>

Inheritance diagram for Mantid::Crystal::FindSXPeaksHelper::PeakFindingStrategy:

Public Member Functions
PeakList	findSXPeaks (const HistogramData::HistogramX &x, const HistogramData::HistogramY &y, 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)
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. More...
double	convertToTOF (const double xValue, const size_t workspaceIndex) const
virtual PeakList	dofindSXPeaks (const HistogramData::HistogramX &x, const HistogramData::HistogramY &y, Bound low, Bound high, const int workspaceIndex) const =0
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()
const double	m_minValue = EMPTY_DBL()
const API::SpectrumInfo &	m_spectrumInfo
const XAxisUnit	m_units

Detailed Description

Definition at line 150 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 268 of file FindSXPeaksHelper.cpp.

~PeakFindingStrategy()

virtual Mantid::Crystal::FindSXPeaksHelper::PeakFindingStrategy::~PeakFindingStrategy ( )

virtualdefault

Member Function Documentation

calculatePhi()

double Mantid::Crystal::FindSXPeaksHelper::PeakFindingStrategy::calculatePhi ( size_t  workspaceIndex ) const

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 315 of file FindSXPeaksHelper.cpp.

References Mantid::API::SpectrumInfo::detector(), Mantid::Geometry::IDetector::getPhi(), m_spectrumInfo, and Mantid::API::SpectrumInfo::spectrumDefinition().

Referenced by Mantid::Crystal::FindSXPeaksHelper::AllPeaksStrategy::convertToSXPeaks(), and Mantid::Crystal::FindSXPeaksHelper::StrongestPeaksStrategy::dofindSXPeaks().

convertToTOF()

double Mantid::Crystal::FindSXPeaksHelper::PeakFindingStrategy::convertToTOF ( const double  xValue, const size_t  workspaceIndex  ) const

protected

Definition at line 346 of file FindSXPeaksHelper.cpp.

References Mantid::Kernel::DeltaEMode::Elastic, Mantid::API::SpectrumInfo::getDetectorValues(), Mantid::Kernel::SingletonHolder< T >::Instance(), Mantid::API::SpectrumInfo::l1(), m_spectrumInfo, m_units, and Mantid::Crystal::FindSXPeaksHelper::TOF.

Referenced by Mantid::Crystal::FindSXPeaksHelper::AllPeaksStrategy::convertToSXPeaks(), and Mantid::Crystal::FindSXPeaksHelper::StrongestPeaksStrategy::dofindSXPeaks().

dofindSXPeaks()

virtual PeakList Mantid::Crystal::FindSXPeaksHelper::PeakFindingStrategy::dofindSXPeaks ( const HistogramData::HistogramX &  x, const HistogramData::HistogramY &  y, Bound  low, Bound  high, const int  workspaceIndex  ) const

protectedpure virtual

Implemented in Mantid::Crystal::FindSXPeaksHelper::StrongestPeaksStrategy, and Mantid::Crystal::FindSXPeaksHelper::AllPeaksStrategy.

Referenced by findSXPeaks().

findSXPeaks()

PeakList Mantid::Crystal::FindSXPeaksHelper::PeakFindingStrategy::findSXPeaks	(	const HistogramData::HistogramX &	x,
		const HistogramData::HistogramY &	y,
		const int	workspaceIndex
	)		const

Definition at line 274 of file FindSXPeaksHelper.cpp.

References dofindSXPeaks(), getBounds(), Mantid::Geometry::x, and Mantid::Geometry::y.

getBounds()

BoundsIterator Mantid::Crystal::FindSXPeaksHelper::PeakFindingStrategy::getBounds ( const HistogramData::HistogramX &  x ) const

protected

Definition at line 297 of file FindSXPeaksHelper.cpp.

References Mantid::EMPTY_DBL(), m_maxValue, m_minValue, and Mantid::Geometry::x.

Referenced by findSXPeaks().

getXValue()

double Mantid::Crystal::FindSXPeaksHelper::PeakFindingStrategy::getXValue ( const HistogramData::HistogramX &  x, const size_t  peakLocation  ) const

protected

Definition at line 339 of file FindSXPeaksHelper.cpp.

References Mantid::Geometry::x.

Referenced by Mantid::Crystal::FindSXPeaksHelper::AllPeaksStrategy::convertToSXPeaks(), and Mantid::Crystal::FindSXPeaksHelper::StrongestPeaksStrategy::dofindSXPeaks().

Member Data Documentation

m_backgroundStrategy

const BackgroundStrategy* Mantid::Crystal::FindSXPeaksHelper::PeakFindingStrategy::m_backgroundStrategy

protected

Definition at line 167 of file FindSXPeaksHelper.h.

Referenced by Mantid::Crystal::FindSXPeaksHelper::AllPeaksStrategy::AllPeaksStrategy(), Mantid::Crystal::FindSXPeaksHelper::StrongestPeaksStrategy::dofindSXPeaks(), and Mantid::Crystal::FindSXPeaksHelper::AllPeaksStrategy::dofindSXPeaks().

m_maxValue

const double Mantid::Crystal::FindSXPeaksHelper::PeakFindingStrategy::m_maxValue = EMPTY_DBL()

protected

Definition at line 169 of file FindSXPeaksHelper.h.

Referenced by getBounds().

m_minValue

const double Mantid::Crystal::FindSXPeaksHelper::PeakFindingStrategy::m_minValue = EMPTY_DBL()

protected

Definition at line 168 of file FindSXPeaksHelper.h.

Referenced by getBounds().

m_spectrumInfo

const API::SpectrumInfo& Mantid::Crystal::FindSXPeaksHelper::PeakFindingStrategy::m_spectrumInfo

protected

Definition at line 170 of file FindSXPeaksHelper.h.

Referenced by calculatePhi(), Mantid::Crystal::FindSXPeaksHelper::AllPeaksStrategy::convertToSXPeaks(), convertToTOF(), and Mantid::Crystal::FindSXPeaksHelper::StrongestPeaksStrategy::dofindSXPeaks().

m_units

const XAxisUnit Mantid::Crystal::FindSXPeaksHelper::PeakFindingStrategy::m_units

protected

Definition at line 171 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