Collaboration diagram for SimulationResult:

Public Member Functions
	SimulationResult ()=default

	SimulationResult (const OutputData< double > &data, const IUnitConverter &unit_converter)

	SimulationResult (const SimulationResult &other)

	SimulationResult (SimulationResult &&other)

SimulationResult &	operator= (const SimulationResult &other)

SimulationResult &	operator= (SimulationResult &&other)

std::unique_ptr< OutputData< double > >	data (Axes::Units units=Axes::Units::DEFAULT) const

Histogram2D *	histogram2d (Axes::Units units=Axes::Units::DEFAULT) const

std::vector< AxisInfo >	axisInfo (Axes::Units units=Axes::Units::DEFAULT) const

const IUnitConverter &	converter () const

double &	operator[] (size_t i)

const double &	operator[] (size_t i) const

size_t	size () const

bool	empty () const

PyObject *	array (Axes::Units units=Axes::Units::DEFAULT) const

std::vector< double >	axis (Axes::Units units=Axes::Units::DEFAULT) const

std::vector< double >	axis (size_t i_axis, Axes::Units units=Axes::Units::DEFAULT) const

Private Member Functions
void	checkDimensions () const

Private Attributes
std::unique_ptr< OutputData< double > >	mP_data

std::unique_ptr< IUnitConverter >	mP_unit_converter

Detailed Description

Wrapper around OutputData<double> that also provides unit conversions.

Definition at line 40 of file SimulationResult.h.

Constructor & Destructor Documentation

◆ SimulationResult() [1/4]

SimulationResult::SimulationResult ( )

default

◆ SimulationResult() [2/4]

SimulationResult::SimulationResult	(	const OutputData< double > &	data,
		const IUnitConverter &	unit_converter
	)

Definition at line 18 of file SimulationResult.cpp.

     : mP_data(data.clone()), mP_unit_converter(unit_converter.clone())
 {
     checkDimensions();
 }

References checkDimensions().

Here is the call graph for this function:

◆ SimulationResult() [3/4]

SimulationResult::SimulationResult ( const SimulationResult & other )

Definition at line 25 of file SimulationResult.cpp.

 {
     if (!other.mP_data || !other.mP_unit_converter)
         throw std::runtime_error("Error in SimulationResult(const SimulationResult& other): "
                                  "not initialized");
     mP_data.reset(other.mP_data->clone());
     mP_unit_converter.reset(other.mP_unit_converter->clone());
 }

References mP_data, and mP_unit_converter.

◆ SimulationResult() [4/4]

SimulationResult::SimulationResult ( SimulationResult && other )

Definition at line 34 of file SimulationResult.cpp.

     : mP_data(std::move(other.mP_data)), mP_unit_converter(std::move(other.mP_unit_converter))
 {
 }

Member Function Documentation

◆ operator=() [1/2]

SimulationResult & SimulationResult::operator= ( const SimulationResult & other )

Definition at line 39 of file SimulationResult.cpp.

 {
     if (!other.mP_data || !other.mP_unit_converter)
         throw std::runtime_error("Error in SimulationResult(const SimulationResult& other): "
                                  "not initialized");
  
     mP_data.reset(other.mP_data->clone());
     mP_unit_converter.reset(other.mP_unit_converter->clone());
     return *this;
 }

References mP_data, and mP_unit_converter.

◆ operator=() [2/2]

SimulationResult & SimulationResult::operator= ( SimulationResult && other )

Definition at line 50 of file SimulationResult.cpp.

 {
     mP_data.reset(other.mP_data.release());
     mP_unit_converter.reset(other.mP_unit_converter.release());
     return *this;
 }

References mP_data, and mP_unit_converter.

◆ data()

std::unique_ptr< OutputData< double > > SimulationResult::data ( Axes::Units units = Axes::Units::DEFAULT ) const

Definition at line 57 of file SimulationResult.cpp.

 {
     if (!mP_data)
         throw std::runtime_error(
             "Error in SimulationResult::data:Attempt to access non-initialized data");
     return mP_unit_converter->createConvertedData(*mP_data, units);
 }

References mP_data, and mP_unit_converter.

Referenced by RQ4Metric::compute(), SimDataPair::experimental_array(), histogram2d(), SimDataPair::simulation_array(), SimDataPair::uncertainties_array(), SimDataPair::user_weights_array(), and IntensityDataIOFactory::writeSimulationResult().

◆ histogram2d()

Histogram2D * SimulationResult::histogram2d ( Axes::Units units = Axes::Units::DEFAULT ) const

Definition at line 65 of file SimulationResult.cpp.

 {
     if (mP_data->getRank() != 2 || mP_unit_converter->dimension() != 2)
         throw std::runtime_error("Error in SimulationResult::histogram2d: "
                                  "dimension of data is not 2. Please use axis(), array() and "
                                  "data() functions for 1D data.");
     auto P_data = data(units);
     return new Histogram2D(*P_data);
 }

References data(), mP_data, and mP_unit_converter.

Here is the call graph for this function:

◆ axisInfo()

std::vector< AxisInfo > SimulationResult::axisInfo ( Axes::Units units = Axes::Units::DEFAULT ) const

Provide AxisInfo for each axis and the given units.

Definition at line 75 of file SimulationResult.cpp.

 {
     if (!mP_unit_converter)
         return {};
     std::vector<AxisInfo> result;
     auto dim = mP_unit_converter->dimension();
     for (size_t i = 0; i < dim; ++i) {
         AxisInfo info = {mP_unit_converter->axisName(i, units),
                          mP_unit_converter->calculateMin(i, units),
                          mP_unit_converter->calculateMax(i, units)};
         result.push_back(info);
     }
     return result;
 }

References mP_unit_converter.

◆ converter()

const IUnitConverter & SimulationResult::converter ( ) const

Returns underlying unit converter.

Definition at line 90 of file SimulationResult.cpp.

 {
     if (!mP_unit_converter)
         throw std::runtime_error(
             "Error in SimulationResult::converter: unit converter was not initialized");
     return *mP_unit_converter;
 }

References mP_unit_converter.

Referenced by SimDataPair::initResultArrays().

◆ operator[]() [1/2]

double & SimulationResult::operator[] ( size_t i )

Data element access.

Definition at line 98 of file SimulationResult.cpp.

 {
     if (mP_data)
         return (*mP_data)[i];
     throw std::runtime_error("Error in SimulationResult::operator[]: "
                              "no data initialized");
 }

References mP_data.

◆ operator[]() [2/2]

const double & SimulationResult::operator[] ( size_t i ) const

Definition at line 106 of file SimulationResult.cpp.

 {
     if (mP_data)
         return (*mP_data)[i];
     throw std::runtime_error("Error in SimulationResult::operator[]: "
                              "no data initialized");
 }

References mP_data.

◆ size()

size_t SimulationResult::size ( ) const

Definition at line 114 of file SimulationResult.cpp.

 {
     return mP_data ? mP_data->getAllocatedSize() : 0;
 }

References mP_data.

Referenced by SimDataPair::absoluteDifference(), empty(), SimDataPair::initResultArrays(), SimDataPair::relativeDifference(), and IntensityDataFunctions::RelativeDifference().

◆ empty()

bool SimulationResult::empty ( ) const

inline

Definition at line 72 of file SimulationResult.h.

72 { return size() == 0; }

SimulationResult::size

size_t size() const

Definition: SimulationResult.cpp:114

References size().

Referenced by SimDataPair::experimental_array(), SimDataPair::experimentalData(), IntensityDataFunctions::RelativeDifference(), SimDataPair::simulation_array(), SimDataPair::simulationResult(), SimDataPair::uncertainties(), SimDataPair::uncertainties_array(), SimDataPair::user_weights_array(), and SimDataPair::userWeights().

Here is the call graph for this function:

◆ array()

PyObject * SimulationResult::array ( Axes::Units units = Axes::Units::DEFAULT ) const

returns intensity data as Python numpy array

Definition at line 120 of file SimulationResult.cpp.

 {
     if (!mP_data || !mP_unit_converter)
         throw std::runtime_error(
             "Error in SimulationResult::array: attempt to access non-initialized data");
     return mP_unit_converter->createConvertedData(*mP_data, units)->getArray();
 }

References mP_data, and mP_unit_converter.

◆ axis() [1/2]

std::vector< double > SimulationResult::axis ( Axes::Units units = Axes::Units::DEFAULT ) const

Definition at line 129 of file SimulationResult.cpp.

 {
     return axis(0, units);
 }

Referenced by axis().

◆ axis() [2/2]

std::vector< double > SimulationResult::axis	(	size_t	i_axis,
		Axes::Units	units = `Axes::Units::DEFAULT`
	)		const

Returns axis coordinates as a numpy array.

With no parameters given returns coordinates of x-axis in default units.

Definition at line 134 of file SimulationResult.cpp.

 {
     if (i_axis >= mP_unit_converter->dimension())
         throw std::runtime_error(
             "Error in SimulationResult::axis: no axis corresponds to passed index.");
     auto axis = mP_unit_converter->createConvertedAxis(i_axis, units);
     return axis->getBinCenters();
 }

References axis(), and mP_unit_converter.

Here is the call graph for this function:

◆ checkDimensions()

void SimulationResult::checkDimensions ( ) const

private

Definition at line 143 of file SimulationResult.cpp.

 {
     if (mP_data->getRank() != mP_unit_converter->dimension())
         throw std::runtime_error("Error in SimulationResults::checkDimensions(): "
                                  "dimensions of data and unit converter don't match");
 }

References mP_data, and mP_unit_converter.

Referenced by SimulationResult().

Member Data Documentation

◆ mP_data

std::unique_ptr<OutputData<double> > SimulationResult::mP_data

private

Definition at line 87 of file SimulationResult.h.

Referenced by array(), checkDimensions(), data(), histogram2d(), operator=(), operator[](), SimulationResult(), and size().

◆ mP_unit_converter

std::unique_ptr<IUnitConverter> SimulationResult::mP_unit_converter

private

Definition at line 88 of file SimulationResult.h.

Referenced by array(), axis(), axisInfo(), checkDimensions(), converter(), data(), histogram2d(), operator=(), and SimulationResult().

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

/home/www/ba/Device/Histo/SimulationResult.h
/home/www/ba/Device/Histo/SimulationResult.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SimulationResult() [1/4]

◆ SimulationResult() [2/4]

◆ SimulationResult() [3/4]

◆ SimulationResult() [4/4]

Member Function Documentation

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ data()

◆ histogram2d()

◆ axisInfo()

◆ converter()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ size()

◆ empty()

◆ array()

◆ axis() [1/2]

◆ axis() [2/2]

◆ checkDimensions()

Member Data Documentation

◆ mP_data

◆ mP_unit_converter