Mantid::CurveFitting::MSVesuvioHelper::SimulationAggregator Struct Reference

#include <MSVesuvioHelpers.h>

Public Member Functions
SimulationWithErrors	average () const
Simulation &	newSimulation (const size_t order, const size_t ntimes)
	SimulationAggregator (const size_t nruns)
	Accumulates and averages the results of each simulation. More...

Public Attributes
std::vector< Simulation >	results

Detailed Description

Definition at line 56 of file MSVesuvioHelpers.h.

Constructor & Destructor Documentation

SimulationAggregator()

Mantid::CurveFitting::MSVesuvioHelper::SimulationAggregator::SimulationAggregator

(

const size_t

nruns

)

Accumulates and averages the results of each simulation.

Parameters

nruns

The number of runs that will be computed

Definition at line 301 of file MSVesuvioHelpers.cpp.

References results.

Member Function Documentation

average()

SimulationWithErrors Mantid::CurveFitting::MSVesuvioHelper::SimulationAggregator::average

(

)

const

Returns

The mean and standard deviation of the current set of simulations

Definition at line 316 of file MSVesuvioHelpers.cpp.

References Mantid::CurveFitting::MSVesuvioHelper::Simulation::counts, Mantid::CurveFitting::MSVesuvioHelper::SimulationWithErrors::errors, results, and Mantid::CurveFitting::MSVesuvioHelper::SimulationWithErrors::sim.

Referenced by Mantid::CurveFitting::Algorithms::VesuvioCalculateMS::calculateMS().

newSimulation()

Simulation & Mantid::CurveFitting::MSVesuvioHelper::SimulationAggregator::newSimulation	(	const size_t	order,
		const size_t	ntimes
	)

Parameters

order	The number of requested scatterings
ntimes	The number of times on input workspace

Returns

A reference to a new Simulation object

Definition at line 308 of file MSVesuvioHelpers.cpp.

References results.

Referenced by Mantid::CurveFitting::Algorithms::VesuvioCalculateMS::calculateMS().

Member Data Documentation

results

std::vector<Simulation> Mantid::CurveFitting::MSVesuvioHelper::SimulationAggregator::results

Definition at line 63 of file MSVesuvioHelpers.h.

Referenced by average(), newSimulation(), and SimulationAggregator().

---

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

• Framework/CurveFitting/inc/MantidCurveFitting/MSVesuvioHelpers.h
• Framework/CurveFitting/src/MSVesuvioHelpers.cpp