Mantid
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Mantid::Algorithms::FitPeak Class Referencefinal

FitPeak : Fit a single peak. More...

#include <FitPeak.h>

Inheritance diagram for Mantid::Algorithms::FitPeak:
Mantid::API::Algorithm Mantid::API::IAlgorithm Mantid::Kernel::IPropertyManager

Public Member Functions

const std::string category () const override
 Algorithm's category for identification. More...
 
 FitPeak ()
 Constructor. More...
 
const std::string name () const override
 Algorithm's name. More...
 
const std::string summary () const override
 Summary of algorithms purpose. More...
 
int version () const override
 Algorithm's version. More...
 
- Public Member Functions inherited from Mantid::API::Algorithm
 Algorithm ()
 Constructor. More...
 
 Algorithm (const Algorithm &)=delete
 
Algorithmoperator= (const Algorithm &)=delete
 
 ~Algorithm () override
 Virtual destructor. More...
 
void initialize () override
 Initialization method invoked by the framework. More...
 
bool execute () override final
 The actions to be performed by the algorithm on a dataset. More...
 
void addTimer (const std::string &name, const Kernel::time_point_ns &begin, const Kernel::time_point_ns &end)
 
void executeAsChildAlg () override
 Execute as a Child Algorithm. More...
 
std::map< std::string, std::string > validateInputs () override
 Perform validation of ALL the input properties of the algorithm. More...
 
ExecutionState executionState () const override
 Gets the current execution state. More...
 
ResultState resultState () const override
 Gets the current result State. More...
 
bool isInitialized () const override
 Has the Algorithm already been initialized. More...
 
bool isExecuted () const override
 Has the Algorithm already been executed successfully. More...
 
bool isRunning () const override
 True if the algorithm is running. More...
 
bool isReadyForGarbageCollection () const override
 True if the algorithm is ready for garbage collection. More...
 
bool isChild () const override
 To query whether algorithm is a child. More...
 
void setChild (const bool isChild) override
 To set whether algorithm is a child. More...
 
void enableHistoryRecordingForChild (const bool on) override
 Change the state of the history recording flag. More...
 
bool isRecordingHistoryForChild ()
 
void setAlwaysStoreInADS (const bool doStore) override
 Do we ALWAYS store in the AnalysisDataService? This is set to true for python algorithms' child algorithms. More...
 
bool getAlwaysStoreInADS () const override
 Returns true if we always store in the AnalysisDataService. More...
 
void setRethrows (const bool rethrow) override
 Set whether the algorithm will rethrow exceptions. More...
 
Poco::ActiveResult< bool > executeAsync () override
 Asynchronous execution. More...
 
void addObserver (const Poco::AbstractObserver &observer) const override
 Add an observer for a notification. More...
 
void removeObserver (const Poco::AbstractObserver &observer) const override
 Remove an observer. More...
 
void cancel () override
 Raises the cancel flag. More...
 
bool getCancel () const
 Returns the cancellation state. More...
 
Kernel::LoggergetLogger () const
 Returns a reference to the logger. More...
 
void setLogging (const bool value) override
 Logging can be disabled by passing a value of false. More...
 
bool isLogging () const override
 returns the status of logging, True = enabled More...
 
void setLoggingOffset (const int value) override
 gets the logging priority offset More...
 
int getLoggingOffset () const override
 returns the logging priority offset More...
 
void setAlgStartupLogging (const bool enabled) override
 disable Logging of start and end messages More...
 
bool getAlgStartupLogging () const override
 get the state of Logging of start and end messages More...
 
void setChildStartProgress (const double startProgress) const override
 setting the child start progress More...
 
void setChildEndProgress (const double endProgress) const override
 setting the child end progress More...
 
std::string toString () const override
 Serialize an object to a string. More...
 
::Json::Value toJson () const override
 Serialize an object to a json object. More...
 
virtual std::shared_ptr< AlgorithmcreateChildAlgorithm (const std::string &name, const double startProgress=-1., const double endProgress=-1., const bool enableLogging=true, const int &version=-1)
 Create a Child Algorithm. More...
 
void setupAsChildAlgorithm (const Algorithm_sptr &algorithm, const double startProgress=-1., const double endProgress=-1., const bool enableLogging=true)
 Setup algorithm as child algorithm. More...
 
void trackAlgorithmHistory (std::shared_ptr< AlgorithmHistory > parentHist)
 set whether we wish to track the child algorithm's history and pass it the parent object to fill. More...
 
void findWorkspaces (WorkspaceVector &workspaces, unsigned int direction, bool checkADS=false) const
 Populate lists of the workspace properties for a given direction (InOut workspaces are included in both input/output) More...
 
virtual bool checkGroups ()
 Check the input workspace properties for groups. More...
 
virtual bool processGroups ()
 Process WorkspaceGroup inputs. More...
 
void copyNonWorkspaceProperties (IAlgorithm *alg, int periodNum)
 Copy all the non-workspace properties from this to alg. More...
 
const Parallel::Communicator & communicator () const
 Returns a const reference to the (MPI) communicator of the algorithm. More...
 
void setCommunicator (const Parallel::Communicator &communicator)
 Sets the (MPI) communicator of the algorithm. More...
 
void declareProperty (std::unique_ptr< Kernel::Property > p, const std::string &doc="") override
 Add a property to the list of managed properties. More...
 
void declareOrReplaceProperty (std::unique_ptr< Kernel::Property > p, const std::string &doc="") override
 Add or replace property in the list of managed properties. More...
 
void resetProperties () override
 Reset property values back to initial values (blank or default values) More...
 
void setProperties (const std::string &propertiesJson, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false) override
 Set the ordered list of properties by one string of values, separated by semicolons. More...
 
void setProperties (const ::Json::Value &jsonValue, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false) override
 Sets all the declared properties from a json object. More...
 
void setPropertiesWithString (const std::string &propertiesString, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >()) override
 Sets all the declared properties from a string. More...
 
void setPropertyValue (const std::string &name, const std::string &value) override
 Set the value of a property by string N.B. More...
 
void setPropertyValueFromJson (const std::string &name, const Json::Value &value) override
 Set the value of a property by Json::Value object. More...
 
void setPropertyOrdinal (const int &index, const std::string &value) override
 Set the value of a property by an index N.B. More...
 
virtual void copyPropertiesFrom (const Algorithm &alg)
 Make m_properties point to the same PropertyManager as alg.m_properties. More...
 
bool existsProperty (const std::string &name) const override
 Checks whether the named property is already in the list of managed property. More...
 
bool validateProperties () const override
 Validates all the properties in the collection. More...
 
size_t propertyCount () const override
 Count the number of properties under management. More...
 
std::string getPropertyValue (const std::string &name) const override
 Get the value of a property as a string. More...
 
const std::vector< Kernel::Property * > & getProperties () const override
 Get the list of managed properties. More...
 
std::vector< std::string > getDeclaredPropertyNames () const noexcept override
 Return the list of declared property names. More...
 
TypedValue getProperty (const std::string &name) const override
 Get the value of a property. More...
 
std::string asString (bool withDefaultValues=false) const override
 Return the property manager serialized as a string. More...
 
::Json::Value asJson (bool withDefaultValues=false) const override
 Return the property manager serialized as a json object. More...
 
bool isDefault (const std::string &name) const
 
void removeProperty (const std::string &name, const bool delproperty=true) override
 Removes the property from management. More...
 
std::unique_ptr< Kernel::PropertytakeProperty (const size_t index) override
 Removes the property from management and returns a pointer to it. More...
 
void clear () override
 Clears all properties under management. More...
 
void afterPropertySet (const std::string &) override
 Override this method to perform a custom action right after a property was set. More...
 
void filterByTime (const Types::Core::DateAndTime &, const Types::Core::DateAndTime &) override
 
void splitByTime (std::vector< Kernel::SplittingInterval > &, std::vector< Kernel::PropertyManager * >) const override
 
void filterByProperty (const Kernel::TimeSeriesProperty< bool > &, const std::vector< std::string > &) override
 
Kernel::PropertygetPointerToProperty (const std::string &name) const override
 Get a property by name. More...
 
Kernel::PropertygetPointerToPropertyOrdinal (const int &index) const override
 Get a property by an index. More...
 
virtual void declareProperty (std::unique_ptr< Property > p, const std::string &doc="")=0
 Function to declare properties (i.e. store them) More...
 
template<typename T >
void declareProperty (const std::string &name, T value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc="", const unsigned int direction=Direction::Input)
 Add a property of the template type to the list of managed properties. More...
 
template<typename T >
void declareProperty (const std::string &name, T value, const std::string &doc, const unsigned int direction=Direction::Input)
 Add a property to the list of managed properties with no validator. More...
 
template<typename T >
void declareProperty (const std::string &name, T value, const unsigned int direction)
 Add a property of the template type to the list of managed properties. More...
 
void declareProperty (const std::string &name, const char *value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc=std::string(), const unsigned int direction=Direction::Input)
 Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string). More...
 
void declareProperty (const std::string &name, const char *value, const std::string &doc, IValidator_sptr validator=std::make_shared< NullValidator >(), const unsigned int direction=Direction::Input)
 Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string). More...
 
void declareProperty (const std::string &name, const char *value, const unsigned int direction)
 Add a property of string type to the list of managed properties. More...
 
const std::string category () const override
 function to return a category of the algorithm. More...
 
const std::vector< std::string > categories () const override
 Function to return all of the categories that contain this algorithm. More...
 
const std::string categorySeparator () const override
 Function to return the separator token for the category string. More...
 
const std::vector< std::string > seeAlso () const override
 Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm.A default implementation is provided. More...
 
const std::string alias () const override
 function to return any aliases to the algorithm; A default implementation is provided More...
 
const std::string aliasDeprecated () const override
 Expiration date (in ISO8601 format) for the algorithm aliases; default implementation for no expiration date. More...
 
const std::string helpURL () const override
 function to return URL for algorithm documentation; A default implementation is provided. More...
 
template<typename T , typename = typename std::enable_if<std::is_convertible<T *, MatrixWorkspace *>::value>::type>
std::tuple< std::shared_ptr< T >, Indexing::SpectrumIndexSet > getWorkspaceAndIndices (const std::string &name) const
 
template<typename T1 , typename T2 , typename = typename std::enable_if<std::is_convertible<T1 *, MatrixWorkspace *>::value>::type, typename = typename std::enable_if<std::is_convertible<T2 *, std::string *>::value || std::is_convertible<T2 *, std::vector<int64_t> *>::value>::type>
void setWorkspaceInputProperties (const std::string &name, const std::shared_ptr< T1 > &wksp, IndexType type, const T2 &list)
 
template<typename T1 , typename T2 , typename = typename std::enable_if<std::is_convertible<T1 *, MatrixWorkspace *>::value>::type, typename = typename std::enable_if<std::is_convertible<T2 *, std::string *>::value || std::is_convertible<T2 *, std::vector<int64_t> *>::value>::type>
void setWorkspaceInputProperties (const std::string &name, const std::string &wsName, IndexType type, const T2 &list)
 
const std::string workspaceMethodName () const override
 
const std::vector< std::string > workspaceMethodOn () const override
 
const std::string workspaceMethodInputProperty () const override
 
AlgorithmID getAlgorithmID () const override
 Algorithm ID. More...
 
virtual void addObserver (const Poco::AbstractObserver &observer) const =0
 Add an observer for a notification. More...
 
virtual const std::string alias () const =0
 function to return any aliases of the algorithm. More...
 
virtual const std::string aliasDeprecated () const =0
 Expiration date (in ISO8601 format) for the algorithm aliases. Empty if no expiration date. More...
 
virtual void cancel ()=0
 Raises the cancel flag. More...
 
virtual const std::vector< std::string > categories () const =0
 Function to return all of the categories that contain this algorithm. More...
 
virtual const std::string category () const =0
 function to return a category of the algorithm. More...
 
virtual const std::string categorySeparator () const =0
 Function to return the separator token for the category string. More...
 
virtual void enableHistoryRecordingForChild (const bool on)=0
 If true history will be recorded for a child. More...
 
virtual bool execute ()=0
 System execution. More...
 
virtual void executeAsChildAlg ()=0
 Execute as a Child Algorithm, with try/catch. More...
 
virtual Poco::ActiveResult< bool > executeAsync ()=0
 Asynchronous execution of the algorithm. More...
 
virtual ExecutionState executionState () const =0
 Gets the current execution state. More...
 
virtual AlgorithmID getAlgorithmID () const =0
 Algorithm ID. More...
 
virtual bool getAlgStartupLogging () const =0
 get the state of Logging of start and end messages More...
 
virtual bool getAlwaysStoreInADS () const =0
 To query whether the output is stored in the analysis data service. More...
 
virtual int getLoggingOffset () const =0
 returns the logging priority offset More...
 
virtual const std::string helpURL () const =0
 function to return an optional URL for documentation. More...
 
virtual void initialize ()=0
 Initialization method invoked by the framework. More...
 
virtual bool isChild () const =0
 To query whether algorithm is a child. Default to false. More...
 
virtual bool isExecuted () const =0
 Check whether the algorithm has been executed sucessfully. More...
 
virtual bool isInitialized () const =0
 Check whether the algorithm is initialized properly. More...
 
virtual bool isLogging () const =0
 returns the status of logging, True = enabled More...
 
virtual bool isReadyForGarbageCollection () const =0
 True if the algorithm is ready for garbage collection. More...
 
virtual bool isRunning () const =0
 True if the algorithm is running. More...
 
virtual const std::string name () const =0
 function to return a name of the algorithm, must be overridden in all algorithms More...
 
virtual void removeObserver (const Poco::AbstractObserver &observer) const =0
 Remove an observer. More...
 
virtual ResultState resultState () const =0
 Gets the currnet result State. More...
 
virtual const std::vector< std::string > seeAlso () const =0
 Function to return all of the seeAlso algorithms related to this algorithm. More...
 
virtual void setAlgStartupLogging (const bool enabled)=0
 disable Logging of start and end messages More...
 
virtual void setAlwaysStoreInADS (const bool doStore)=0
 Set whether we always store the output in the analysis data service. More...
 
virtual void setChild (const bool isChild)=0
 To set whether algorithm is a child. More...
 
virtual void setChildEndProgress (const double endProgress) const =0
 setting the child end progress More...
 
virtual void setChildStartProgress (const double startProgress) const =0
 setting the child start progress More...
 
virtual void setLogging (const bool value)=0
 Logging can be disabled by passing a value of false. More...
 
virtual void setLoggingOffset (const int value)=0
 gets the logging priority offset More...
 
virtual void setRethrows (const bool rethrow)=0
 To query whether an algorithm should rethrow exceptions when executing. More...
 
virtual const std::string summary () const =0
 function returns a summary message that will be displayed in the default GUI, and in the help. More...
 
virtual ::Json::Value toJson () const =0
 Serialize an algorithm as Json. More...
 
virtual std::string toString () const =0
 Serialize an algorithm. More...
 
virtual std::map< std::string, std::string > validateInputs ()=0
 Method checking errors on ALL the inputs, before execution. More...
 
virtual int version () const =0
 function to return a version of the algorithm, must be overridden in all algorithms More...
 
Algorithms As Methods
- Public Member Functions inherited from Mantid::Kernel::IPropertyManager
virtual ::Json::Value asJson (bool withDefaultValues=false) const =0
 Return the property manager serialized as a json object. More...
 
virtual std::string asString (bool withDefaultValues=false) const =0
 Return the property manager serialized as a string. More...
 
virtual void declareOrReplaceProperty (std::unique_ptr< Property > p, const std::string &doc="")=0
 Function to declare properties (i.e. store them) More...
 
void declareProperty (const std::string &name, const char *value, const std::string &doc, IValidator_sptr validator=std::make_shared< NullValidator >(), const unsigned int direction=Direction::Input)
 Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string). More...
 
void declareProperty (const std::string &name, const char *value, const unsigned int direction)
 Add a property of string type to the list of managed properties. More...
 
void declareProperty (const std::string &name, const char *value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc=std::string(), const unsigned int direction=Direction::Input)
 Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string). More...
 
template<typename T >
void declareProperty (const std::string &name, T value, const std::string &doc, const unsigned int direction=Direction::Input)
 Add a property to the list of managed properties with no validator. More...
 
template<typename T >
void declareProperty (const std::string &name, T value, const unsigned int direction)
 Add a property of the template type to the list of managed properties. More...
 
template<typename T >
void declareProperty (const std::string &name, T value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc="", const unsigned int direction=Direction::Input)
 Add a property of the template type to the list of managed properties. More...
 
virtual void declareProperty (std::unique_ptr< Property > p, const std::string &doc="")=0
 Function to declare properties (i.e. store them) More...
 
virtual bool existsProperty (const std::string &name) const =0
 Checks whether the named property is already in the list of managed property. More...
 
virtual void filterByProperty (const TimeSeriesProperty< bool > &, const std::vector< std::string > &)=0
 
virtual void filterByTime (const Types::Core::DateAndTime &, const Types::Core::DateAndTime &)=0
 
virtual std::vector< std::string > getDeclaredPropertyNames () const noexcept=0
 Get the list of managed property names. More...
 
virtual PropertygetPointerToProperty (const std::string &name) const =0
 Get a pointer to property by name. More...
 
virtual const std::vector< Property * > & getProperties () const =0
 Get the list of managed properties. More...
 
std::vector< Property * > getPropertiesInGroup (const std::string &group) const
 Get the list of managed properties in a given group. More...
 
virtual TypedValue getProperty (const std::string &name) const =0
 Get the value of a property. More...
 
virtual std::string getPropertyValue (const std::string &name) const =0
 Get the value of a property as a string. More...
 
virtual size_t propertyCount () const =0
 Returns the number of properties under management. More...
 
virtual void removeProperty (const std::string &name, const bool delproperty=true)=0
 Removes the property from management. More...
 
virtual void resetProperties ()=0
 
virtual void setProperties (const ::Json::Value &jsonValue, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false)=0
 Sets all the properties from a json object. More...
 
virtual void setProperties (const std::string &propertiesJson, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false)=0
 Sets all properties from a string. More...
 
virtual void setPropertiesWithString (const std::string &propertiesString, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >())=0
 Sets all the declared properties from a string. More...
 
IPropertyManagersetProperty (const std::string &name, const char *value)
 Specialised version of setProperty template method to handle const char *. More...
 
IPropertyManagersetProperty (const std::string &name, const std::string &value)
 Specialised version of setProperty template method to handle std::string. More...
 
template<typename T >
IPropertyManagersetProperty (const std::string &name, const T &value)
 Templated method to set the value of a PropertyWithValue. More...
 
template<typename T >
IPropertyManagersetProperty (const std::string &name, std::unique_ptr< T > value)
 Templated method to set the value of a PropertyWithValue from a std::unique_ptr. More...
 
void setPropertyGroup (const std::string &name, const std::string &group)
 Set the group for a given property. More...
 
virtual void setPropertyOrdinal (const int &index, const std::string &value)=0
 Set the value of a property by an index. More...
 
void setPropertySettings (const std::string &name, std::unique_ptr< IPropertySettings > settings)
 
virtual void setPropertyValue (const std::string &name, const std::string &value)=0
 Sets property value from a string. More...
 
virtual void setPropertyValueFromJson (const std::string &name, const Json::Value &value)=0
 Sets property value from a Json::Value. More...
 
virtual void splitByTime (std::vector< SplittingInterval > &, std::vector< PropertyManager * >) const =0
 
virtual std::unique_ptr< PropertytakeProperty (const size_t index)=0
 Removes the property from management and returns a pointer to it. More...
 
void updatePropertyValues (const IPropertyManager &other)
 Update values of the existing properties. More...
 
virtual bool validateProperties () const =0
 Validates all the properties in the collection. More...
 
virtual ~IPropertyManager ()=default
 

Private Member Functions

std::vector< std::string > addFunctionParameterNames (const std::vector< std::string > &funcnames)
 Add function's parameter names after peak function name. More...
 
double checkFittedPeak (API::IPeakFunction_sptr peakfunc, double costfuncvalue, std::string &errorreason)
 Check the fitted peak value to see whether it is valud. More...
 
void createFunctions ()
 Create functions. More...
 
double estimatePeakHeight (API::IPeakFunction_sptr peakfunc, API::MatrixWorkspace_sptr dataws, size_t wsindex, size_t ixmin, size_t ixmax)
 Estimate the peak height from a set of data containing pure peaks. More...
 
void exec () override
 Declare properties. More...
 
API::IBackgroundFunction_sptr fitBackground (API::IBackgroundFunction_sptr bkgdfunc)
 Fit background with multiple domain. More...
 
double fitCompositeFunction (API::IPeakFunction_sptr peakfunc, API::IBackgroundFunction_sptr bkgdfunc, API::MatrixWorkspace_sptr dataws, size_t wsindex, double startx, double endx)
 Fit peak and background composite function. More...
 
double fitFunctionMD (API::IFunction_sptr fitfunc, API::MatrixWorkspace_sptr dataws, size_t wsindex, std::vector< double > vec_xmin, std::vector< double > vec_xmax)
 Fit a function in multi-domain. More...
 
double fitFunctionSD (API::IFunction_sptr fitfunc, API::MatrixWorkspace_sptr dataws, size_t wsindex, double xmin, double xmax, bool calmode)
 Fit a function. More...
 
double fitPeakFunction (API::IPeakFunction_sptr peakfunc, API::MatrixWorkspace_sptr dataws, size_t wsindex, double startx, double endx)
 Fit a single peak function with pure peak workspace. More...
 
DataObjects::TableWorkspace_sptr genOutputTableWS (const API::IPeakFunction_sptr &peakfunc, std::map< std::string, double > peakerrormap, const API::IBackgroundFunction_sptr &bkgdfunc, std::map< std::string, double > bkgderrormap)
 Generate table workspace. More...
 
API::MatrixWorkspace_sptr genPurePeakWS ()
 Backup data. More...
 
void init () override
 Declare properties. More...
 
void makePurePeakWS (API::MatrixWorkspace_sptr purePeakWS)
 Make a pure peak WS in the fit window region. More...
 
std::string parseFunctionTypeFull (const std::string &fullstring, bool &defaultparorder)
 Parse peak type from full peak type/parameter names string. More...
 
void pop (const std::map< std::string, double > &funcparammap, API::IFunction_sptr func)
 Pop. More...
 
void prescreenInputData ()
 Check the input properties and functions. More...
 
void processNStoreFitResult (double rwp, bool storebkgd)
 Process and store fit result. More...
 
void processProperties ()
 Process input propeties. More...
 
void setupGuessedFWHM (std::vector< double > &vec_FWHM)
 Set up a vector of guessed FWHM. More...
 
void setupOutput (const std::map< std::string, double > &m_fitErrorPeakFunc, const std::map< std::string, double > &m_fitErrorBkgdFunc)
 Set up the output workspaces. More...
 

Private Attributes

size_t i_maxFitX
 Vector index of m_maxFitX. More...
 
size_t i_maxPeakX
 Vector index of m_maxPeakX. More...
 
size_t i_minFitX
 Vector index of m_minFitX. More...
 
size_t i_minPeakX
 Vector index of m_minPeakX. More...
 
std::map< std::string, double > m_bestBkgdFunc
 Best background function. More...
 
std::map< std::string, double > m_bestPeakFunc
 Best fitted peak function. More...
 
double m_bestRwp
 Best Rwp ... More...
 
API::IBackgroundFunction_sptr m_bkgdFunc
 Background function. More...
 
std::vector< std::string > m_bkgdParameterNames
 Background. More...
 
DataObjects::TableWorkspace_sptr m_bkgdParameterTableWS
 
std::map< std::string, double > m_bkupBkgdFunc
 Storage map for background function. More...
 
std::map< std::string, double > m_bkupPeakFunc
 Storage map for peak function. More...
 
std::string m_costFunction
 
API::MatrixWorkspace_sptr m_dataWS
 Input data workspace. More...
 
double m_finalGoodnessValue
 Final. More...
 
bool m_fitBkgdFirst
 fitting strategy More...
 
bool m_fitWithStepPeakWidth
 Flag about guessed FWHM (pixels) More...
 
int m_fwhmFitStep
 Step width of tried FWHM. More...
 
bool m_lightWeightOutput
 Fitting result. More...
 
double m_maxFitX
 Maximum fit position. More...
 
int m_maxGuessedPeakWidth
 Maximum guessed peak width (pixels) More...
 
double m_maxPeakX
 Maximum peak position. More...
 
double m_minFitX
 Minimum fit position. More...
 
int m_minGuessedPeakWidth
 Minimum guessed peak width (pixels) More...
 
std::string m_minimizer
 Minimizer. More...
 
double m_minPeakX
 Minimum peak position. More...
 
bool m_outputRawParams
 output option More...
 
API::IPeakFunction_sptr m_peakFunc
 Peak function. More...
 
std::vector< std::string > m_peakParameterNames
 Peak. More...
 
DataObjects::TableWorkspace_sptr m_peakParameterTableWS
 
double m_peakPositionTolerance
 Tolerance on peak positions as criteria. More...
 
bool m_usePeakPositionTolerance
 Use peak position tolerance as a criterial for peak fit. More...
 
double m_userGuessedFWHM
 User guessed FWHM. More...
 
double m_userPeakCentre
 User guessed peak centre. More...
 
std::vector< double > m_vecebkup
 
std::vector< double > m_vecybkup
 Backups. More...
 
size_t m_wsIndex
 

Additional Inherited Members

- Public Types inherited from Mantid::API::Algorithm
using WorkspaceVector = std::vector< std::shared_ptr< Workspace > >
 
- Static Public Member Functions inherited from Mantid::API::Algorithm
static IAlgorithm_sptr fromString (const std::string &input)
 De-serialize an object from a string. More...
 
static IAlgorithm_sptr fromJson (const Json::Value &input)
 De-serialize an object from a Json. More...
 
static IAlgorithm_sptr fromHistory (const AlgorithmHistory &history)
 Construct an object from a history entry. More...
 
- Public Attributes inherited from Mantid::API::Algorithm
bool calledByAlias = false
 Flag to indicate if the algorithm is called by its alias. More...
 
- Protected Member Functions inherited from Mantid::API::Algorithm
void exec (Parallel::ExecutionMode executionMode)
 Runs the algorithm with the specified execution mode. More...
 
virtual void execDistributed ()
 Runs the algorithm in distributed execution mode. More...
 
virtual void execMasterOnly ()
 Runs the algorithm in master-only execution mode. More...
 
virtual Parallel::ExecutionMode getParallelExecutionMode (const std::map< std::string, Parallel::StorageMode > &storageModes) const
 Get correct execution mode based on input storage modes for an MPI run. More...
 
virtual const std::string workspaceMethodOnTypes () const
 Returns a semi-colon separated list of workspace types to attach this algorithm. More...
 
void cacheWorkspaceProperties ()
 Go through the properties and cache the input/output workspace properties for later use. More...
 
void cacheInputWorkspaceHistories ()
 Cache the histories of any input workspaces so they can be copied over after algorithm completion. More...
 
void setExecutionState (const ExecutionState state)
 Sets the current execution state. More...
 
void setResultState (const ResultState state)
 Sets the result execution state. More...
 
void store ()
 Stores any output workspaces into the AnalysisDataService. More...
 
void progress (double p, const std::string &msg="", double estimatedTime=0.0, int progressPrecision=0)
 Sends ProgressNotification. More...
 
void interruption_point ()
 This is called during long-running operations, and check if the algorithm has requested that it be cancelled. More...
 
Poco::NotificationCenter & notificationCenter () const
 Return a reference to the algorithm's notification dispatcher. More...
 
void handleChildProgressNotification (const Poco::AutoPtr< ProgressNotification > &pNf)
 Observation slot for child algorithm progress notification messages, these are scaled and then signalled for this algorithm. More...
 
const Poco::AbstractObserver & progressObserver () const
 Return a reference to the algorithm's object that is reporting progress. More...
 
bool isWorkspaceProperty (const Kernel::Property *const prop) const
 checks the property is a workspace property More...
 
bool trackingHistory ()
 get whether we are tracking the history for this algorithm, More...
 
virtual void fillHistory ()
 Copy workspace history for input workspaces to output workspaces and record the history for ths algorithm. More...
 
virtual void setOtherProperties (IAlgorithm *alg, const std::string &propertyName, const std::string &propertyValue, int periodNum)
 Virtual method to set the non workspace properties for this algorithm. More...
 
template<typename T , const int AllowedIndexTypes = static_cast<int>(IndexType::WorkspaceIndex), typename... WSPropArgs, typename = typename std::enable_if<std::is_convertible<T *, MatrixWorkspace *>::value>::type>
void declareWorkspaceInputProperties (const std::string &propertyName, const std::string &doc, WSPropArgs &&...wsPropArgs)
 
- Protected Member Functions inherited from Mantid::Kernel::IPropertyManager
virtual void afterPropertySet (const std::string &)
 Override this method to perform a custom action right after a property was set. More...
 
virtual void clear ()=0
 Clears all properties under management. More...
 
virtual PropertygetPointerToPropertyOrdinal (const int &index) const =0
 Get a property by an index. More...
 
template<typename T >
getValue (const std::string &name) const
 Templated method to get the value of a property. More...
 
template<>
MANTID_KERNEL_DLL PropertyManager_sptr getValue (const std::string &name) const
 
template<>
MANTID_KERNEL_DLL PropertyManager_const_sptr getValue (const std::string &name) const
 
- Static Protected Member Functions inherited from Mantid::API::Algorithm
template<typename NumT >
static bool isEmpty (const NumT toCheck)
 checks that the value was not set by users, uses the value in empty double/int. More...
 
- Protected Attributes inherited from Mantid::API::Algorithm
std::atomic< bool > m_cancel
 Set to true to stop execution. More...
 
std::atomic< bool > m_parallelException
 Set if an exception is thrown, and not caught, within a parallel region. More...
 
std::vector< IWorkspaceProperty * > m_inputWorkspaceProps
 All the WorkspaceProperties that are Input or InOut. Set in execute() More...
 
std::shared_ptr< AlgorithmHistorym_history
 Pointer to the history for the algorithm being executed. More...
 
Kernel::Logger m_log
 Logger for this algorithm. More...
 
Kernel::Loggerg_log
 
std::shared_ptr< AlgorithmHistorym_parentHistory
 Pointer to the parent history object (if set) More...
 
std::vector< WorkspaceVectorm_unrolledInputWorkspaces
 One vector of workspaces for each input workspace property. More...
 
size_t m_groupSize
 Size of the group(s) being processed. More...
 
bool m_usingBaseProcessGroups = false
 distinguish between base processGroups() and overriden/algorithm specific versions More...
 
- Static Protected Attributes inherited from Mantid::API::Algorithm
static size_t g_execCount = 0
 Counter to keep track of algorithm execution order. More...
 

Detailed Description

FitPeak : Fit a single peak.

Definition at line 218 of file FitPeak.h.

Constructor & Destructor Documentation

◆ FitPeak()

Mantid::Algorithms::FitPeak::FitPeak ( )

Constructor.

Definition at line 1002 of file FitPeak.cpp.

Member Function Documentation

◆ addFunctionParameterNames()

std::vector< std::string > Mantid::Algorithms::FitPeak::addFunctionParameterNames ( const std::vector< std::string > &  funcnames)
private

Add function's parameter names after peak function name.

Definition at line 1153 of file FitPeak.cpp.

References Mantid::Kernel::SingletonHolder< T >::Instance().

Referenced by init().

◆ category()

const std::string Mantid::Algorithms::FitPeak::category ( ) const
inlineoverridevirtual

Algorithm's category for identification.

Implements Mantid::API::IAlgorithm.

Definition at line 229 of file FitPeak.h.

◆ checkFittedPeak()

double Mantid::Algorithms::FitPeak::checkFittedPeak ( API::IPeakFunction_sptr  peakfunc,
double  costfuncvalue,
std::string &  errorreason 
)
private

Check the fitted peak value to see whether it is valud.

◆ createFunctions()

void Mantid::Algorithms::FitPeak::createFunctions ( )
private

◆ estimatePeakHeight()

double Mantid::Algorithms::FitPeak::estimatePeakHeight ( API::IPeakFunction_sptr  peakfunc,
API::MatrixWorkspace_sptr  dataws,
size_t  wsindex,
size_t  ixmin,
size_t  ixmax 
)
private

Estimate the peak height from a set of data containing pure peaks.

◆ exec()

void Mantid::Algorithms::FitPeak::exec ( )
overrideprivatevirtual

◆ fitBackground()

API::IBackgroundFunction_sptr Mantid::Algorithms::FitPeak::fitBackground ( API::IBackgroundFunction_sptr  bkgdfunc)
private

Fit background with multiple domain.

◆ fitCompositeFunction()

double Mantid::Algorithms::FitPeak::fitCompositeFunction ( API::IPeakFunction_sptr  peakfunc,
API::IBackgroundFunction_sptr  bkgdfunc,
API::MatrixWorkspace_sptr  dataws,
size_t  wsindex,
double  startx,
double  endx 
)
private

Fit peak and background composite function.

◆ fitFunctionMD()

double Mantid::Algorithms::FitPeak::fitFunctionMD ( API::IFunction_sptr  fitfunc,
API::MatrixWorkspace_sptr  dataws,
size_t  wsindex,
std::vector< double >  vec_xmin,
std::vector< double >  vec_xmax 
)
private

Fit a function in multi-domain.

◆ fitFunctionSD()

double Mantid::Algorithms::FitPeak::fitFunctionSD ( API::IFunction_sptr  fitfunc,
API::MatrixWorkspace_sptr  dataws,
size_t  wsindex,
double  xmin,
double  xmax,
bool  calmode 
)
private

Fit a function.

◆ fitPeakFunction()

double Mantid::Algorithms::FitPeak::fitPeakFunction ( API::IPeakFunction_sptr  peakfunc,
API::MatrixWorkspace_sptr  dataws,
size_t  wsindex,
double  startx,
double  endx 
)
private

Fit a single peak function with pure peak workspace.

◆ genOutputTableWS()

TableWorkspace_sptr Mantid::Algorithms::FitPeak::genOutputTableWS ( const API::IPeakFunction_sptr peakfunc,
std::map< std::string, double >  peakerrormap,
const API::IBackgroundFunction_sptr bkgdfunc,
std::map< std::string, double >  bkgderrormap 
)
private

Generate table workspace.

Definition at line 1501 of file FitPeak.cpp.

References error, Mantid::API::Algorithm::getProperty(), m_finalGoodnessValue, and m_outputRawParams.

Referenced by setupOutput().

◆ genPurePeakWS()

API::MatrixWorkspace_sptr Mantid::Algorithms::FitPeak::genPurePeakWS ( )
private

Backup data.

◆ init()

void Mantid::Algorithms::FitPeak::init ( )
overrideprivatevirtual

◆ makePurePeakWS()

void Mantid::Algorithms::FitPeak::makePurePeakWS ( API::MatrixWorkspace_sptr  purePeakWS)
private

Make a pure peak WS in the fit window region.

◆ name()

const std::string Mantid::Algorithms::FitPeak::name ( ) const
inlineoverridevirtual

Algorithm's name.

Implements Mantid::API::Algorithm.

Definition at line 223 of file FitPeak.h.

◆ parseFunctionTypeFull()

std::string Mantid::Algorithms::FitPeak::parseFunctionTypeFull ( const std::string &  fullstring,
bool &  defaultparorder 
)
private

Parse peak type from full peak type/parameter names string.

Definition at line 1367 of file FitPeak.cpp.

References n.

Referenced by createFunctions().

◆ pop()

void Mantid::Algorithms::FitPeak::pop ( const std::map< std::string, double > &  funcparammap,
API::IFunction_sptr  func 
)
private

Pop.

◆ prescreenInputData()

void Mantid::Algorithms::FitPeak::prescreenInputData ( )
private

Check the input properties and functions.

Check input data and get some information parameters.

Definition at line 1386 of file FitPeak.cpp.

References m_bkgdFunc, m_maxFitX, m_minFitX, m_peakFunc, m_userGuessedFWHM, and m_userPeakCentre.

Referenced by exec().

◆ processNStoreFitResult()

void Mantid::Algorithms::FitPeak::processNStoreFitResult ( double  rwp,
bool  storebkgd 
)
private

Process and store fit result.

◆ processProperties()

void Mantid::Algorithms::FitPeak::processProperties ( )
private

◆ setupGuessedFWHM()

void Mantid::Algorithms::FitPeak::setupGuessedFWHM ( std::vector< double > &  vec_FWHM)
private

Set up a vector of guessed FWHM.

◆ setupOutput()

void Mantid::Algorithms::FitPeak::setupOutput ( const std::map< std::string, double > &  m_fitErrorPeakFunc,
const std::map< std::string, double > &  m_fitErrorBkgdFunc 
)
private

◆ summary()

const std::string Mantid::Algorithms::FitPeak::summary ( ) const
inlineoverridevirtual

Summary of algorithms purpose.

Implements Mantid::API::Algorithm.

Definition at line 225 of file FitPeak.h.

◆ version()

int Mantid::Algorithms::FitPeak::version ( ) const
inlineoverridevirtual

Algorithm's version.

Implements Mantid::API::Algorithm.

Definition at line 227 of file FitPeak.h.

Member Data Documentation

◆ i_maxFitX

size_t Mantid::Algorithms::FitPeak::i_maxFitX
private

Vector index of m_maxFitX.

Definition at line 321 of file FitPeak.h.

Referenced by setupOutput().

◆ i_maxPeakX

size_t Mantid::Algorithms::FitPeak::i_maxPeakX
private

Vector index of m_maxPeakX.

Definition at line 325 of file FitPeak.h.

◆ i_minFitX

size_t Mantid::Algorithms::FitPeak::i_minFitX
private

Vector index of m_minFitX.

Definition at line 319 of file FitPeak.h.

Referenced by setupOutput().

◆ i_minPeakX

size_t Mantid::Algorithms::FitPeak::i_minPeakX
private

Vector index of m_minPeakX.

Definition at line 323 of file FitPeak.h.

◆ m_bestBkgdFunc

std::map<std::string, double> Mantid::Algorithms::FitPeak::m_bestBkgdFunc
private

Best background function.

Definition at line 370 of file FitPeak.h.

◆ m_bestPeakFunc

std::map<std::string, double> Mantid::Algorithms::FitPeak::m_bestPeakFunc
private

Best fitted peak function.

Definition at line 368 of file FitPeak.h.

◆ m_bestRwp

double Mantid::Algorithms::FitPeak::m_bestRwp
private

Best Rwp ...

Definition at line 372 of file FitPeak.h.

◆ m_bkgdFunc

API::IBackgroundFunction_sptr Mantid::Algorithms::FitPeak::m_bkgdFunc
private

Background function.

Definition at line 308 of file FitPeak.h.

Referenced by createFunctions(), exec(), prescreenInputData(), and setupOutput().

◆ m_bkgdParameterNames

std::vector<std::string> Mantid::Algorithms::FitPeak::m_bkgdParameterNames
private

Background.

Definition at line 358 of file FitPeak.h.

Referenced by createFunctions(), and setupOutput().

◆ m_bkgdParameterTableWS

DataObjects::TableWorkspace_sptr Mantid::Algorithms::FitPeak::m_bkgdParameterTableWS
private

Definition at line 353 of file FitPeak.h.

◆ m_bkupBkgdFunc

std::map<std::string, double> Mantid::Algorithms::FitPeak::m_bkupBkgdFunc
private

Storage map for background function.

Definition at line 364 of file FitPeak.h.

◆ m_bkupPeakFunc

std::map<std::string, double> Mantid::Algorithms::FitPeak::m_bkupPeakFunc
private

Storage map for peak function.

Definition at line 366 of file FitPeak.h.

◆ m_costFunction

std::string Mantid::Algorithms::FitPeak::m_costFunction
private

Definition at line 381 of file FitPeak.h.

Referenced by exec(), and processProperties().

◆ m_dataWS

API::MatrixWorkspace_sptr Mantid::Algorithms::FitPeak::m_dataWS
private

Input data workspace.

Definition at line 302 of file FitPeak.h.

Referenced by exec(), processProperties(), and setupOutput().

◆ m_finalGoodnessValue

double Mantid::Algorithms::FitPeak::m_finalGoodnessValue
private

Final.

Definition at line 375 of file FitPeak.h.

Referenced by exec(), genOutputTableWS(), and setupOutput().

◆ m_fitBkgdFirst

bool Mantid::Algorithms::FitPeak::m_fitBkgdFirst
private

fitting strategy

Definition at line 328 of file FitPeak.h.

Referenced by exec(), and processProperties().

◆ m_fitWithStepPeakWidth

bool Mantid::Algorithms::FitPeak::m_fitWithStepPeakWidth
private

Flag about guessed FWHM (pixels)

Definition at line 345 of file FitPeak.h.

Referenced by exec(), and processProperties().

◆ m_fwhmFitStep

int Mantid::Algorithms::FitPeak::m_fwhmFitStep
private

Step width of tried FWHM.

Definition at line 343 of file FitPeak.h.

Referenced by exec(), and processProperties().

◆ m_lightWeightOutput

bool Mantid::Algorithms::FitPeak::m_lightWeightOutput
private

Fitting result.

Option on output

Definition at line 388 of file FitPeak.h.

◆ m_maxFitX

double Mantid::Algorithms::FitPeak::m_maxFitX
private

Maximum fit position.

Definition at line 312 of file FitPeak.h.

Referenced by exec(), prescreenInputData(), processProperties(), and setupOutput().

◆ m_maxGuessedPeakWidth

int Mantid::Algorithms::FitPeak::m_maxGuessedPeakWidth
private

Maximum guessed peak width (pixels)

Definition at line 341 of file FitPeak.h.

Referenced by exec(), and processProperties().

◆ m_maxPeakX

double Mantid::Algorithms::FitPeak::m_maxPeakX
private

Maximum peak position.

Definition at line 316 of file FitPeak.h.

Referenced by exec(), and processProperties().

◆ m_minFitX

double Mantid::Algorithms::FitPeak::m_minFitX
private

Minimum fit position.

Definition at line 310 of file FitPeak.h.

Referenced by exec(), prescreenInputData(), processProperties(), and setupOutput().

◆ m_minGuessedPeakWidth

int Mantid::Algorithms::FitPeak::m_minGuessedPeakWidth
private

Minimum guessed peak width (pixels)

Definition at line 339 of file FitPeak.h.

Referenced by exec(), and processProperties().

◆ m_minimizer

std::string Mantid::Algorithms::FitPeak::m_minimizer
private

Minimizer.

Definition at line 361 of file FitPeak.h.

Referenced by exec(), and processProperties().

◆ m_minPeakX

double Mantid::Algorithms::FitPeak::m_minPeakX
private

Minimum peak position.

Definition at line 314 of file FitPeak.h.

Referenced by exec(), and processProperties().

◆ m_outputRawParams

bool Mantid::Algorithms::FitPeak::m_outputRawParams
private

output option

Definition at line 331 of file FitPeak.h.

Referenced by genOutputTableWS(), and processProperties().

◆ m_peakFunc

API::IPeakFunction_sptr Mantid::Algorithms::FitPeak::m_peakFunc
private

Peak function.

Definition at line 306 of file FitPeak.h.

Referenced by createFunctions(), exec(), prescreenInputData(), and setupOutput().

◆ m_peakParameterNames

std::vector<std::string> Mantid::Algorithms::FitPeak::m_peakParameterNames
private

Peak.

Definition at line 356 of file FitPeak.h.

Referenced by createFunctions(), and setupOutput().

◆ m_peakParameterTableWS

DataObjects::TableWorkspace_sptr Mantid::Algorithms::FitPeak::m_peakParameterTableWS
private

Definition at line 352 of file FitPeak.h.

◆ m_peakPositionTolerance

double Mantid::Algorithms::FitPeak::m_peakPositionTolerance
private

Tolerance on peak positions as criteria.

Definition at line 350 of file FitPeak.h.

Referenced by exec(), and processProperties().

◆ m_usePeakPositionTolerance

bool Mantid::Algorithms::FitPeak::m_usePeakPositionTolerance
private

Use peak position tolerance as a criterial for peak fit.

Definition at line 348 of file FitPeak.h.

Referenced by exec(), and processProperties().

◆ m_userGuessedFWHM

double Mantid::Algorithms::FitPeak::m_userGuessedFWHM
private

User guessed FWHM.

Definition at line 334 of file FitPeak.h.

Referenced by prescreenInputData().

◆ m_userPeakCentre

double Mantid::Algorithms::FitPeak::m_userPeakCentre
private

User guessed peak centre.

Definition at line 336 of file FitPeak.h.

Referenced by prescreenInputData().

◆ m_vecebkup

std::vector<double> Mantid::Algorithms::FitPeak::m_vecebkup
private

Definition at line 379 of file FitPeak.h.

◆ m_vecybkup

std::vector<double> Mantid::Algorithms::FitPeak::m_vecybkup
private

Backups.

Definition at line 378 of file FitPeak.h.

◆ m_wsIndex

size_t Mantid::Algorithms::FitPeak::m_wsIndex
private

Definition at line 303 of file FitPeak.h.

Referenced by exec(), processProperties(), and setupOutput().


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