Mantid::CurveFitting::Algorithms::ConvolutionFit< Base > Class Template Reference

ConvolutionFit : Performs a QENS convolution fit. More...

#include <ConvolutionFit.h>

Inheritance diagram for Mantid::CurveFitting::Algorithms::ConvolutionFit< Base >:

Public Member Functions
const std::string	category () const override
	Algorithm's category for identification. More...
const std::string	name () const
	Algorithms name for identification. More...
const std::string	name () const
const std::string	name () const override
const std::vector< std::string >	seeAlso () const
	Algorithm's see also for related algorithms. More...
const std::vector< std::string >	seeAlso () const
const std::vector< std::string >	seeAlso () const override
const std::string	summary () const
	Algorithm's summary for use in the GUI and help. More...
const std::string	summary () const
const std::string	summary () const override
int	version () const override
	Algorithm's version for identification. More...

Protected Member Functions
std::map< std::string, std::string >	getAdditionalLogNumbers () const override
std::map< std::string, std::string >	getAdditionalLogStrings () const override
std::vector< std::string >	getFitParameterNames () const override
virtual API::ITableWorkspace_sptr	processParameterTable (API::ITableWorkspace_sptr parameterTable) override

Private Member Functions
bool	isFitParameter (const std::string &name) const override
bool	throwIfElasticQConversionFails () const override
std::map< std::string, std::string >	validateInputs () override

Private Attributes
bool	m_deltaUsed

Detailed Description

template<typename Base>
class Mantid::CurveFitting::Algorithms::ConvolutionFit< Base >

ConvolutionFit : Performs a QENS convolution fit.

Definition at line 19 of file ConvolutionFit.h.

Member Function Documentation

category()

template<typename Base >

const std::string Mantid::CurveFitting::Algorithms::ConvolutionFit< Base >::category

override

Algorithm's category for identification.

See also

Algorithm::category

Definition at line 250 of file ConvolutionFit.cpp.

getAdditionalLogNumbers()

template<typename Base >

std::map< std::string, std::string > Mantid::CurveFitting::Algorithms::ConvolutionFit< Base >::getAdditionalLogNumbers

overrideprotected

Definition at line 309 of file ConvolutionFit.cpp.

getAdditionalLogStrings()

template<typename Base >

std::map< std::string, std::string > Mantid::CurveFitting::Algorithms::ConvolutionFit< Base >::getAdditionalLogStrings

overrideprotected

Definition at line 301 of file ConvolutionFit.cpp.

getFitParameterNames()

template<typename Base >

std::vector< std::string > Mantid::CurveFitting::Algorithms::ConvolutionFit< Base >::getFitParameterNames

overrideprotected

Definition at line 316 of file ConvolutionFit.cpp.

isFitParameter()

template<typename Base >

bool Mantid::CurveFitting::Algorithms::ConvolutionFit< Base >::isFitParameter ( const std::string &  name ) const

overrideprivate

Definition at line 285 of file ConvolutionFit.cpp.

name() [1/3]

const std::string Mantid::CurveFitting::Algorithms::ConvolutionFit< QENSFitSequential >::name

(

)

const

Algorithms name for identification.

See also

Algorithm::name

Definition at line 240 of file ConvolutionFit.cpp.

name() [2/3]

const std::string Mantid::CurveFitting::Algorithms::ConvolutionFit< QENSFitSimultaneous >::name

(

)

const

Definition at line 242 of file ConvolutionFit.cpp.

name() [3/3]

template<typename Base >

const std::string Mantid::CurveFitting::Algorithms::ConvolutionFit< Base >::name

override

Definition at line 244 of file ConvolutionFit.cpp.

processParameterTable()

template<typename Base >

ITableWorkspace_sptr Mantid::CurveFitting::Algorithms::ConvolutionFit< Base >::processParameterTable ( API::ITableWorkspace_sptr  parameterTable )

overrideprotectedvirtual

Definition at line 293 of file ConvolutionFit.cpp.

seeAlso() [1/3]

const std::vector< std::string > Mantid::CurveFitting::Algorithms::ConvolutionFit< QENSFitSequential >::seeAlso

(

)

const

Algorithm's see also for related algorithms.

See also

Algorithm::seeAlso

Definition at line 266 of file ConvolutionFit.cpp.

seeAlso() [2/3]

const std::vector< std::string > Mantid::CurveFitting::Algorithms::ConvolutionFit< QENSFitSimultaneous >::seeAlso

(

)

const

Definition at line 270 of file ConvolutionFit.cpp.

seeAlso() [3/3]

template<typename Base >

const std::vector< std::string > Mantid::CurveFitting::Algorithms::ConvolutionFit< Base >::seeAlso

override

Definition at line 274 of file ConvolutionFit.cpp.

summary() [1/3]

const std::string Mantid::CurveFitting::Algorithms::ConvolutionFit< QENSFitSequential >::summary

(

)

const

Algorithm's summary for use in the GUI and help.

See also

Algorithm::summary

Definition at line 253 of file ConvolutionFit.cpp.

summary() [2/3]

const std::string Mantid::CurveFitting::Algorithms::ConvolutionFit< QENSFitSimultaneous >::summary

(

)

const

Definition at line 257 of file ConvolutionFit.cpp.

summary() [3/3]

template<typename Base >

const std::string Mantid::CurveFitting::Algorithms::ConvolutionFit< Base >::summary

override

Definition at line 261 of file ConvolutionFit.cpp.

throwIfElasticQConversionFails()

template<typename Base >

bool Mantid::CurveFitting::Algorithms::ConvolutionFit< Base >::throwIfElasticQConversionFails

overrideprivate

Definition at line 290 of file ConvolutionFit.cpp.

validateInputs()

template<typename Base >

std::map< std::string, std::string > Mantid::CurveFitting::Algorithms::ConvolutionFit< Base >::validateInputs

overrideprivate

Definition at line 276 of file ConvolutionFit.cpp.

version()

template<typename Base >

int Mantid::CurveFitting::Algorithms::ConvolutionFit< Base >::version

override

Algorithm's version for identification.

See also

Algorithm::version

Definition at line 247 of file ConvolutionFit.cpp.

Member Data Documentation

m_deltaUsed

template<typename Base >

bool Mantid::CurveFitting::Algorithms::ConvolutionFit< Base >::m_deltaUsed

private

Definition at line 37 of file ConvolutionFit.h.

---

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

• Framework/CurveFitting/inc/MantidCurveFitting/Algorithms/ConvolutionFit.h
• Framework/CurveFitting/src/Algorithms/ConvolutionFit.cpp