IPeakFunction¶

This a python binding to the C++ class Mantid::API::IPeakFunction.

bases: mantid.api.IFunction1D

class mantid.api.IPeakFunction((object)arg1)¶

__init__((object)arg1) → None¶

attributeNames((IFunction)arg1) → std_vector_str :¶

The names of all the attributes

categories((IFunction)arg1) → object :¶

Returns a list of the categories for an algorithm

category((IFunction)arg1) → str :¶

Return a semi-colon(;) separated string for the categories this class should belong to. For sub-categories use a separator

declareAttribute((IFunction)arg1, (str)arg2, (object)arg3) → None :¶

Declare an attribute with an initial value

declareParameter((IFunction)arg1, (str)arg2, (float)arg3, (str)arg4) → None :¶

Declare a fitting parameter settings its default value & description

declareParameter( (IFunction)arg1, (str)arg2, (float)arg3) -> None :

Declare a fitting parameter settings its default value

declareParameter( (IFunction)arg1, (str)arg2) -> None :

Declare a fitting parameter settings its default value to 0.0

function1D((IFunction1D)arg1, (object)arg2) → object :¶

Calculate the values of the function for the given x values and returns them

functionLocal((IPeakFunction)arg1, (object)arg2) → object :¶

Calculate the values of the function for the given x values. The output should be stored in the out array

getAttributeValue((IFunction)arg1, (str)arg2) → object :¶

Return the value of the named attribute

getCategories((IFunction)arg1) → object :¶

Returns a list of the categories for an algorithm

getParamDescr((IFunction)arg1, (int)arg2) → str :¶

Return a description of the ith parameter

getParamExplicit((IFunction)arg1, (int)arg2) → bool :¶

Return whether the ith parameter needs to be explicitely set

getParamName((IFunction)arg1, (int)arg2) → str :¶

Return the name of the ith parameter

getParamValue((IFunction)arg1, (int)arg2) → float :¶

Get the value of the ith parameter

getParameterValue((IFunction)arg1, (int)arg2) → float :¶

Get the value of the ith parameter

getParameterValue( (IFunction)arg1, (str)arg2) -> float :

Get the value of the named parameter

initialize((IFunction)arg1) → None :¶

Declares any parameters and attributes on the function

intensity((IPeakFunction)arg1) → float :¶

Returns the integral intensity of the peak function.

isExplicitlySet((IFunction)arg1, (int)arg2) → bool :¶

Return whether the ith parameter needs to be explicitely set

nAttributes((IFunction)arg1) → int :¶

Return the number of attributes (non-fitting arguments)

nParams((IFunction)arg1) → int :¶

Return the number of parameters

name((IFunction)arg1) → str :¶

Return the name of the function

numParams((IFunction)arg1) → int :¶

Return the number of parameters

paramDescription((IFunction)arg1, (int)arg2) → str :¶

Return a description of the ith parameter

parameterName((IFunction)arg1, (int)arg2) → str :¶

Return the name of the ith parameter

setIntensity((IPeakFunction)arg1, (float)arg2) → None :¶

Changes the integral intensity of the peak function by setting its height.

setParameter((IFunction)arg1, (int)arg2, (float)arg3[, (bool)arg4]) → None :¶

Sets the value of the ith parameter

setParameter( (IFunction)arg1, (str)arg2, (float)arg3 [, (bool)arg4]) -> None :

Sets the value of the named parameter