Mantid::Kernel::Smoothing Namespace Reference

Namespaces
namespace	detail
namespace	fft

Functions
MANTID_KERNEL_DLL std::vector< double >	boxcarErrorSmooth (std::span< double const > input, unsigned int const numPoints)
template MANTID_KERNEL_DLL std::vector< double >	boxcarErrorSmooth (std::vector< double > const &, unsigned int const)
template<typename T >
std::vector< T >	boxcarErrorSmooth (std::vector< T > const &input, unsigned int const numPoints)
	Performs boxcar (moving average) smoothing on the input data, using error propagation formula.
template MANTID_KERNEL_DLL std::vector< double >	boxcarRMSESmooth (std::vector< double > const &, unsigned int const)
template<typename T >
std::vector< T >	boxcarRMSESmooth (std::vector< T > const &input, unsigned int const numPoints)
	Performs boxcar (moving average) smoothing on the input data, using a RMSE average, as is appropriate for error averaging.
MANTID_KERNEL_DLL std::vector< double >	boxcarSmooth (std::span< double const > input, unsigned int const numPoints)
	Overloads taking a contiguous range of doubles, so that the size-checked histogram data types, which do not hand out a std::vector<double>, can be smoothed directly.
template MANTID_KERNEL_DLL std::vector< double >	boxcarSmooth (std::vector< double > const &, unsigned int const)
template<typename T >
std::vector< T >	boxcarSmooth (std::vector< T > const &input, unsigned int const numPoints)
	Performs boxcar (moving average) smoothing on the input data.
template MANTID_KERNEL_DLL std::vector< double >	fftButterworthSmooth (std::vector< double > const &, unsigned const, unsigned const)
template<typename Y >
std::vector< Y >	fftButterworthSmooth (std::vector< Y > const &input, unsigned const cutoff, unsigned const order)
	Performs FFT smoothing on the input data, using a Butterworth filter NOTE: the input data MUST be defined on a uniform grid.
template MANTID_KERNEL_DLL std::vector< double >	fftSmooth (std::vector< double > const &, unsigned const)
template<typename Y >
std::vector< Y >	fftSmooth (std::vector< Y > const &input, unsigned const cutoff)
	Performs FFT smoothing on the input data, with high frequencies set to zero NOTE: the input data MUST be defined on a uniform grid.

Function Documentation

boxcarErrorSmooth() [1/3]

std::vector< double > Mantid::Kernel::Smoothing::boxcarErrorSmooth	(	std::span< double const >	input,
		unsigned int const	numPoints
	)

Definition at line 166 of file Smoothing.cpp.

References Mantid::Kernel::Smoothing::detail::boxcarSmoothWithFunction().

boxcarErrorSmooth() [2/3]

template MANTID_KERNEL_DLL std::vector< double > Mantid::Kernel::Smoothing::boxcarErrorSmooth	(	std::vector< double > const &	,
		unsigned int const
	)

boxcarErrorSmooth() [3/3]

template<typename T >

std::vector< T > Mantid::Kernel::Smoothing::boxcarErrorSmooth	(	std::vector< T > const &	input,
		unsigned int const	numPoints
	)

Performs boxcar (moving average) smoothing on the input data, using error propagation formula.

This is the correct method to use for smoothing histogram errors after their y-values have been smoothed.

Parameters

input	The input vector to be smoothed
numPoints	The width of the boxcar window (must be >= 3)

Returns

A new vector containing the smoothed data

Exceptions

std::invalid_argument

if numPoints is too small

Template Parameters

T	Numeric type (e.g., int, float, double)

Definition at line 147 of file Smoothing.cpp.

Referenced by Mantid::Algorithms::smooth().

boxcarRMSESmooth() [1/2]

template MANTID_KERNEL_DLL std::vector< double > Mantid::Kernel::Smoothing::boxcarRMSESmooth	(	std::vector< double > const &	,
		unsigned int const
	)

boxcarRMSESmooth() [2/2]

template<typename T >

std::vector< T > Mantid::Kernel::Smoothing::boxcarRMSESmooth	(	std::vector< T > const &	input,
		unsigned int const	numPoints
	)

Performs boxcar (moving average) smoothing on the input data, using a RMSE average, as is appropriate for error averaging.

Parameters

input	The input vector to be smoothed
numPoints	The width of the boxcar window (must be >= 3)

Returns

A new vector containing the smoothed data

Exceptions

std::invalid_argument

if numPoints is too small

Template Parameters

T	Numeric type (e.g., int, float, double)

Definition at line 152 of file Smoothing.cpp.

boxcarSmooth() [1/3]

std::vector< double > Mantid::Kernel::Smoothing::boxcarSmooth	(	std::span< double const >	input,
		unsigned int const	numPoints
	)

Overloads taking a contiguous range of doubles, so that the size-checked histogram data types, which do not hand out a std::vector<double>, can be smoothed directly.

A std::vector<double> argument still selects the templates above; deduction cannot produce a std::span, hence these are not templates.

Parameters

input	The contiguous range to be smoothed
numPoints	The width of the boxcar window (must be >= 3)

Returns

A new vector containing the smoothed data

Exceptions

std::invalid_argument

if numPoints is too small

Definition at line 161 of file Smoothing.cpp.

References Mantid::Kernel::Smoothing::detail::boxcarSmoothWithFunction().

boxcarSmooth() [2/3]

template MANTID_KERNEL_DLL std::vector< double > Mantid::Kernel::Smoothing::boxcarSmooth	(	std::vector< double > const &	,
		unsigned int const
	)

boxcarSmooth() [3/3]

template<typename T >

std::vector< T > Mantid::Kernel::Smoothing::boxcarSmooth	(	std::vector< T > const &	input,
		unsigned int const	numPoints
	)

Performs boxcar (moving average) smoothing on the input data.

Parameters

input	The input vector to be smoothed
numPoints	The width of the boxcar window (must be >= 3)

Returns

A new vector containing the smoothed data

Exceptions

std::invalid_argument

if numPoints is too small

Template Parameters

T	Numeric type (e.g., int, float, double)

Definition at line 141 of file Smoothing.cpp.

Referenced by Mantid::Algorithms::AddLogSmoothed::exec(), and Mantid::Algorithms::smooth().

fftButterworthSmooth() [1/2]

template MANTID_KERNEL_DLL std::vector< double > Mantid::Kernel::Smoothing::fftButterworthSmooth	(	std::vector< double > const &	,
		unsigned const	,
		unsigned const
	)

fftButterworthSmooth() [2/2]

template<typename Y >

std::vector< Y > Mantid::Kernel::Smoothing::fftButterworthSmooth	(	std::vector< Y > const &	input,
		unsigned const	cutoff,
		unsigned const	order
	)

Performs FFT smoothing on the input data, using a Butterworth filter NOTE: the input data MUST be defined on a uniform grid.

Parameters

input	The input vector to be smoothed
cutoff	Represents the cutoff frequency, where step function behavior begins descent
order	Represents the steepness of the frequency cutoff; as this approaches infinity, approaches step cutoff

Returns

A new vector containing the smoothed data

Template Parameters

Y	numeric type for y-values

Definition at line 258 of file Smoothing.cpp.

References Mantid::Kernel::Smoothing::fft::fftSmoothWithFilter(), and std::to_string().

Referenced by Mantid::Algorithms::AddLogSmoothed::exec(), and Mantid::Algorithms::FFTSmooth::FFTSmooth2::exec().

fftSmooth() [1/2]

template MANTID_KERNEL_DLL std::vector< double > Mantid::Kernel::Smoothing::fftSmooth	(	std::vector< double > const &	,
		unsigned const
	)

fftSmooth() [2/2]

template<typename Y >

std::vector< Y > Mantid::Kernel::Smoothing::fftSmooth	(	std::vector< Y > const &	input,
		unsigned const	cutoff
	)

Performs FFT smoothing on the input data, with high frequencies set to zero NOTE: the input data MUST be defined on a uniform grid.

Parameters

input	The input vector to be smoothed
cutoff	The cutoff frequency; all components from this number forward will be set to zero

Returns

A new vector containing the smoothed data

Template Parameters

Y	numeric type for y-values

Definition at line 245 of file Smoothing.cpp.

References std::to_string().

Referenced by Mantid::Algorithms::AddLogSmoothed::exec(), and Mantid::Algorithms::FFTSmooth::FFTSmooth2::exec().