Mantid::WorkflowAlgorithms::MuonGroupCalculator Class Reference

MuonGroupCalculator : Base class for Muon group counts/asymmetry calculators. More...

#include <MuonGroupCalculator.h>

Inheritance diagram for Mantid::WorkflowAlgorithms::MuonGroupCalculator:

Public Member Functions
	MuonGroupCalculator (const Mantid::API::WorkspaceGroup_sptr &inputWS, const std::vector< int > &summedPeriods, const std::vector< int > &subtractedPeriods, const int groupIndex)
	Constructor. More...
void	setStartEnd (const double start, const double end)
void	setWSName (const std::string &wsName)
Public Member Functions inherited from Mantid::WorkflowAlgorithms::IMuonAsymmetryCalculator
virtual API::MatrixWorkspace_sptr	calculate () const =0
	Overridden in derived classes to perform asymmetry calculation. More...
	IMuonAsymmetryCalculator (API::WorkspaceGroup_sptr inputWS, std::vector< int > summedPeriods, std::vector< int > subtractedPeriods)
	Constructor. More...
virtual	~IMuonAsymmetryCalculator ()=default

Protected Attributes
double	m_endX
const int	m_groupIndex
	Workspace index of the group to analyse. More...
double	m_startX
std::string	m_wsName
Protected Attributes inherited from Mantid::WorkflowAlgorithms::IMuonAsymmetryCalculator
const API::WorkspaceGroup_sptr	m_inputWS
	Input workspace. More...
const std::vector< int >	m_subtractedPeriods
	List of subtracted periods. More...
const std::vector< int >	m_summedPeriods
	List of summed periods. More...

Additional Inherited Members
Protected Member Functions inherited from Mantid::WorkflowAlgorithms::IMuonAsymmetryCalculator
API::MatrixWorkspace_sptr	extractSpectrum (const API::Workspace_sptr &inputWS, const int index) const
	Extracts a single spectrum from a workspace. More...
API::MatrixWorkspace_sptr	subtractWorkspaces (const API::MatrixWorkspace_sptr &lhs, const API::MatrixWorkspace_sptr &rhs) const
	Subtracts one workspace from another (lhs - rhs) More...
API::MatrixWorkspace_sptr	sumPeriods (const std::vector< int > &periodsToSum) const
	Sums the specified periods in the input workspace group. More...

Detailed Description

MuonGroupCalculator : Base class for Muon group counts/asymmetry calculators.

Definition at line 16 of file MuonGroupCalculator.h.

Constructor & Destructor Documentation

MuonGroupCalculator()

Mantid::WorkflowAlgorithms::MuonGroupCalculator::MuonGroupCalculator	(	const Mantid::API::WorkspaceGroup_sptr &	inputWS,
		const std::vector< int > &	summedPeriods,
		const std::vector< int > &	subtractedPeriods,
		const int	groupIndex
	)

Constructor.

Parameters

inputWS	:: [input] Input workspace group
summedPeriods	:: [input] Vector of period indexes to be summed
subtractedPeriods	:: [input] Vector of period indexes to be subtracted from summed periods
groupIndex	:: [input] Workspace index of the group to analyse

Definition at line 20 of file MuonGroupCalculator.cpp.

Member Function Documentation

setStartEnd()

void Mantid::WorkflowAlgorithms::MuonGroupCalculator::setStartEnd	(	const double	start,
		const double	end
	)

Definition at line 24 of file MuonGroupCalculator.cpp.

References m_endX, and m_startX.

Referenced by Mantid::WorkflowAlgorithms::MuonGroupAsymmetryCalculator::MuonGroupAsymmetryCalculator().

setWSName()

void Mantid::WorkflowAlgorithms::MuonGroupCalculator::setWSName

(

const std::string &

wsName

)

Definition at line 28 of file MuonGroupCalculator.cpp.

References m_wsName.

Referenced by Mantid::WorkflowAlgorithms::MuonGroupAsymmetryCalculator::MuonGroupAsymmetryCalculator().

Member Data Documentation

m_endX

double Mantid::WorkflowAlgorithms::MuonGroupCalculator::m_endX

protected

Definition at line 27 of file MuonGroupCalculator.h.

Referenced by Mantid::WorkflowAlgorithms::MuonGroupAsymmetryCalculator::estimateAsymmetry(), and setStartEnd().

m_groupIndex

const int Mantid::WorkflowAlgorithms::MuonGroupCalculator::m_groupIndex

protected

Workspace index of the group to analyse.

Definition at line 25 of file MuonGroupCalculator.h.

Referenced by Mantid::WorkflowAlgorithms::MuonGroupAsymmetryCalculator::calculate(), and Mantid::WorkflowAlgorithms::MuonGroupCountsCalculator::calculate().

m_startX

double Mantid::WorkflowAlgorithms::MuonGroupCalculator::m_startX

protected

Definition at line 26 of file MuonGroupCalculator.h.

Referenced by Mantid::WorkflowAlgorithms::MuonGroupAsymmetryCalculator::estimateAsymmetry(), and setStartEnd().

m_wsName

std::string Mantid::WorkflowAlgorithms::MuonGroupCalculator::m_wsName

protected

Definition at line 28 of file MuonGroupCalculator.h.

Referenced by Mantid::WorkflowAlgorithms::MuonGroupAsymmetryCalculator::estimateAsymmetry(), and setWSName().

---

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

• Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/MuonGroupCalculator.h
• Framework/WorkflowAlgorithms/src/MuonGroupCalculator.cpp