Mantid::Algorithms::FitPeaksAlgorithm::PeakFitPreCheckResult Class Reference

#include <FitPeaks.h>

Public Member Functions
std::string	getReport () const
bool	isIndividualPeakRejected () const
PeakFitPreCheckResult &	operator+= (const PeakFitPreCheckResult &another)
	PeakFitPreCheckResult ()
void	setNumberOfIndividualPeaksWithLowCount (const size_t n)
void	setNumberOfOutOfRangePeaks (const size_t n)
void	setNumberOfPeaksWithLowSignalToNoise (const size_t n)
void	setNumberOfPeaksWithNotEnoughDataPoints (const size_t n)
void	setNumberOfSpectrumPeaksWithLowCount (const size_t n)
void	setNumberOfSubmittedIndividualPeaks (const size_t n)
void	setNumberOfSubmittedSpectrumPeaks (const size_t n)

Private Attributes
size_t	m_low_count_individual
size_t	m_low_count_spectrum
size_t	m_low_snr
size_t	m_not_enough_datapoints
size_t	m_out_of_range
size_t	m_submitted_individual_peaks
size_t	m_submitted_spectrum_peaks

Detailed Description

Definition at line 64 of file FitPeaks.h.

Constructor & Destructor Documentation

PeakFitPreCheckResult()

Mantid::Algorithms::FitPeaksAlgorithm::PeakFitPreCheckResult::PeakFitPreCheckResult ( )

inline

Definition at line 66 of file FitPeaks.h.

Member Function Documentation

getReport()

std::string Mantid::Algorithms::FitPeaksAlgorithm::PeakFitPreCheckResult::getReport

(

)

const

Definition at line 237 of file FitPeaks.cpp.

References m_low_count_individual, m_low_count_spectrum, m_low_snr, m_not_enough_datapoints, m_out_of_range, m_submitted_individual_peaks, and m_submitted_spectrum_peaks.

isIndividualPeakRejected()

bool Mantid::Algorithms::FitPeaksAlgorithm::PeakFitPreCheckResult::isIndividualPeakRejected

(

)

const

Definition at line 225 of file FitPeaks.cpp.

References m_low_count_individual, m_low_snr, m_not_enough_datapoints, m_submitted_individual_peaks, and m_submitted_spectrum_peaks.

operator+=()

PeakFitPreCheckResult & Mantid::Algorithms::FitPeaksAlgorithm::PeakFitPreCheckResult::operator+=

(

const PeakFitPreCheckResult &

another

)

Definition at line 199 of file FitPeaks.cpp.

References m_low_count_individual, m_low_count_spectrum, m_low_snr, m_not_enough_datapoints, m_out_of_range, m_submitted_individual_peaks, and m_submitted_spectrum_peaks.

setNumberOfIndividualPeaksWithLowCount()

void Mantid::Algorithms::FitPeaksAlgorithm::PeakFitPreCheckResult::setNumberOfIndividualPeaksWithLowCount

(

const size_t

n

)

Definition at line 219 of file FitPeaks.cpp.

References m_low_count_individual, and n.

setNumberOfOutOfRangePeaks()

void Mantid::Algorithms::FitPeaksAlgorithm::PeakFitPreCheckResult::setNumberOfOutOfRangePeaks

(

const size_t

n

)

Definition at line 217 of file FitPeaks.cpp.

References m_out_of_range, and n.

setNumberOfPeaksWithLowSignalToNoise()

void Mantid::Algorithms::FitPeaksAlgorithm::PeakFitPreCheckResult::setNumberOfPeaksWithLowSignalToNoise

(

const size_t

n

)

Definition at line 223 of file FitPeaks.cpp.

References m_low_snr, and n.

setNumberOfPeaksWithNotEnoughDataPoints()

void Mantid::Algorithms::FitPeaksAlgorithm::PeakFitPreCheckResult::setNumberOfPeaksWithNotEnoughDataPoints

(

const size_t

n

)

Definition at line 221 of file FitPeaks.cpp.

References m_not_enough_datapoints, and n.

setNumberOfSpectrumPeaksWithLowCount()

void Mantid::Algorithms::FitPeaksAlgorithm::PeakFitPreCheckResult::setNumberOfSpectrumPeaksWithLowCount

(

const size_t

n

)

Definition at line 215 of file FitPeaks.cpp.

References m_low_count_spectrum, and n.

setNumberOfSubmittedIndividualPeaks()

void Mantid::Algorithms::FitPeaksAlgorithm::PeakFitPreCheckResult::setNumberOfSubmittedIndividualPeaks

(

const size_t

n

)

Definition at line 213 of file FitPeaks.cpp.

References m_submitted_individual_peaks, and n.

setNumberOfSubmittedSpectrumPeaks()

void Mantid::Algorithms::FitPeaksAlgorithm::PeakFitPreCheckResult::setNumberOfSubmittedSpectrumPeaks

(

const size_t

n

)

Definition at line 211 of file FitPeaks.cpp.

References m_submitted_spectrum_peaks, and n.

Member Data Documentation

m_low_count_individual

size_t Mantid::Algorithms::FitPeaksAlgorithm::PeakFitPreCheckResult::m_low_count_individual

private

Definition at line 93 of file FitPeaks.h.

Referenced by getReport(), isIndividualPeakRejected(), operator+=(), and setNumberOfIndividualPeaksWithLowCount().

m_low_count_spectrum

size_t Mantid::Algorithms::FitPeaksAlgorithm::PeakFitPreCheckResult::m_low_count_spectrum

private

Definition at line 89 of file FitPeaks.h.

Referenced by getReport(), operator+=(), and setNumberOfSpectrumPeaksWithLowCount().

m_low_snr

size_t Mantid::Algorithms::FitPeaksAlgorithm::PeakFitPreCheckResult::m_low_snr

private

Definition at line 97 of file FitPeaks.h.

Referenced by getReport(), isIndividualPeakRejected(), operator+=(), and setNumberOfPeaksWithLowSignalToNoise().

m_not_enough_datapoints

size_t Mantid::Algorithms::FitPeaksAlgorithm::PeakFitPreCheckResult::m_not_enough_datapoints

private

Definition at line 95 of file FitPeaks.h.

Referenced by getReport(), isIndividualPeakRejected(), operator+=(), and setNumberOfPeaksWithNotEnoughDataPoints().

m_out_of_range

size_t Mantid::Algorithms::FitPeaksAlgorithm::PeakFitPreCheckResult::m_out_of_range

private

Definition at line 91 of file FitPeaks.h.

Referenced by getReport(), operator+=(), and setNumberOfOutOfRangePeaks().

m_submitted_individual_peaks

size_t Mantid::Algorithms::FitPeaksAlgorithm::PeakFitPreCheckResult::m_submitted_individual_peaks

private

Definition at line 87 of file FitPeaks.h.

Referenced by getReport(), isIndividualPeakRejected(), operator+=(), and setNumberOfSubmittedIndividualPeaks().

m_submitted_spectrum_peaks

size_t Mantid::Algorithms::FitPeaksAlgorithm::PeakFitPreCheckResult::m_submitted_spectrum_peaks

private

Definition at line 84 of file FitPeaks.h.

Referenced by getReport(), isIndividualPeakRejected(), operator+=(), and setNumberOfSubmittedSpectrumPeaks().

---

The documentation for this class was generated from the following files:

• Framework/Algorithms/inc/MantidAlgorithms/FitPeaks.h
• Framework/Algorithms/src/FitPeaks.cpp