Mantid
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Mantid::WorkflowAlgorithms::MuonGroupCountsCalculator Class Reference

MuonGroupCountsCalculator : Calculates pure counts of the group specified via group index. More...

#include <MuonGroupCountsCalculator.h>

Inheritance diagram for Mantid::WorkflowAlgorithms::MuonGroupCountsCalculator:
Mantid::WorkflowAlgorithms::MuonGroupCalculator Mantid::WorkflowAlgorithms::IMuonAsymmetryCalculator

Public Member Functions

Mantid::API::MatrixWorkspace_sptr calculate () const override
 Performs group counts calculation. More...
 
 MuonGroupCountsCalculator (const Mantid::API::WorkspaceGroup_sptr &inputWS, const std::vector< int > &summedPeriods, const std::vector< int > &subtractedPeriods, const int groupIndex)
 Constructor. More...
 
- Public Member Functions inherited from Mantid::WorkflowAlgorithms::MuonGroupCalculator
 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
 

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...
 
- Protected Attributes inherited from Mantid::WorkflowAlgorithms::MuonGroupCalculator
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...
 

Detailed Description

MuonGroupCountsCalculator : Calculates pure counts of the group specified via group index.

Definition at line 17 of file MuonGroupCountsCalculator.h.

Constructor & Destructor Documentation

◆ MuonGroupCountsCalculator()

Mantid::WorkflowAlgorithms::MuonGroupCountsCalculator::MuonGroupCountsCalculator ( 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 22 of file MuonGroupCountsCalculator.cpp.

Member Function Documentation

◆ calculate()

MatrixWorkspace_sptr Mantid::WorkflowAlgorithms::MuonGroupCountsCalculator::calculate ( ) const
overridevirtual

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