A struct containing the cells of an EPP table row. More...

#include <WorkspaceCreationHelper.h>

Public Types
enum class	FitStatus { SUCCESS , FAILURE }
	FindEPP algorithm fitting success status. More...

Public Member Functions
	EPPTableRow ()=default
	Construct a row with the default values.

	EPPTableRow (const double peakCentre, const double sigma, const double height, const FitStatus fitStatus)
	Construct a row with default workspace index and errors set to zero.

	EPPTableRow (const int index, const double peakCentre, const double sigma, const double height, const FitStatus fitStatus)
	Construct a row with errors set to zero.

Public Attributes
double	chiSq = 0

FitStatus	fitStatus = FitStatus::SUCCESS

double	height = 0

double	heightError = 0

double	peakCentre = 0

double	peakCentreError = 0

double	sigma = 0

double	sigmaError = 0

int	workspaceIndex = -1

Detailed Description

A struct containing the cells of an EPP table row.

Definition at line 100 of file WorkspaceCreationHelper.h.

Member Enumeration Documentation

◆ FitStatus

enum class WorkspaceCreationHelper::EPPTableRow::FitStatus

strong

FindEPP algorithm fitting success status.

Enumerator
SUCCESS
FAILURE

Definition at line 102 of file WorkspaceCreationHelper.h.

Constructor & Destructor Documentation

◆ EPPTableRow() [1/3]

WorkspaceCreationHelper::EPPTableRow::EPPTableRow ( )

default

Construct a row with the default values.

◆ EPPTableRow() [2/3]

WorkspaceCreationHelper::EPPTableRow::EPPTableRow	(	const double	peakCentre,
		const double	sigma,
		const double	height,
		const FitStatus	fitStatus
	)

Construct a row with default workspace index and errors set to zero.

Definition at line 77 of file WorkspaceCreationHelper.cpp.

◆ EPPTableRow() [3/3]

WorkspaceCreationHelper::EPPTableRow::EPPTableRow	(	const int	index,
		const double	peakCentre,
		const double	sigma,
		const double	height,
		const FitStatus	fitStatus
	)

Construct a row with errors set to zero.

Definition at line 81 of file WorkspaceCreationHelper.cpp.

Member Data Documentation

◆ chiSq

double WorkspaceCreationHelper::EPPTableRow::chiSq = 0

Definition at line 118 of file WorkspaceCreationHelper.h.

◆ fitStatus

FitStatus WorkspaceCreationHelper::EPPTableRow::fitStatus = FitStatus::SUCCESS

Definition at line 119 of file WorkspaceCreationHelper.h.

◆ height

double WorkspaceCreationHelper::EPPTableRow::height = 0

Definition at line 116 of file WorkspaceCreationHelper.h.

◆ heightError

double WorkspaceCreationHelper::EPPTableRow::heightError = 0

Definition at line 117 of file WorkspaceCreationHelper.h.

◆ peakCentre

double WorkspaceCreationHelper::EPPTableRow::peakCentre = 0

Definition at line 112 of file WorkspaceCreationHelper.h.

◆ peakCentreError

double WorkspaceCreationHelper::EPPTableRow::peakCentreError = 0

Definition at line 113 of file WorkspaceCreationHelper.h.

◆ sigma

double WorkspaceCreationHelper::EPPTableRow::sigma = 0

Definition at line 114 of file WorkspaceCreationHelper.h.

◆ sigmaError

double WorkspaceCreationHelper::EPPTableRow::sigmaError = 0

Definition at line 115 of file WorkspaceCreationHelper.h.

◆ workspaceIndex

int WorkspaceCreationHelper::EPPTableRow::workspaceIndex = -1

Definition at line 111 of file WorkspaceCreationHelper.h.

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

Framework/TestHelpers/inc/MantidFrameworkTestHelpers/WorkspaceCreationHelper.h
Framework/TestHelpers/src/WorkspaceCreationHelper.cpp

Public Types

Public Member Functions

Public Attributes