OutputData< T > Class Template Reference

Templated class to store data of type double or CumulativeValue in multi-dimensional space. More...

Collaboration diagram for OutputData< T >:

Public Types
typedef OutputDataIterator< const T, const OutputData< T > >	const_iterator
	Read-only iterator type. More...
typedef OutputDataIterator< T, OutputData< T > >	iterator
	Read/write iterator type. More...
using	value_type = T

Public Member Functions
	OutputData ()
	OutputData (const OutputData &)=delete
	OutputData (OutputData &&)
	~OutputData ()
void	addAxis (const IAxis &new_axis)
void	addAxis (const std::string &name, size_t size, double start, double end)
void	allocate ()
	memory allocation for current dimensions configuration More...
const IAxis &	axis (size_t serial_number) const
	returns axis with given serial number More...
iterator	begin ()
	Returns read/write iterator that points to the first element. More...
const_iterator	begin () const
	Returns read-only iterator that points to the first element. More...
void	clear ()
	Sets object into initial state (no dimensions, data) More...
OutputData *	clone () const
void	copyFrom (const OutputData< T > &x)
template<class U >
void	copyShapeFrom (const OutputData< U > &other)
iterator	end ()
	Returns read/write iterator that points to the one past last element. More...
const_iterator	end () const
	Returns read-only iterator that points to the one past last element. More...
size_t	findGlobalIndex (const std::vector< double > &coordinates) const
	Returns global index for specified axes values. More...
size_t	getAllocatedSize () const
	Returns total size of data buffer (product of bin number in every dimension). More...
std::vector< size_t >	getAllSizes () const
	Returns all sizes of its axes. More...
PyObject *	getArray () const
	returns data as Python numpy array More...
std::vector< int >	getAxesBinIndices (size_t global_index) const
	Returns vector of axes indices for given global index. More...
std::vector< double >	getAxesValues (size_t global_index) const
	Returns values on all defined axes for given globalbin number. More...
Bin1D	getAxisBin (size_t global_index, const std::string &axis_name) const
	Returns bin of selected axis for given global_index. More...
Bin1D	getAxisBin (size_t global_index, size_t i_selected_axis) const
	Returns bin of selected axis for given global_index. More...
size_t	getAxisBinIndex (size_t global_index, const std::string &axis_name) const
	Returns axis bin index for given global index. More...
size_t	getAxisBinIndex (size_t global_index, size_t i_selected_axis) const
	Returns axis bin index for given global index. More...
double	getAxisValue (size_t global_index, const std::string &axis_name) const
	Returns the value of selected axis for given global_index. More...
double	getAxisValue (size_t global_index, size_t i_selected_axis) const
	Returns the value of selected axis for given global_index. More...
std::vector< T >	getRawDataVector () const
	Returns copy of raw data vector. More...
double	getValue (size_t index) const
	Returns value or summed value, depending on T. More...
template<class U >
bool	hasSameDimensions (const OutputData< U > &right) const
	Returns true if object have same dimensions and number of axes bins. More...
template<class U >
bool	hasSameShape (const OutputData< U > &right) const
	Returns true if objects a) have same dimensions b) bin boundaries of axes coincide. More...
bool	isInitialized () const
	returns true if object is correctly initialized More...
OutputData< double > *	meanValues () const
const OutputData< T > &	operator*= (const OutputData< T > &right)
	multiplication-assignment operator for two output data More...
const OutputData< T > &	operator+= (const OutputData< T > &right)
	addition-assignment operator for two output data More...
const OutputData< T > &	operator-= (const OutputData< T > &right)
	substraction-assignment operator for two output data More...
const OutputData< T > &	operator/= (const OutputData< T > &right)
	division-assignment operator for two output data More...
const OutputData &	operator= (const OutputData &)=delete
T &	operator[] (size_t index)
	indexed accessor More...
const T &	operator[] (size_t index) const
	indexed accessor (const) More...
size_t	rank () const
	Returns number of dimensions. More...
void	scaleAll (const T &factor)
	multiply every item of this output data by value More...
void	setAllTo (const T &value)
	Sets content of output data to specific value. More...
void	setAxisSizes (size_t rank, int *n_dims)
	Adds 'rank' axes with indicated sizes. More...
void	setRawDataArray (const T *source)
	Sets new values to raw data array. More...
void	setRawDataVector (const std::vector< T > &data_vector)
	Sets new values to raw data vector. More...
size_t	toGlobalIndex (const std::vector< unsigned > &axes_indices) const
	Returns global index for specified indices of axes. More...
T	totalSum () const
	Returns sum of all values in the data structure. More...

Private Member Functions
bool	axisNameExists (const std::string &axis_name) const
	checks if given axis name exists More...
size_t	getAxisIndex (const std::string &axis_name) const
	returns serial number of axis with given name More...

Private Attributes
LLData< T > *	m_ll_data
SafePointerVector< IAxis >	m_value_axes

Friends
class	OutputDataIterator< const T, const OutputData< T > >
class	OutputDataIterator< T, OutputData< T > >

Detailed Description

template<class T>
class OutputData< T >

Templated class to store data of type double or CumulativeValue in multi-dimensional space.

Definition at line 32 of file OutputData.h.

Member Typedef Documentation

const_iterator

template<class T >

typedef OutputDataIterator<const T, const OutputData<T> > OutputData< T >::const_iterator

Read-only iterator type.

Definition at line 84 of file OutputData.h.

iterator

template<class T >

typedef OutputDataIterator<T, OutputData<T> > OutputData< T >::iterator

Read/write iterator type.

Definition at line 81 of file OutputData.h.

value_type

template<class T >

using OutputData< T >::value_type = T

Definition at line 34 of file OutputData.h.

Constructor & Destructor Documentation

OutputData() [1/3]

template<class T >

OutputData< T >::OutputData

Definition at line 248 of file OutputData.h.

                                             : m_value_axes(), m_ll_data(nullptr)
{
    allocate();
}

References OutputData< T >::allocate().

Here is the call graph for this function:

OutputData() [2/3]

template<class T >

OutputData< T >::OutputData ( const OutputData< T > &  )

delete

OutputData() [3/3]

template<class T >

OutputData< T >::OutputData

(

OutputData< T > &&

other

)

Definition at line 239 of file OutputData.h.

{
    m_value_axes = std::move(other.m_value_axes);
    m_ll_data = other.m_ll_data;
 
    other.m_ll_data = nullptr;
    other.allocate();
}

~OutputData()

template<class T >

OutputData< T >::~OutputData

Definition at line 253 of file OutputData.h.

{
    clear();
    delete m_ll_data;
}

Member Function Documentation

addAxis() [1/2]

template<class T >

void OutputData< T >::addAxis

(

const IAxis &

new_axis

)

Definition at line 295 of file OutputData.h.

{
    if (axisNameExists(new_axis.getName()))
        throw std::runtime_error("OutputData<T>::addAxis(const IAxis& new_axis) -> "
                                 "Error! Attempt to add axis with already existing name '"
                                 + new_axis.getName() + "'");
    if (new_axis.size() > 0) {
        m_value_axes.push_back(new_axis.clone());
        allocate();
    }
}

References IAxis::clone(), IAxis::getName(), and IAxis::size().

Referenced by Histogram1D::Histogram1D(), Histogram2D::Histogram2D(), IHistogram::IHistogram(), QREDataLoader::createOutputDataFromParsingResult(), Histogram2D::initFromShape(), DetectorMask::initMaskData(), OutputDataReadReflectometry::readOutputData(), OutputDataReadWriteINT::readOutputData(), SpecularSimulation::result(), OffSpecularSimulation::transferDetectorImage(), and OffSpecularSimulation::updateIntensityMap().

Here is the call graph for this function:

addAxis() [2/2]

template<class T >

void OutputData< T >::addAxis	(	const std::string &	name,
		size_t	size,
		double	start,
		double	end
	)

Definition at line 308 of file OutputData.h.

{
    if (axisNameExists(name))
        throw std::runtime_error("OutputData<T>::addAxis(std::string name) -> "
                                 "Error! Attempt to add axis with already existing name '"
                                 + name + "'");
    FixedBinAxis new_axis(name, size, start, end);
    addAxis(new_axis);
}

References RealSpace::Particles::name().

Here is the call graph for this function:

allocate()

template<class T >

void OutputData< T >::allocate

memory allocation for current dimensions configuration

Definition at line 542 of file OutputData.h.

{
    delete m_ll_data;
    size_t rank = m_value_axes.size();
    int* dims = new int[rank];
    for (size_t i = 0; i < rank; ++i) {
        dims[i] = (int)axis(i).size();
    }
    m_ll_data = new LLData<T>(rank, dims);
    T default_value = {};
    m_ll_data->setAll(default_value);
    delete[] dims;
}

Referenced by OutputData< T >::OutputData().

axis()

template<class T >

const IAxis & OutputData< T >::axis

(

size_t

serial_number

)

const

returns axis with given serial number

Definition at line 318 of file OutputData.h.

{
    return *m_value_axes[serial_number];
}

Referenced by RegionOfInterest::RegionOfInterest(), Histogram2D::addContent(), ConvolutionDetectorResolution::apply1dConvolution(), ConvolutionDetectorResolution::apply2dConvolution(), MaskUnitsConverter::convert(), DataUtils::coordinateFromBinf(), DataUtils::coordinateToBinf(), OutputData< T >::copyShapeFrom(), DataUtils::create2DArrayfromOutputData(), DataUtils::createClippedDataSet(), DataUtils::createRearrangedDataSet(), ImportDataUtils::CreateSimplifiedOutputData(), OutputData< T >::hasSameDimensions(), OutputData< T >::hasSameShape(), DetectorMask::initMaskData(), OutputDataReadWriteNumpyTXT::write1DRepresentation(), OutputDataReadWriteNumpyTXT::write2DRepresentation(), OutputDataReadWriteINT::writeOutputData(), IHistogram::xAxis(), and IHistogram::yAxis().

axisNameExists()

template<class T >

bool OutputData< T >::axisNameExists ( const std::string &  axis_name ) const

private

checks if given axis name exists

Definition at line 619 of file OutputData.h.

{
    for (size_t i = 0; i < m_value_axes.size(); ++i)
        if (m_value_axes[i]->getName() == axis_name)
            return true;
    return false;
}

begin() [1/2]

template<class T >

OutputData< T >::iterator OutputData< T >::begin

Returns read/write iterator that points to the first element.

Definition at line 343 of file OutputData.h.

{
    typename OutputData<T>::iterator result(this);
    return result;
}

Referenced by ConvolutionDetectorResolution::apply2dConvolution(), DataUtils::createClippedDataSet(), Histogram1D::crop(), Histogram2D::crop(), IntensityDataItem::dataRange(), SpecularDataItem::dataRange(), Data1DViewItem::dataRange(), DataFormatUtils::fillOutputData(), IHistogram::getMaximum(), IHistogram::getMaximumBinIndex(), IHistogram::getMinimum(), IHistogram::getMinimumBinIndex(), and OutputDataReadWriteINT::writeOutputDataDoubles().

begin() [2/2]

template<class T >

OutputData< T >::const_iterator OutputData< T >::begin

Returns read-only iterator that points to the first element.

Definition at line 349 of file OutputData.h.

{
    typename OutputData<T>::const_iterator result(this);
    return result;
}

clear()

template<class T >

void OutputData< T >::clear

Sets object into initial state (no dimensions, data)

Definition at line 470 of file OutputData.h.

{
    m_value_axes.clear();
    allocate();
}

Referenced by DetectorMask::addMask(), DetectorMask::initMaskData(), and OffSpecularSimulation::updateIntensityMap().

clone()

template<class T >

OutputData< T > * OutputData< T >::clone

Definition at line 259 of file OutputData.h.

{
    OutputData<T>* ret = new OutputData<T>();
    ret->m_value_axes = m_value_axes;
    (*ret->m_ll_data) = *m_ll_data;
    return ret;
}

References OutputData< T >::m_ll_data, and OutputData< T >::m_value_axes.

Referenced by MaskResultsPresenter::backup_data(), JobModelFunctions::copyRealDataItem(), MaskResultsPresenter::createMaskPresentation(), FitObjectiveBuilder::createOutputData(), QREDataLoader::createOutputDataFromParsingResult(), DataUtils::createRearrangedDataSet(), DataUtils::createRelativeDifferenceData(), and OffSpecularSimulation::result().

copyFrom()

template<class T >

void OutputData< T >::copyFrom

(

const OutputData< T > &

x

)

Definition at line 267 of file OutputData.h.

{
    clear();
    m_value_axes = other.m_value_axes;
    delete m_ll_data;
    m_ll_data = 0;
    if (other.m_ll_data)
        m_ll_data = new LLData<T>(*other.m_ll_data);
}

References OutputData< T >::m_ll_data, and OutputData< T >::m_value_axes.

Referenced by DetectorMask::DetectorMask(), IHistogram::IHistogram(), OffSpecularSimulation::OffSpecularSimulation(), and DetectorMask::operator=().

copyShapeFrom()

template<class T >

template<class U >

void OutputData< T >::copyShapeFrom

(

const OutputData< U > &

other

)

Definition at line 277 of file OutputData.h.

{
    clear();
    size_t rank = other.rank();
    for (size_t i = 0; i < rank; ++i)
        addAxis(other.axis(i));
}

References OutputData< T >::axis(), and OutputData< T >::rank().

Referenced by DetectorMask::createHistogram(), IHistogram::createOutputData(), and IHistogram::init_from_data().

Here is the call graph for this function:

end() [1/2]

template<class T >

iterator OutputData< T >::end ( )

inline

Returns read/write iterator that points to the one past last element.

Definition at line 93 of file OutputData.h.

{ return iterator(this, getAllocatedSize()); }

References OutputData< T >::getAllocatedSize().

Referenced by ConvolutionDetectorResolution::apply2dConvolution(), DataUtils::createClippedDataSet(), Histogram1D::crop(), Histogram2D::crop(), IntensityDataItem::dataRange(), SpecularDataItem::dataRange(), Data1DViewItem::dataRange(), DataFormatUtils::fillOutputData(), IHistogram::getMaximum(), IHistogram::getMaximumBinIndex(), IHistogram::getMinimum(), IHistogram::getMinimumBinIndex(), and OutputDataReadWriteINT::writeOutputDataDoubles().

Here is the call graph for this function:

end() [2/2]

template<class T >

const_iterator OutputData< T >::end ( ) const

inline

Returns read-only iterator that points to the one past last element.

Definition at line 96 of file OutputData.h.

{ return const_iterator(this, getAllocatedSize()); }

References OutputData< T >::getAllocatedSize().

Here is the call graph for this function:

findGlobalIndex()

template<class T >

size_t OutputData< T >::findGlobalIndex

(

const std::vector< double > &

coordinates

)

const

Returns global index for specified axes values.

Parameters

coordinates

Vector of axes coordinates for all specified axes in this dataset

Returns

Closest global index

Definition at line 416 of file OutputData.h.

{
    ASSERT(m_ll_data);
    if (coordinates.size() != m_ll_data->rank())
        throw std::runtime_error("OutputData<T>::findClosestIndex() -> "
                                 "Error! Number of coordinates must match rank of data structure");
    std::vector<unsigned> axes_indexes;
    axes_indexes.resize(m_ll_data->rank());
    for (size_t i = 0; i < m_ll_data->rank(); ++i)
        axes_indexes[i] = static_cast<unsigned>(m_value_axes[i]->findClosestIndex(coordinates[i]));
    return toGlobalIndex(axes_indexes);
}

References ASSERT.

Referenced by Histogram2D::fill(), and IHistogram::findGlobalBin().

getAllocatedSize()

template<class T >

size_t OutputData< T >::getAllocatedSize ( ) const

inline

Returns total size of data buffer (product of bin number in every dimension).

Definition at line 59 of file OutputData.h.

    {
        if (m_ll_data)
            return m_ll_data->getTotalSize();
        return 0;
    }

References OutputData< T >::m_ll_data.

Referenced by DetectorMask::createHistogram(), MaskResultsPresenter::createMaskPresentation(), DataUtils::createRearrangedDataSet(), OutputData< T >::end(), IHistogram::getTotalNumberOfBins(), IHistogram::init_from_data(), DetectorMask::process_masks(), DataUtils::relativeDataDifference(), OffSpecularSimulation::transferDetectorImage(), and OffSpecularSimulation::transferResultsToIntensityMap().

getAllSizes()

template<class T >

std::vector< size_t > OutputData< T >::getAllSizes

inline

Returns all sizes of its axes.

Definition at line 323 of file OutputData.h.

{
    ASSERT(m_ll_data);
    std::vector<size_t> result;
    for (size_t i = 0; i < rank(); ++i) {
        int dim = m_ll_data->dimensions()[i];
        result.push_back(dim);
    }
    return result;
}

References ASSERT.

getArray()

template<class T >

PyObject* OutputData< T >::getArray

(

)

const

returns data as Python numpy array

getAxesBinIndices()

template<class T >

std::vector< int > OutputData< T >::getAxesBinIndices

(

size_t

global_index

)

const

Returns vector of axes indices for given global index.

Parameters

global_index

The global index of this data structure.

Returns

Vector of bin indices for all axes defined

Definition at line 355 of file OutputData.h.

{
    ASSERT(m_ll_data);
    size_t remainder = global_index;
    std::vector<int> result;
    result.resize(m_ll_data->rank());
    for (size_t i = 0; i < m_ll_data->rank(); ++i) {
        result[m_ll_data->rank() - 1 - i] =
            (int)(remainder % m_value_axes[m_ll_data->rank() - 1 - i]->size());
        remainder /= m_value_axes[m_ll_data->rank() - 1 - i]->size();
    }
    return result;
}

References ASSERT.

Referenced by DataUtils::createRearrangedDataSet().

getAxesValues()

template<class T >

std::vector< double > OutputData< T >::getAxesValues

(

size_t

global_index

)

const

Returns values on all defined axes for given globalbin number.

Parameters

global_index

The global index of this data structure.

Returns

Vector of corresponding bin centers

Definition at line 442 of file OutputData.h.

{
    std::vector<int> indices = getAxesBinIndices(global_index);
    std::vector<double> result;
    for (size_t i_axis = 0; i_axis < indices.size(); ++i_axis)
        result.push_back((*m_value_axes[i_axis])[indices[i_axis]]);
    return result;
}

getAxisBin() [1/2]

template<class T >

Bin1D OutputData< T >::getAxisBin	(	size_t	global_index,
		const std::string &	axis_name
	)		const

Returns bin of selected axis for given global_index.

Parameters

global_index	The global index of this data structure.
axis_name	The name of selected axis.

Returns

Corresponding Bin1D object

Definition at line 459 of file OutputData.h.

{
    return getAxisBin(global_index, getAxisIndex(axis_name));
}

getAxisBin() [2/2]

template<class T >

Bin1D OutputData< T >::getAxisBin	(	size_t	global_index,
		size_t	i_selected_axis
	)		const

Returns bin of selected axis for given global_index.

Parameters

global_index	The global index of this data structure.
i_selected_axis	Serial number of selected axis.

Returns

Corresponding Bin1D object

Definition at line 452 of file OutputData.h.

{
    auto axis_index = getAxisBinIndex(global_index, i_selected_axis);
    return m_value_axes[i_selected_axis]->bin(axis_index);
}

Referenced by DetectorMask::process_masks().

getAxisBinIndex() [1/2]

template<class T >

size_t OutputData< T >::getAxisBinIndex	(	size_t	global_index,
		const std::string &	axis_name
	)		const

Returns axis bin index for given global index.

Parameters

global_index	The global index of this data structure.
axis_name	The name of selected axis.

Returns

Corresponding bin index for selected axis

Definition at line 386 of file OutputData.h.

{
    return getAxisBinIndex(global_index, getAxisIndex(axis_name));
}

getAxisBinIndex() [2/2]

template<class T >

size_t OutputData< T >::getAxisBinIndex	(	size_t	global_index,
		size_t	i_selected_axis
	)		const

Returns axis bin index for given global index.

Parameters

global_index	The global index of this data structure.
i_selected_axis	Serial number of selected axis.

Returns

Corresponding bin index for selected axis

Definition at line 370 of file OutputData.h.

{
    ASSERT(m_ll_data);
    size_t remainder(global_index);
    for (size_t i = 0; i < m_ll_data->rank(); ++i) {
        size_t i_axis = m_ll_data->rank() - 1 - i;
        size_t result = remainder % m_value_axes[i_axis]->size();
        if (i_selected_axis == i_axis)
            return result;
        remainder /= m_value_axes[i_axis]->size();
    }
    throw std::runtime_error("OutputData<T>::getAxisBinIndex() -> "
                             "Error! No axis with given number");
}

References ASSERT.

Referenced by IHistogram::xAxisIndex(), and IHistogram::yAxisIndex().

getAxisIndex()

template<class T >

size_t OutputData< T >::getAxisIndex ( const std::string &  axis_name ) const

private

returns serial number of axis with given name

Definition at line 609 of file OutputData.h.

{
    for (size_t i = 0; i < m_value_axes.size(); ++i)
        if (m_value_axes[i]->getName() == axis_name)
            return i;
    throw std::runtime_error("OutputData<T>::getAxisIndex() -> "
                             "Error! Axis with given name not found '"
                             + axis_name + "'");
}

getAxisValue() [1/2]

template<class T >

double OutputData< T >::getAxisValue	(	size_t	global_index,
		const std::string &	axis_name
	)		const

Returns the value of selected axis for given global_index.

Parameters

global_index	The global index of this data structure.
axis_name	The name of selected axis.

Returns

corresponding bin center of selected axis

Definition at line 437 of file OutputData.h.

{
    return getAxisValue(global_index, getAxisIndex(axis_name));
}

getAxisValue() [2/2]

template<class T >

double OutputData< T >::getAxisValue	(	size_t	global_index,
		size_t	i_selected_axis
	)		const

Returns the value of selected axis for given global_index.

Parameters

global_index	The global index of this data structure.
i_selected_axis	Serial number of selected axis.

Returns

corresponding bin center of selected axis

Definition at line 430 of file OutputData.h.

{
    auto axis_index = getAxisBinIndex(global_index, i_selected_axis);
    return (*m_value_axes[i_selected_axis])[axis_index];
}

Referenced by DataUtils::createClippedDataSet(), Histogram1D::crop(), Histogram2D::crop(), SpecularPlot::setDataFromItem(), IHistogram::xAxisValue(), and IHistogram::yAxisValue().

getRawDataVector()

template<class T >

std::vector< T > OutputData< T >::getRawDataVector

inline

Returns copy of raw data vector.

Definition at line 334 of file OutputData.h.

{
    ASSERT(m_ll_data);
    std::vector<T> result;
    for (size_t i = 0; i < getAllocatedSize(); ++i)
        result.push_back((*m_ll_data)[i]);
    return result;
}

References ASSERT.

Referenced by ConvolutionDetectorResolution::apply1dConvolution(), ConvolutionDetectorResolution::apply2dConvolution(), ISimulation::convertData(), IUnitConverter::createConvertedData(), UnitConverter1D::createConvertedData(), ImportDataUtils::CreateSimplifiedOutputData(), DataViewUtils::getTranslatedData(), and JobItemUtils::updateDataAxes().

getValue()

template<class T >

double OutputData< T >::getValue

(

size_t

index

)

const

Returns value or summed value, depending on T.

hasSameDimensions()

template<class T >

template<class U >

bool OutputData< T >::hasSameDimensions ( const OutputData< U > &  right ) const

inline

Returns true if object have same dimensions and number of axes bins.

Returns true if object have same dimensions.

Definition at line 575 of file OutputData.h.

{
    if (!isInitialized())
        return false;
    if (!right.isInitialized())
        return false;
    if (rank() != right.rank())
        return false;
    for (size_t i_axis = 0; i_axis < rank(); ++i_axis)
        if (axis(i_axis).size() != right.axis(i_axis).size())
            return false;
    return true;
}

References OutputData< T >::axis(), OutputData< T >::isInitialized(), OutputData< T >::rank(), and IAxis::size().

Referenced by DataUtils::createRelativeDifferenceData(), IHistogram::hasSameDimensions(), and DataUtils::relativeDataDifference().

Here is the call graph for this function:

hasSameShape()

template<class T >

template<class U >

bool OutputData< T >::hasSameShape

(

const OutputData< U > &

right

)

const

Returns true if objects a) have same dimensions b) bin boundaries of axes coincide.

Returns true if object have same dimensions and shape of axis.

Definition at line 592 of file OutputData.h.

{
    if (!hasSameDimensions(right))
        return false;
 
    for (size_t i = 0; i < m_value_axes.size(); ++i)
        if (!HaveSameNameAndShape(axis(i), right.axis(i)))
            return false;
    return true;
}

References OutputData< T >::axis(), and HaveSameNameAndShape().

Referenced by IHistogram::hasSameShape().

Here is the call graph for this function:

isInitialized()

template<class T >

bool OutputData< T >::isInitialized

returns true if object is correctly initialized

Definition at line 524 of file OutputData.h.

{
    if (!m_ll_data)
        return false;
    if (rank() != m_ll_data->rank())
        return false;
    if (!rank())
        return false;
    return true;
}

Referenced by OutputData< T >::hasSameDimensions().

meanValues()

template<class T >

OutputData< double > * OutputData< T >::meanValues

Definition at line 285 of file OutputData.h.

{
    auto* ret = new OutputData<double>();
    ret->copyShapeFrom(*this);
    ret->allocate();
    for (size_t i = 0; i < m_ll_data->getTotalSize(); ++i)
        (*ret)[i] = getValue(i);
    return ret;
}

Referenced by HistoUtils::getRelativeDifference().

operator*=()

template<class T >

const OutputData< T > & OutputData< T >::operator*=

(

const OutputData< T > &

right

)

multiplication-assignment operator for two output data

Definition at line 517 of file OutputData.h.

{
    ASSERT(m_ll_data);
    *this->m_ll_data *= *right.m_ll_data;
    return *this;
}

References ASSERT, and OutputData< T >::m_ll_data.

operator+=()

template<class T >

const OutputData< T > & OutputData< T >::operator+=

(

const OutputData< T > &

right

)

addition-assignment operator for two output data

Definition at line 503 of file OutputData.h.

{
    ASSERT(m_ll_data);
    *this->m_ll_data += *right.m_ll_data;
    return *this;
}

References ASSERT, and OutputData< T >::m_ll_data.

operator-=()

template<class T >

const OutputData< T > & OutputData< T >::operator-=

(

const OutputData< T > &

right

)

substraction-assignment operator for two output data

Definition at line 510 of file OutputData.h.

{
    ASSERT(m_ll_data);
    *this->m_ll_data -= *right.m_ll_data;
    return *this;
}

References ASSERT, and OutputData< T >::m_ll_data.

operator/=()

template<class T >

const OutputData< T > & OutputData< T >::operator/=

(

const OutputData< T > &

right

)

division-assignment operator for two output data

Definition at line 535 of file OutputData.h.

{
    ASSERT(m_ll_data);
    *this->m_ll_data /= *right.m_ll_data;
    return *this;
}

References ASSERT, and OutputData< T >::m_ll_data.

operator=()

template<class T >

const OutputData& OutputData< T >::operator= ( const OutputData< T > &  )

delete

operator[]() [1/2]

template<class T >

T& OutputData< T >::operator[] ( size_t  index )

inline

indexed accessor

Definition at line 192 of file OutputData.h.

    {
        ASSERT(m_ll_data);
        return (*m_ll_data)[index];
    }

References ASSERT, and OutputData< T >::m_ll_data.

operator[]() [2/2]

template<class T >

const T& OutputData< T >::operator[] ( size_t  index ) const

inline

indexed accessor (const)

Definition at line 199 of file OutputData.h.

    {
        ASSERT(m_ll_data);
        return (*m_ll_data)[index];
    }

References ASSERT, and OutputData< T >::m_ll_data.

rank()

template<class T >

size_t OutputData< T >::rank ( ) const

inline

Returns number of dimensions.

Definition at line 56 of file OutputData.h.

{ return m_value_axes.size(); }

References OutputData< T >::m_value_axes, and SafePointerVector< T >::size().

Referenced by RegionOfInterest::RegionOfInterest(), ConvolutionDetectorResolution::apply1dConvolution(), ConvolutionDetectorResolution::apply2dConvolution(), ConvolutionDetectorResolution::applyDetectorResolution(), OutputData< T >::copyShapeFrom(), DataUtils::create2DArrayfromOutputData(), DataUtils::createClippedDataSet(), IUnitConverter::createConvertedData(), UnitConverter1D::createConvertedData(), IHistogram::createHistogram(), DataUtils::createRearrangedDataSet(), ImportDataUtils::CreateSimplifiedOutputData(), OutputData< T >::hasSameDimensions(), IHistogram::init_from_data(), DetectorMask::initMaskData(), RealDataItem::setOutputData(), IntensityDataItem::setOutputData(), SpecularDataItem::setOutputData(), OutputDataReadWriteINT::writeOutputData(), and OutputDataReadWriteNumpyTXT::writeOutputData().

Here is the call graph for this function:

scaleAll()

template<class T >

void OutputData< T >::scaleAll

(

const T &

factor

)

multiply every item of this output data by value

Definition at line 484 of file OutputData.h.

{
    if (!m_ll_data)
        throw std::runtime_error(
            "OutputData::scaleAll() -> Error! Low-level data object was not yet initialized.");
    m_ll_data->scaleAll(factor);
}

setAllTo()

template<class T >

void OutputData< T >::setAllTo

(

const T &

value

)

Sets content of output data to specific value.

Definition at line 476 of file OutputData.h.

{
    if (!m_ll_data)
        throw std::runtime_error(
            "OutputData::setAllTo() -> Error! Low-level data object was not yet initialized.");
    m_ll_data->setAll(value);
}

Referenced by DetectorMaskDelegate::createIntensityDataItem(), DataFormatUtils::fillOutputData(), DetectorMask::process_masks(), IHistogram::reset(), SpecularSimulation::result(), and OffSpecularSimulation::updateIntensityMap().

setAxisSizes()

template<class T >

void OutputData< T >::setAxisSizes	(	size_t	rank,
		int *	n_dims
	)

Adds 'rank' axes with indicated sizes.

Definition at line 492 of file OutputData.h.

{
    clear();
    std::string basename("axis");
    for (size_t i = 0; i < rank; ++i) {
        std::ostringstream name;
        name << basename << i;
        addAxis(name.str(), n_dims[i], 0.0, (double)(n_dims[i] - 1));
    }
}

References RealSpace::Particles::name().

Here is the call graph for this function:

setRawDataArray()

template<class T >

void OutputData< T >::setRawDataArray ( const T *  source )

inline

Sets new values to raw data array.

Definition at line 566 of file OutputData.h.

{
    for (size_t i = 0; i < getAllocatedSize(); ++i)
        (*m_ll_data)[i] = source[i];
}

setRawDataVector()

template<class T >

void OutputData< T >::setRawDataVector ( const std::vector< T > &  data_vector )

inline

Sets new values to raw data vector.

Definition at line 556 of file OutputData.h.

{
    if (data_vector.size() != getAllocatedSize())
        throw std::runtime_error(
            "OutputData<T>::setRawDataVector() -> Error! "
            "setRawDataVector can only be called with a data vector of the correct size.");
    for (size_t i = 0; i < getAllocatedSize(); ++i)
        (*m_ll_data)[i] = data_vector[i];
}

Referenced by ConvolutionDetectorResolution::apply1dConvolution(), IDetector::applyDetectorResolution(), QREDataLoader::createOutputDataFromParsingResult(), OutputDataReadReflectometry::readOutputData(), and SpecularSimulation::result().

toGlobalIndex()

template<class T >

size_t OutputData< T >::toGlobalIndex

(

const std::vector< unsigned > &

axes_indices

)

const

Returns global index for specified indices of axes.

Parameters

axes_indices

Vector of axes indices for all specified axes in this dataset

Returns

Corresponding global index

Definition at line 392 of file OutputData.h.

{
    ASSERT(m_ll_data);
    if (axes_indices.size() != m_ll_data->rank())
        throw std::runtime_error("size_t OutputData<T>::toGlobalIndex() -> "
                                 "Error! Number of coordinates must match rank of data structure");
    size_t result = 0;
    size_t step_size = 1;
    for (size_t i = m_ll_data->rank(); i > 0; --i) {
        if (axes_indices[i - 1] >= m_value_axes[i - 1]->size()) {
            std::ostringstream message;
            message << "size_t OutputData<T>::toGlobalIndex() -> Error. Index ";
            message << axes_indices[i - 1] << " is out of range. Axis ";
            message << m_value_axes[i - 1]->getName();
            message << " size " << m_value_axes[i - 1]->size() << ".\n";
            throw std::runtime_error(message.str());
        }
        result += axes_indices[i - 1] * step_size;
        step_size *= m_value_axes[i - 1]->size();
    }
    return result;
}

References ASSERT.

Referenced by IHistogram::getGlobalBin().

totalSum()

template<class T >

T OutputData< T >::totalSum

inline

Returns sum of all values in the data structure.

Definition at line 464 of file OutputData.h.

{
    ASSERT(m_ll_data);
    return m_ll_data->getTotalSum();
}

References ASSERT.

Friends And Related Function Documentation

OutputDataIterator< const T, const OutputData< T > >

template<class T >

friend class OutputDataIterator< const T, const OutputData< T > >

friend

Definition at line 73 of file OutputData.h.

OutputDataIterator< T, OutputData< T > >

template<class T >

friend class OutputDataIterator< T, OutputData< T > >

friend

Definition at line 73 of file OutputData.h.

Member Data Documentation

m_ll_data

template<class T >

LLData<T>* OutputData< T >::m_ll_data

private

Definition at line 232 of file OutputData.h.

Referenced by OutputData< T >::clone(), OutputData< T >::copyFrom(), OutputData< T >::getAllocatedSize(), OutputData< T >::operator*=(), OutputData< T >::operator+=(), OutputData< T >::operator-=(), OutputData< T >::operator/=(), and OutputData< T >::operator[]().

m_value_axes

template<class T >

SafePointerVector<IAxis> OutputData< T >::m_value_axes

private

Definition at line 231 of file OutputData.h.

Referenced by OutputData< T >::clone(), OutputData< T >::copyFrom(), and OutputData< T >::rank().

---

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

• /home/www/ba/Device/Data/OutputData.h