#include <IntegratePeakTimeSlices.h>

Inheritance diagram for Mantid::Crystal::IntegratePeakTimeSlices:

Public Member Functions
const std::string	category () const override
	Algorithm's category for identification overriding a virtual method. More...

	IntegratePeakTimeSlices ()
	Default constructor. More...

const std::string	name () const override
	Algorithm's name for identification overriding a virtual method. 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	summary () const override
	Summary of algorithms purpose. More...

int	version () const override
	Algorithm's version for identification overriding a virtual method. More...

	~IntegratePeakTimeSlices () override
	Destructor. More...

Public Member Functions inherited from Mantid::API::Algorithm
	Algorithm ()
	Constructor. More...

	Algorithm (const Algorithm &)=delete

Algorithm &	operator= (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::Logger &	getLogger () 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< Algorithm >	createChildAlgorithm (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::Property >	takeProperty (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::Property *	getPointerToProperty (const std::string &name) const override
	Get a property by name. More...

Kernel::Property *	getPointerToPropertyOrdinal (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::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::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 Property *	getPointerToProperty (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...

IPropertyManager *	setProperty (const std::string &name, const char *value)
	Specialised version of setProperty template method to handle const char *. More...

IPropertyManager *	setProperty (const std::string &name, const std::string &value)
	Specialised version of setProperty template method to handle std::string. More...

template<typename T >
IPropertyManager *	setProperty (const std::string &name, const T &value)
	Templated method to set the value of a PropertyWithValue. More...

template<typename T >
IPropertyManager *	setProperty (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< Property >	takeProperty (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::string	CalculateFunctionProperty_Fit ()
	Calculates the string for the Function Property of the Fit Algorithm. More...

double	CalculateIsawIntegrateError (const double background, const double backError, const double ChiSqOverDOF, const double TotVariance, const int ncells)
	Calculates the error in integration closest to the latest ISAW calculations. More...

double	CalculatePositionSpan (DataObjects::Peak const &peak, const double dQ)
	Calculates the span in rows and columns needed to include all data within dQ of the specified peak. More...

int	CalculateTimeChannelSpan (Geometry::IPeak const &peak, const double dQ, const Mantid::HistogramData::HistogramX &X, const int specNum, int &Centerchan)
	Calculates the span of channels needed to encompass all data around the peak with Q values within dQ of this peak's Q value. More...

void	exec () override
	Executes this algorithm. More...

int	findNameInVector (std::string const &oneName, std::vector< std::string > const &nameList)
	Utility to find a name in a vector of strings. More...

void	FindPlane (Kernel::V3D &center, Kernel::V3D &xvec, Kernel::V3D &yvec, double &ROW, double &COL, int &NROWS, int &NCOLS, double &pixWidthx, double &pixHeighty, DataObjects::Peak const &peak) const
	For NonFlat banks, this determines the data of a small planar region approximating the instrument close to the peak. More...

int	findTimeChannel (const Mantid::HistogramData::HistogramX &X, const double time)
	Finds the time channel with the given time in. More...

void	Fit (API::MatrixWorkspace_sptr &Data, double &chisqOverDOF, bool &done, std::vector< std::string > &names, std::vector< double > &params, std::vector< double > &errs, double lastRow, double lastCol, double neighborRadius)
	Sets up data for the Fit Algorithm call and invokes it. More...

bool	getNeighborPixIDs (const std::shared_ptr< Geometry::IComponent > &comp, const Kernel::V3D &Center, double &Radius, int *&ArryofID)
	Finds all neighbors within a given Radius of the Center on the given component. More...

void	init () override
	Virtual method - must be overridden by concrete algorithm. More...

void	InitializeColumnNamesInTableWorkspace (DataObjects::TableWorkspace_sptr &TabWS)
	Initializes the column names in the output table workspace. More...

bool	isGoodFit (std::vector< double > const &params, std::vector< double > const &errs, std::vector< std::string > const &names, double chisqOverDOF)
	Determines if the list of parameters and errors represent a "good" fit. More...

void	PreFit (API::MatrixWorkspace_sptr &Data, double &chisqOverDOF, bool &done, std::vector< std::string > &names, std::vector< double > &params, std::vector< double > &errs, double lastRow, double lastCol, double neighborRadius)
	Tests several starting points in the Marquardt algorithm then calls Fit. More...

void	SetUpData (API::MatrixWorkspace_sptr &Data, API::MatrixWorkspace_const_sptr const &inpWkSpace, const std::shared_ptr< Geometry::IComponent > &comp, const int chanMin, const int chanMax, double CentX, double CentY, Kernel::V3D &CentNghbr, double &neighborRadius, double Radius, std::string &spec_idList)
	Initial phase at converting Detector data to workspace data that will be sent to the Fit Function, BivariateNormal. More...

void	SetUpData1 (API::MatrixWorkspace_sptr &Data, API::MatrixWorkspace_const_sptr const &inpWkSpace, const int chanMin, const int chanMax, double Radius, const Kernel::V3D &CentPos, std::string &spec_idList)
	Prepares the data for futher analysis adding meta data and marking data on the edges of detectors. More...

bool	updateNeighbors (const std::shared_ptr< Geometry::IComponent > &comp, const Kernel::V3D &CentPos, const Kernel::V3D &oldCenter, double NewRadius, double &neighborRadius)
	Checks and updates if needed the list of m_NeighborIDs. More...

int	UpdateOutputWS (DataObjects::TableWorkspace_sptr &TabWS, const int dir, const double chan, std::vector< double > const &params, std::vector< double > const &errs, std::vector< std::string > const &names, const double Chisq, const double time, std::string spec_idList)
	Updates the information in the output OutputWorkspace. More...

void	updatePeakInformation (std::vector< double > const &params, std::vector< double > const &errs, std::vector< std::string > const &names, double &TotVariance, double &TotIntensity, double const TotSliceIntensity, double const TotSliceVariance, double const chisqdivDOF, const int ncells)
	Updates m_AttributeValues with this peak information from this time slice. More...

void	updateStats (const double intensity, const double variance, const double row, const double col, std::vector< double > &StatBase)
	Updates the cumulative statistics for the data being considered. More...

Private Attributes
std::string	m_AttributeNames [20]

std::shared_ptr< DataModeHandler >	m_AttributeValues

double	m_cellHeight
	for Describing the Plane at the Peak More...

double	m_cellWidth
	Peak. More...

Kernel::V3D	m_center
	for Describing the Plane at the Peak More...

double	m_COL
	for Describing the Column(or 0) describing the center of the More...

bool	m_EdgePeak

int	m_NCOLS

int *	m_NeighborIDs

int	m_NROWS

std::string	m_ParameterNames [7]

std::array< double, 7 >	m_ParameterValues

double	m_R0
	for Weak Peaks, these can be set using info from close More...

double	m_ROW
	for Describing the Row(or 0) describing the center of the Peak More...

Mantid::detid2index_map	m_wi_to_detid_map

Kernel::V3D	m_xvec
	for Describing the Plane at the Peak More...

Kernel::V3D	m_yvec
	for Describing the Plane at the Peak More...

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 Property *	getPointerToPropertyOrdinal (const int &index) const =0
	Get a property by an index. More...

template<typename T >
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< AlgorithmHistory >	m_history
	Pointer to the history for the algorithm being executed. More...

Kernel::Logger	m_log
	Logger for this algorithm. More...

Kernel::Logger &	g_log

std::shared_ptr< AlgorithmHistory >	m_parentHistory
	Pointer to the parent history object (if set) More...

std::vector< WorkspaceVector >	m_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

Definition at line 206 of file IntegratePeakTimeSlices.h.

Constructor & Destructor Documentation

◆ IntegratePeakTimeSlices()

Mantid::Crystal::IntegratePeakTimeSlices::IntegratePeakTimeSlices ( )

Default constructor.

Definition at line 96 of file IntegratePeakTimeSlices.cpp.

References m_AttributeNames, m_EdgePeak, m_NeighborIDs, m_ParameterNames, and m_ParameterValues.

◆ ~IntegratePeakTimeSlices()

Mantid::Crystal::IntegratePeakTimeSlices::~IntegratePeakTimeSlices ( )

override

Destructor.

Definition at line 140 of file IntegratePeakTimeSlices.cpp.

References m_NeighborIDs.

Member Function Documentation

◆ CalculateFunctionProperty_Fit()

std::string Mantid::Crystal::IntegratePeakTimeSlices::CalculateFunctionProperty_Fit ( )

private

Calculates the string for the Function Property of the Fit Algorithm.

Returns: the string for the Function Property of the Fit Algorithm

Definition at line 1607 of file IntegratePeakTimeSlices.cpp.

References m_AttributeValues, m_ParameterNames, m_ParameterValues, and NParameters.

Referenced by Fit().

◆ CalculateIsawIntegrateError()

double Mantid::Crystal::IntegratePeakTimeSlices::CalculateIsawIntegrateError	(	const double	background,
		const double	backError,
		const double	ChiSqOverDOF,
		const double	TotVariance,
		const int	ncells
	)

private

Calculates the error in integration closest to the latest ISAW calculations.

Parameters

background	The background
backError	The error in this background value
ChiSqOverDOF	The fitting error
TotVariance	The Total square of the intensity errors in all the cells considered
ncells	The number of cells

Returns: The error in the integrated intensity

Definition at line 2198 of file IntegratePeakTimeSlices.cpp.

References Mantid::Crystal::SQRT().

◆ CalculatePositionSpan()

double Mantid::Crystal::IntegratePeakTimeSlices::CalculatePositionSpan	(	DataObjects::Peak const &	peak,
		const double	dQ
	)

private

Calculates the span in rows and columns needed to include all data within dQ of the specified peak.

Parameters

peak	The peak of interest
dQ	The offset from the peak's Q value for the data of interest

NOTE: differentials of Q =mv*sin(scatAng/2)/2 were used to calculate this Also s=r*theta was used to transfer d ScatAng to distance on a bank.

Definition at line 700 of file IntegratePeakTimeSlices.cpp.

References fabs, Mantid::DataObjects::Peak::getDetPos(), Mantid::DataObjects::Peak::getInstrument(), Mantid::DataObjects::Peak::getQLabFrame(), Mantid::Kernel::V3D::norm(), and Mantid::Kernel::V3D::Z().

Referenced by exec().

◆ CalculateTimeChannelSpan()

int Mantid::Crystal::IntegratePeakTimeSlices::CalculateTimeChannelSpan	(	Geometry::IPeak const &	peak,
		const double	dQ,
		const Mantid::HistogramData::HistogramX &	X,
		const int	specNum,
		int &	Centerchan
	)

private

Calculates the span of channels needed to encompass all data around the peak with Q values within dQ of this peak's Q value.

Parameters

peak	The peak of interest
dQ	The offset of peak's Q value whose data is considered part of the peak
X	The list of time channel values.
specNum	The spectral number for the pixel(Not Currently Used)
Centerchan	The center time channel number( from X)

Returns: The number of time channels around Centerchan to use

Definition at line 742 of file IntegratePeakTimeSlices.cpp.

References findTimeChannel(), Mantid::Geometry::IPeak::getQLabFrame(), Mantid::Geometry::IPeak::getTOF(), Mantid::Kernel::V3D::norm(), UNUSED_ARG, and Mantid::Geometry::X.

Referenced by exec().

◆ category()

const std::string Mantid::Crystal::IntegratePeakTimeSlices::category ( ) const

inlineoverridevirtual

Algorithm's category for identification overriding a virtual method.

Reimplemented from Mantid::API::Algorithm.

Definition at line 228 of file IntegratePeakTimeSlices.h.

◆ exec()

void Mantid::Crystal::IntegratePeakTimeSlices::exec ( )

overrideprivatevirtual

Executes this algorithm.

Integrates one peak -First attempts to find row/col extents, time extents to fully get most of the peak -Integrate each time slice. -Report Results

Implements Mantid::API::Algorithm.

Definition at line 176 of file IntegratePeakTimeSlices.cpp.

References CalculatePositionSpan(), CalculateTimeChannelSpan(), Mantid::Kernel::Logger::debug(), Mantid::Kernel::Logger::error(), findNameInVector(), FindPlane(), Mantid::API::Algorithm::g_log, Mantid::DataObjects::Peak::getBankName(), Mantid::DataObjects::Peak::getDetector(), Mantid::DataObjects::Peak::getDetectorID(), Mantid::DataObjects::Peak::getDetPos(), Mantid::DataObjects::Peak::getInstrument(), getNeighborPixIDs(), Mantid::API::Algorithm::getProperty(), IIntensities, InitializeColumnNamesInTableWorkspace(), Mantid::Kernel::SingletonHolder< T >::Instance(), isGoodFit(), Mantid::Geometry::BoundingBox::isPointInside(), ISS1, ISSIx, ISSIxx, ISSIy, ITINTENS, IVariance, m_AttributeValues, m_cellHeight, m_cellWidth, m_center, m_COL, m_NCOLS, m_NeighborIDs, m_NROWS, m_ParameterValues, m_R0, m_ROW, m_wi_to_detid_map, m_xvec, m_yvec, Mantid::Kernel::ProgressBase::report(), Mantid::Kernel::IPropertyManager::setProperty(), SetUpData(), SetUpData1(), Mantid::Crystal::SQRT(), updateNeighbors(), UpdateOutputWS(), updatePeakInformation(), and Mantid::Geometry::X.

◆ findNameInVector()

int Mantid::Crystal::IntegratePeakTimeSlices::findNameInVector	(	std::string const &	oneName,
		std::vector< std::string > const &	nameList
	)

private

Utility to find a name in a vector of strings.

Parameters

oneName	The name to search for
nameList	The list of names

Returns: the position in the vector of oneName or -1.

Definition at line 1637 of file IntegratePeakTimeSlices.cpp.

Referenced by exec(), isGoodFit(), PreFit(), and UpdateOutputWS().

◆ FindPlane()

void Mantid::Crystal::IntegratePeakTimeSlices::FindPlane	(	Kernel::V3D &	center,
		Kernel::V3D &	xvec,
		Kernel::V3D &	yvec,
		double &	ROW,
		double &	COL,
		int &	NROWS,
		int &	NCOLS,
		double &	pixWidthx,
		double &	pixHeighty,
		DataObjects::Peak const &	peak
	)		const

private

For NonFlat banks, this determines the data of a small planar region approximating the instrument close to the peak.

Parameters

center	The position of the center of this plane
xvec	The direction the column values increase
yvec	The direction the row values increase
ROW	The row for this peak( 0 if undefined)
COL	The col for this peak( 0 if undefined)
NROWS	The number? of rows for this bANK
NCOLS	The number of columns for this bank
pixWidthx	The width of a pixel
pixHeighty	The height of a pixel
peak

Definition at line 780 of file IntegratePeakTimeSlices.cpp.

References Mantid::DataObjects::Peak::getBankName(), Mantid::DataObjects::Peak::getCol(), Mantid::DataObjects::Peak::getDetector(), Mantid::DataObjects::Peak::getInstrument(), Mantid::Kernel::Quat::getRotation(), Mantid::DataObjects::Peak::getRow(), Mantid::Kernel::Quat::inverse(), Mantid::Kernel::V3D::normalize(), Mantid::Kernel::Quat::rotate(), Mantid::Kernel::V3D::setX(), Mantid::Kernel::V3D::setY(), Mantid::Kernel::V3D::setZ(), Mantid::Kernel::V3D::X(), Mantid::Geometry::BoundingBox::xMax(), Mantid::Geometry::BoundingBox::xMin(), Mantid::Kernel::V3D::Y(), Mantid::Geometry::BoundingBox::yMax(), Mantid::Geometry::BoundingBox::yMin(), and Mantid::Kernel::V3D::Z().

Referenced by exec().

◆ findTimeChannel()

int Mantid::Crystal::IntegratePeakTimeSlices::findTimeChannel	(	const Mantid::HistogramData::HistogramX &	X,
		const double	time
	)

private

Finds the time channel with the given time in.

Parameters

X	The vector of time values from a MatrixWorkspace
time	The desired time

Returns: the time channel

Definition at line 1556 of file IntegratePeakTimeSlices.cpp.

References Mantid::Geometry::X.

Referenced by CalculateTimeChannelSpan().

◆ Fit()

void Mantid::Crystal::IntegratePeakTimeSlices::Fit	(	API::MatrixWorkspace_sptr &	Data,
		double &	chisqOverDOF,
		bool &	done,
		std::vector< std::string > &	names,
		std::vector< double > &	params,
		std::vector< double > &	errs,
		double	lastRow,
		double	lastCol,
		double	neighborRadius
	)

private

Sets up data for the Fit Algorithm call and invokes it.

Parameters

Data	The workspace with experimental results
chisqOverDOF	the chi squared over degrees of freedom result from the Fit Algorithm
done	Usually true except if there is not enough data or Fit Algorithm was not called
names	The parameter names
params	The parameter values from the Fit Algorithm
errs	The parameter errorfrom the Fit Algorithm
lastRow	The previous row( for log info only)
lastCol	The previous col( for log info only)
neighborRadius	The neighborhood radius( for log info only)

Definition at line 1834 of file IntegratePeakTimeSlices.cpp.

References CalculateFunctionProperty_Fit(), Mantid::API::Algorithm::createChildAlgorithm(), Mantid::Kernel::Logger::debug(), error, Mantid::Kernel::Logger::error(), Mantid::API::Algorithm::g_log, Mantid::API::Algorithm::getProperty(), IBACK, IIntensities, ISS1, IVXX, IVXY, IVYY, IXMEAN, IYMEAN, m_AttributeValues, m_NeighborIDs, m_ParameterNames, and Mantid::Crystal::SQRT().

◆ getNeighborPixIDs()

bool Mantid::Crystal::IntegratePeakTimeSlices::getNeighborPixIDs	(	const std::shared_ptr< Geometry::IComponent > &	comp,
		const Kernel::V3D &	Center,
		double &	Radius,
		int *&	ArryofID
	)

private

Finds all neighbors within a given Radius of the Center on the given component.

Parameters

comp	-The component of interest
Center-	the center of the neighbors
Radius	- The radius from the center of neighbors to be included
ArryofID	-The detector ID's of the neighbors. The id of the pixel at the center may be included.

Definition at line 594 of file IntegratePeakTimeSlices.cpp.

References getNeighborPixIDs(), Mantid::Kernel::V3D::X(), Mantid::Geometry::BoundingBox::xMax(), Mantid::Geometry::BoundingBox::xMin(), Mantid::Kernel::V3D::Y(), Mantid::Geometry::BoundingBox::yMax(), Mantid::Geometry::BoundingBox::yMin(), Mantid::Kernel::V3D::Z(), Mantid::Geometry::BoundingBox::zMax(), and Mantid::Geometry::BoundingBox::zMin().

Referenced by exec(), getNeighborPixIDs(), SetUpData(), and updateNeighbors().

◆ init()

void Mantid::Crystal::IntegratePeakTimeSlices::init ( )

overrideprivatevirtual

Virtual method - must be overridden by concrete algorithm.

Implements Mantid::API::Algorithm.

Definition at line 142 of file IntegratePeakTimeSlices.cpp.

References Mantid::API::Algorithm::declareProperty(), Mantid::Kernel::Direction::Input, and Mantid::Kernel::Direction::Output.

◆ InitializeColumnNamesInTableWorkspace()

void Mantid::Crystal::IntegratePeakTimeSlices::InitializeColumnNamesInTableWorkspace ( DataObjects::TableWorkspace_sptr & TabWS )

private

Initializes the column names in the output table workspace.

Parameters

TabWS The TableWorkspace

Definition at line 2216 of file IntegratePeakTimeSlices.cpp.

Referenced by exec().

◆ isGoodFit()

bool Mantid::Crystal::IntegratePeakTimeSlices::isGoodFit	(	std::vector< double > const &	params,
		std::vector< double > const &	errs,
		std::vector< std::string > const &	names,
		double	chisqOverDOF
	)

private

Determines if the list of parameters and errors represent a "good" fit.

Parameters

params	The list of parameter values
errs	The list of the errors in the parameter values
names	The names of the parameters
chisqOverDOF	The fitting error

Returns: true if the fit is good,otherwise false

Definition at line 2013 of file IntegratePeakTimeSlices.cpp.

References Mantid::Kernel::Logger::debug(), findNameInVector(), Mantid::API::Algorithm::g_log, Mantid::API::Algorithm::getProperty(), IBACK, IIntensities, INCol, INRows, ISS1, ITINTENS, IVXX, IVXY, IVYY, IXMEAN, IYMEAN, m_AttributeValues, m_EdgePeak, m_NCOLS, m_NROWS, obj, and Mantid::Geometry::x.

Referenced by exec().

◆ name()

const std::string Mantid::Crystal::IntegratePeakTimeSlices::name ( ) const

inlineoverridevirtual

Algorithm's name for identification overriding a virtual method.

Implements Mantid::API::Algorithm.

Definition at line 215 of file IntegratePeakTimeSlices.h.

◆ PreFit()

void Mantid::Crystal::IntegratePeakTimeSlices::PreFit	(	API::MatrixWorkspace_sptr &	Data,
		double &	chisqOverDOF,
		bool &	done,
		std::vector< std::string > &	names,
		std::vector< double > &	params,
		std::vector< double > &	errs,
		double	lastRow,
		double	lastCol,
		double	neighborRadius
	)

private

Tests several starting points in the Marquardt algorithm then calls Fit.

Not used.

Did 3 Fit Algorithm calls and returned the one with the smallest chiSqOverDOF. Did not work well

Parameters

Data	The workspace with experimental results
chisqOverDOF	the chi squared over degrees of freedom result from the Fit Algorithm
done	Usually true except if there is not enough data or Fit Algorithm was not called
names	The parameter names
params	The parameter values from the Fit Algorithm
errs	The parameter errorfrom the Fit Algorithm
lastRow	The previous row( for log info only)
lastCol	The previous col( for log info only)
neighborRadius	The neighborhood radius( for log info only)

Definition at line 1954 of file IntegratePeakTimeSlices.cpp.

References Mantid::Kernel::Logger::debug(), findNameInVector(), Mantid::API::Algorithm::g_log, IBACK, m_AttributeValues, m_ParameterNames, and m_ParameterValues.

◆ seeAlso()

const std::vector< std::string > Mantid::Crystal::IntegratePeakTimeSlices::seeAlso ( ) const

inlineoverridevirtual

Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm.A default implementation is provided.

Reimplemented from Mantid::API::Algorithm.

Definition at line 225 of file IntegratePeakTimeSlices.h.

◆ SetUpData()

void Mantid::Crystal::IntegratePeakTimeSlices::SetUpData	(	API::MatrixWorkspace_sptr &	Data,
		API::MatrixWorkspace_const_sptr const &	inpWkSpace,
		const std::shared_ptr< Geometry::IComponent > &	comp,
		const int	chanMin,
		const int	chanMax,
		double	CentX,
		double	CentY,
		Kernel::V3D &	CentNghbr,
		double &	neighborRadius,
		double	Radius,
		std::string &	spec_idList
	)

private

Initial phase at converting Detector data to workspace data that will be sent to the Fit Function, BivariateNormal.

Parameters

Data	-workspace that will be sent to the Fit Function, BivariateNormal
inpWkSpace	-The MatrixWorkspace with all the experimental data
comp	-The parent of all the pixels that are neighbors of the peak being considered
chanMin	-The minimum channel to use
chanMax	-The maximum channel to be collapsed to one channel
CentX	-The current peak row
CentY	-The current peak column
CentNghbr	-The center of the current and next(if changed) neighbor pixels
neighborRadius	-The radius of the current neighbor pixels
Radius	-The current starting Radius to use for neighbors.
spec_idList	-The list of spectral id's that are neighbors

Definition at line 1327 of file IntegratePeakTimeSlices.cpp.

References getNeighborPixIDs(), Mantid::API::Algorithm::getProperty(), ISSIxx, IXMEAN, IYMEAN, m_AttributeValues, m_cellHeight, m_cellWidth, m_center, m_COL, m_NCOLS, m_NeighborIDs, m_NROWS, m_ParameterValues, m_R0, m_ROW, m_xvec, m_yvec, SetUpData1(), and Mantid::Geometry::X.

Referenced by exec().

◆ SetUpData1()

void Mantid::Crystal::IntegratePeakTimeSlices::SetUpData1	(	API::MatrixWorkspace_sptr &	Data,
		API::MatrixWorkspace_const_sptr const &	inpWkSpace,
		const int	chanMin,
		const int	chanMax,
		double	Radius,
		const Kernel::V3D &	CentPos,
		std::string &	spec_idList
	)

private

Prepares the data for futher analysis adding meta data and marking data on the edges of detectors.

Parameters

Data	Output workspace
inpWkSpace	Input workspace
chanMin	Minimum channel
chanMax	Maximum channel. Will be collapsed to one channel
Radius	The radius of detectors
CentPos	Center on plane
spec_idList	List of spectra id's

Definition at line 1402 of file IntegratePeakTimeSlices.cpp.

References Mantid::API::Algorithm::g_log, Mantid::API::Algorithm::getProperty(), IBACK, INBoundary, INCol, INRows, IStartCol, IStartRow, ITINTENS, ITotBoundary, IVarBoundary, IVXX, IVXY, IVYY, IXMEAN, IYMEAN, m_AttributeValues, m_cellHeight, m_cellWidth, m_COL, m_EdgePeak, m_NCOLS, m_NeighborIDs, m_NROWS, m_ParameterValues, m_ROW, m_wi_to_detid_map, m_xvec, m_yvec, NAttributes, Mantid::Kernel::V3D::scalar_prod(), sigma, std::to_string(), UNUSED_ARG, and updateStats().

Referenced by exec(), and SetUpData().

◆ summary()

const std::string Mantid::Crystal::IntegratePeakTimeSlices::summary ( ) const

inlineoverridevirtual

Summary of algorithms purpose.

Implements Mantid::API::Algorithm.

Definition at line 218 of file IntegratePeakTimeSlices.h.

◆ updateNeighbors()

bool Mantid::Crystal::IntegratePeakTimeSlices::updateNeighbors	(	const std::shared_ptr< Geometry::IComponent > &	comp,
		const Kernel::V3D &	CentPos,
		const Kernel::V3D &	oldCenter,
		double	NewRadius,
		double &	neighborRadius
	)

private

Checks and updates if needed the list of m_NeighborIDs.

Parameters

comp	Component with the neighboring pixels
CentPos	new Center
oldCenter	old Center
NewRadius	new Radius
neighborRadius	old the new neighborhood radius

Definition at line 666 of file IntegratePeakTimeSlices.cpp.

References getNeighborPixIDs(), m_cellHeight, m_cellWidth, and m_NeighborIDs.

Referenced by exec().

◆ UpdateOutputWS()

int Mantid::Crystal::IntegratePeakTimeSlices::UpdateOutputWS	(	DataObjects::TableWorkspace_sptr &	TabWS,
		const int	dir,
		const double	chan,
		std::vector< double > const &	params,
		std::vector< double > const &	errs,
		std::vector< std::string > const &	names,
		const double	Chisq,
		const double	time,
		std::string	spec_idList
	)

private

Updates the information in the output OutputWorkspace.

Parameters

TabWS	The OutputWorkspace
dir	The direction the time slices are going( >0 means increasing otherwise decreasing)
chan	The number of channels away from the center channel this data corresponds to
params	The parameter values
errs	The error in these parameter values
names	The names of the parameters
Chisq	The fitting error
time	The time for this channel
spec_idList	The list of spectral id's used to integrate this time channel

Returns: The last row updated

Definition at line 2261 of file IntegratePeakTimeSlices.cpp.

References findNameInVector(), IIntensities, INBoundary, INCol, INRows, ISS1, IStartCol, IStartRow, ITotBoundary, IVariance, m_AttributeValues, and Mantid::Crystal::SQRT().

Referenced by exec().

◆ updatePeakInformation()

void Mantid::Crystal::IntegratePeakTimeSlices::updatePeakInformation	(	std::vector< double > const &	params,
		std::vector< double > const &	errs,
		std::vector< std::string > const &	names,
		double &	TotVariance,
		double &	TotIntensity,
		double const	TotSliceIntensity,
		double const	TotSliceVariance,
		double const	chisqdivDOF,
		const int	ncells
	)

private

Updates m_AttributeValues with this peak information from this time slice.

Parameters

params	The parameter values
errs	The error in these parameter values
names	The names of the parameters
TotVariance	The total of the squares of the intensity errors from the data
TotIntensity	The total of the intensities so far
TotSliceIntensity	The total intensity for this slice
TotSliceVariance	The total square of intensity errors for this time slice
chisqdivDOF	The fitting error
ncells	The number of cells

Definition at line 2353 of file IntegratePeakTimeSlices.cpp.

References Mantid::Kernel::Logger::debug(), Mantid::API::Algorithm::g_log, m_AttributeValues, and UNUSED_ARG.

Referenced by exec().

◆ updateStats()

void Mantid::Crystal::IntegratePeakTimeSlices::updateStats	(	const double	intensity,
		const double	variance,
		const double	row,
		const double	col,
		std::vector< double > &	StatBase
	)

private

Updates the cumulative statistics for the data being considered.

Parameters

intensity	-The experimental intensity at the given pixel
variance	-The square of the errors in the above intensity
row	-The row of the given pixel
col	-The column of the given pixel
StatBase	-The data accumulator

Definition at line 867 of file IntegratePeakTimeSlices.cpp.

References IIntensities, ISS1, ISSIx, ISSIxx, ISSIxy, ISSIy, ISSIyy, ISSx, ISSxx, ISSxy, ISSy, ISSyy, and IVariance.

Referenced by SetUpData1().

◆ version()

int Mantid::Crystal::IntegratePeakTimeSlices::version ( ) const

inlineoverridevirtual

Algorithm's version for identification overriding a virtual method.

Implements Mantid::API::Algorithm.

Definition at line 224 of file IntegratePeakTimeSlices.h.

Member Data Documentation

◆ m_AttributeNames

std::string Mantid::Crystal::IntegratePeakTimeSlices::m_AttributeNames[20]

private

Definition at line 236 of file IntegratePeakTimeSlices.h.

Referenced by IntegratePeakTimeSlices().

◆ m_AttributeValues

std::shared_ptr<DataModeHandler> Mantid::Crystal::IntegratePeakTimeSlices::m_AttributeValues

private

Definition at line 240 of file IntegratePeakTimeSlices.h.

Referenced by CalculateFunctionProperty_Fit(), exec(), Fit(), isGoodFit(), PreFit(), SetUpData(), SetUpData1(), UpdateOutputWS(), and updatePeakInformation().

◆ m_cellHeight

double Mantid::Crystal::IntegratePeakTimeSlices::m_cellHeight

private

for Describing the Plane at the Peak

Definition at line 255 of file IntegratePeakTimeSlices.h.

Referenced by exec(), SetUpData(), SetUpData1(), and updateNeighbors().

◆ m_cellWidth

double Mantid::Crystal::IntegratePeakTimeSlices::m_cellWidth

private

Peak.

for Describing the Plane at the Peak

Definition at line 254 of file IntegratePeakTimeSlices.h.

Referenced by exec(), SetUpData(), SetUpData1(), and updateNeighbors().

◆ m_center

Kernel::V3D Mantid::Crystal::IntegratePeakTimeSlices::m_center

private

for Describing the Plane at the Peak

Definition at line 248 of file IntegratePeakTimeSlices.h.

Referenced by exec(), and SetUpData().

◆ m_COL

double Mantid::Crystal::IntegratePeakTimeSlices::m_COL

private

for Describing the Column(or 0) describing the center of the

Definition at line 252 of file IntegratePeakTimeSlices.h.

Referenced by exec(), SetUpData(), and SetUpData1().

◆ m_EdgePeak

bool Mantid::Crystal::IntegratePeakTimeSlices::m_EdgePeak

private

Definition at line 234 of file IntegratePeakTimeSlices.h.

Referenced by IntegratePeakTimeSlices(), isGoodFit(), and SetUpData1().

◆ m_NCOLS

int Mantid::Crystal::IntegratePeakTimeSlices::m_NCOLS

private

Definition at line 257 of file IntegratePeakTimeSlices.h.

Referenced by exec(), isGoodFit(), SetUpData(), and SetUpData1().

◆ m_NeighborIDs

int* Mantid::Crystal::IntegratePeakTimeSlices::m_NeighborIDs

private

Definition at line 245 of file IntegratePeakTimeSlices.h.

Referenced by exec(), Fit(), IntegratePeakTimeSlices(), SetUpData(), SetUpData1(), updateNeighbors(), and ~IntegratePeakTimeSlices().

◆ m_NROWS

int Mantid::Crystal::IntegratePeakTimeSlices::m_NROWS

private

Definition at line 256 of file IntegratePeakTimeSlices.h.

Referenced by exec(), isGoodFit(), SetUpData(), and SetUpData1().

◆ m_ParameterNames

std::string Mantid::Crystal::IntegratePeakTimeSlices::m_ParameterNames[7]

private

Definition at line 238 of file IntegratePeakTimeSlices.h.

Referenced by CalculateFunctionProperty_Fit(), Fit(), IntegratePeakTimeSlices(), and PreFit().

◆ m_ParameterValues

std::array<double, 7> Mantid::Crystal::IntegratePeakTimeSlices::m_ParameterValues

private

Definition at line 241 of file IntegratePeakTimeSlices.h.

Referenced by CalculateFunctionProperty_Fit(), exec(), IntegratePeakTimeSlices(), PreFit(), SetUpData(), and SetUpData1().

◆ m_R0

double Mantid::Crystal::IntegratePeakTimeSlices::m_R0

private

for Weak Peaks, these can be set using info from close

Definition at line 246 of file IntegratePeakTimeSlices.h.

Referenced by exec(), and SetUpData().

◆ m_ROW

double Mantid::Crystal::IntegratePeakTimeSlices::m_ROW

private

for Describing the Row(or 0) describing the center of the Peak

Definition at line 251 of file IntegratePeakTimeSlices.h.

Referenced by exec(), SetUpData(), and SetUpData1().

◆ m_wi_to_detid_map

Mantid::detid2index_map Mantid::Crystal::IntegratePeakTimeSlices::m_wi_to_detid_map

private

Definition at line 243 of file IntegratePeakTimeSlices.h.

Referenced by exec(), and SetUpData1().

◆ m_xvec

Kernel::V3D Mantid::Crystal::IntegratePeakTimeSlices::m_xvec

private

for Describing the Plane at the Peak

Definition at line 249 of file IntegratePeakTimeSlices.h.

Referenced by exec(), SetUpData(), and SetUpData1().

◆ m_yvec

Kernel::V3D Mantid::Crystal::IntegratePeakTimeSlices::m_yvec

private

for Describing the Plane at the Peak

Definition at line 250 of file IntegratePeakTimeSlices.h.

Referenced by exec(), SetUpData(), and SetUpData1().

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

Framework/Crystal/inc/MantidCrystal/IntegratePeakTimeSlices.h
Framework/Crystal/src/IntegratePeakTimeSlices.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IntegratePeakTimeSlices()

◆ ~IntegratePeakTimeSlices()

Member Function Documentation

◆ CalculateFunctionProperty_Fit()

◆ CalculateIsawIntegrateError()

◆ CalculatePositionSpan()

◆ CalculateTimeChannelSpan()

◆ category()

◆ exec()

◆ findNameInVector()

◆ FindPlane()

◆ findTimeChannel()

◆ Fit()

◆ getNeighborPixIDs()

◆ init()

◆ InitializeColumnNamesInTableWorkspace()

◆ isGoodFit()

◆ name()

◆ PreFit()

◆ seeAlso()

◆ SetUpData()

◆ SetUpData1()

◆ summary()

◆ updateNeighbors()

◆ UpdateOutputWS()

◆ updatePeakInformation()

◆ updateStats()

◆ version()

Member Data Documentation

◆ m_AttributeNames

◆ m_AttributeValues

◆ m_cellHeight

◆ m_cellWidth

◆ m_center

◆ m_COL

◆ m_EdgePeak

◆ m_NCOLS

◆ m_NeighborIDs

◆ m_NROWS

◆ m_ParameterNames

◆ m_ParameterValues

◆ m_R0

◆ m_ROW

◆ m_wi_to_detid_map

◆ m_xvec

◆ m_yvec