IntensityDataFunctions Namespace Reference

Functions
double	RelativeDifference (const SimulationResult &dat, const SimulationResult &ref)
double	getRelativeDifference (const OutputData< double > &dat, const OutputData< double > &ref)
bool	checkRelativeDifference (const OutputData< double > &dat, const OutputData< double > &ref, const double threshold)
double	getRelativeDifference (const IHistogram &dat, const IHistogram &ref)
double	coordinateToBinf (double coordinate, const IAxis &axis)
double	coordinateFromBinf (double value, const IAxis &axis)
void	coordinateToBinf (double &x, double &y, const OutputData< double > &data)
void	coordinateFromBinf (double &x, double &y, const OutputData< double > &data)
std::vector< std::vector< double > >	create2DArrayfromOutputData (const OutputData< double > &data)
std::vector< std::vector< double > >	FT2DArray (const std::vector< std::vector< double >> &signal)
std::unique_ptr< OutputData< double > >	createRelativeDifferenceData (const OutputData< double > &data, const OutputData< double > &reference)
std::unique_ptr< OutputData< double > >	createRearrangedDataSet (const OutputData< double > &data, int n)
std::unique_ptr< OutputData< double > >	createClippedDataSet (const OutputData< double > &origin, double x1, double y1, double x2, double y2)
std::unique_ptr< OutputData< double > >	createOutputDatafrom2DArray (const std::vector< std::vector< double >> &array_2d)
std::unique_ptr< OutputData< double > >	createFFT (const OutputData< double > &data)

Detailed Description

Functions to work with intensity data.

Function Documentation

RelativeDifference()

double IntensityDataFunctions::RelativeDifference	(	const SimulationResult &	dat,
		const SimulationResult &	ref
	)

Returns sum of relative differences between each pair of elements: (a, b) -> 2*abs(a - b)/(a + b) ( and zero if a-b=0 )

Returns sum of relative differences between each pair of elements: (a, b) -> 2*abs(a - b)/(|a| + |b|) ( and zero if a=b=0 within epsilon )

Definition at line 28 of file IntensityDataFunctions.cpp.

{
    if (dat.size() != ref.size())
        throw std::runtime_error("Error in IntensityDataFunctions::RelativeDifference: "
                                 "different number of elements");
    if (dat.empty())
        return 0.0;
    double sum_of_diff = 0.0;
    for (size_t i = 0; i < dat.size(); ++i) {
        sum_of_diff += Numeric::GetRelativeDifference(dat[i], ref[i]);
    }
    return sum_of_diff / dat.size();
}

References SimulationResult::empty(), Numeric::GetRelativeDifference(), and SimulationResult::size().

Here is the call graph for this function:

getRelativeDifference() [1/2]

double IntensityDataFunctions::getRelativeDifference	(	const OutputData< double > &	dat,
		const OutputData< double > &	ref
	)

Returns relative difference between two data sets sum(dat[i] - ref[i])/ref[i]).

Definition at line 44 of file IntensityDataFunctions.cpp.

{
    if (!dat.hasSameDimensions(ref))
        throw Exceptions::RuntimeErrorException(
            "IntensityDataFunctions::getRelativeDifference() -> "
            "Error. Different dimensions of data and reference.");
 
    double diff = 0.0;
    for (size_t i = 0; i < dat.getAllocatedSize(); ++i)
        diff += Numeric::GetRelativeDifference(dat[i], ref[i]);
    diff /= dat.getAllocatedSize();
 
    if (std::isnan(diff))
        throw Exceptions::RuntimeErrorException("diff=NaN!");
    return diff;
}

References OutputData< T >::getAllocatedSize(), Numeric::GetRelativeDifference(), and OutputData< T >::hasSameDimensions().

Referenced by checkRelativeDifference(), and getRelativeDifference().

Here is the call graph for this function:

checkRelativeDifference()

bool IntensityDataFunctions::checkRelativeDifference	(	const OutputData< double > &	dat,
		const OutputData< double > &	ref,
		const double	threshold
	)

Returns true is relative difference is below threshold; prints informative output.

Definition at line 69 of file IntensityDataFunctions.cpp.

{
    const double diff = getRelativeDifference(dat, ref);
    if (diff > threshold) {
        std::cerr << "  => FAILED: relative deviation of dat from ref is " << diff
                  << ", above given threshold " << threshold << "\n";
        return false;
    }
    if (diff)
        std::cerr << "  => OK: relative deviation of dat from ref is " << diff
                  << ", within given threshold " << threshold << "\n";
    else
        std::cout << "  => OK: dat = ref\n";
    return true;
}

References getRelativeDifference().

Here is the call graph for this function:

getRelativeDifference() [2/2]

double IntensityDataFunctions::getRelativeDifference	(	const IHistogram &	dat,
		const IHistogram &	ref
	)

Definition at line 62 of file IntensityDataFunctions.cpp.

{
    return getRelativeDifference(*std::unique_ptr<OutputData<double>>(dat.getData().meanValues()),
                                 *std::unique_ptr<OutputData<double>>(ref.getData().meanValues()));
}

References IHistogram::getData(), getRelativeDifference(), and OutputData< T >::meanValues().

Here is the call graph for this function:

coordinateToBinf() [1/2]

double IntensityDataFunctions::coordinateToBinf	(	double	coordinate,
		const IAxis &	axis
	)

Transforms coordinate on axis into the bin-fraction-coordinate.

Definition at line 189 of file IntensityDataFunctions.cpp.

{
    size_t index = axis.findClosestIndex(coordinate);
    Bin1D bin = axis.getBin(index);
    double f = (coordinate - bin.m_lower) / bin.getBinSize();
    return static_cast<double>(index) + f;
}

References IAxis::findClosestIndex(), IAxis::getBin(), Bin1D::getBinSize(), and Bin1D::m_lower.

Referenced by coordinateToBinf().

Here is the call graph for this function:

coordinateFromBinf() [1/2]

double IntensityDataFunctions::coordinateFromBinf	(	double	value,
		const IAxis &	axis
	)

Transforms bin-fraction-coordinate into axis coordinate.

Definition at line 197 of file IntensityDataFunctions.cpp.

{
    int index = static_cast<int>(value);
 
    double result(0);
    if (index < 0) {
        Bin1D bin = axis.getBin(0);
        result = bin.m_lower + value * bin.getBinSize();
    } else if (index >= static_cast<int>(axis.size())) {
        Bin1D bin = axis.getBin(axis.size() - 1);
        result = bin.m_upper + (value - axis.size()) * bin.getBinSize();
    } else {
        Bin1D bin = axis.getBin(static_cast<size_t>(index));
        result = bin.m_lower + (value - static_cast<double>(index)) * bin.getBinSize();
    }
 
    return result;
}

References IAxis::getBin(), Bin1D::getBinSize(), Bin1D::m_lower, Bin1D::m_upper, and IAxis::size().

Referenced by coordinateFromBinf().

Here is the call graph for this function:

coordinateToBinf() [2/2]

void IntensityDataFunctions::coordinateToBinf	(	double &	x,
		double &	y,
		const OutputData< double > &	data
	)

Transforms x,y coordinate from OutputData axes coordinates to bin-fraction-coordinates.

Definition at line 216 of file IntensityDataFunctions.cpp.

{
    x = coordinateToBinf(x, data.getAxis(0));
    y = coordinateToBinf(y, data.getAxis(1));
}

References coordinateToBinf(), and OutputData< T >::getAxis().

Here is the call graph for this function:

coordinateFromBinf() [2/2]

void IntensityDataFunctions::coordinateFromBinf	(	double &	x,
		double &	y,
		const OutputData< double > &	data
	)

Transforms x,y coordinate from bin-fraction-coordinates to OutputData's axes coordinates.

Definition at line 222 of file IntensityDataFunctions.cpp.

{
    x = coordinateFromBinf(x, data.getAxis(0));
    y = coordinateFromBinf(y, data.getAxis(1));
}

References coordinateFromBinf(), and OutputData< T >::getAxis().

Here is the call graph for this function:

create2DArrayfromOutputData()

std::vector< std::vector< double > > IntensityDataFunctions::create2DArrayfromOutputData

(

const OutputData< double > &

data

)

Creates a vector of vectors of double (2D Array) from OutputData.

Definition at line 230 of file IntensityDataFunctions.cpp.

{
    if (data.getRank() != 2)
        throw Exceptions::LogicErrorException(
            "IntensityDataFunctions::create2DArrayfromOutputData() -> "
            "Error! Works only on two-dimensional data");
 
    std::vector<std::vector<double>> array_2d;
    std::vector<double> row_vec; // row vector for constructing each row of 2D array
 
    size_t nrows = data.getAxis(0).size();
    size_t ncols = data.getAxis(1).size();
 
    size_t it = 0; // iterator of 'data'
    for (size_t row = 0; row < nrows; row++) {
        row_vec.clear();
        for (size_t col = 0; col < ncols; col++) {
            row_vec.push_back(data[it]);
            it++;
        }
        array_2d.push_back(row_vec);
    }
 
    return array_2d;
}

References OutputData< T >::getAxis(), OutputData< T >::getRank(), and IAxis::size().

Referenced by createFFT().

Here is the call graph for this function:

FT2DArray()

std::vector< std::vector< double > > IntensityDataFunctions::FT2DArray

(

const std::vector< std::vector< double >> &

signal

)

Creates a Fourier Transform of a 2D Array (vector of vectors).

Definition at line 257 of file IntensityDataFunctions.cpp.

{
    FourierTransform ft;
    std::vector<std::vector<double>> fft_array;
    ft.fft(signal, fft_array);
    // shifting low frequency to center of array
    ft.fftshift(fft_array);
 
    return fft_array;
}

References FourierTransform::fft(), and FourierTransform::fftshift().

Referenced by createFFT().

Here is the call graph for this function:

createRelativeDifferenceData()

std::unique_ptr< OutputData< double > > IntensityDataFunctions::createRelativeDifferenceData	(	const OutputData< double > &	data,
		const OutputData< double > &	reference
	)

Definition at line 88 of file IntensityDataFunctions.cpp.

{
    if (!data.hasSameDimensions(reference))
        throw Exceptions::RuntimeErrorException(
            "IntensityDataFunctions::createRelativeDifferenceData() -> "
            "Error. Different dimensions of data and reference.");
    std::unique_ptr<OutputData<double>> result(reference.clone());
    for (size_t i = 0; i < result->getAllocatedSize(); ++i)
        (*result)[i] = Numeric::GetRelativeDifference(data[i], reference[i]);
    return result;
}

References OutputData< T >::clone(), Numeric::GetRelativeDifference(), and OutputData< T >::hasSameDimensions().

Here is the call graph for this function:

createRearrangedDataSet()

std::unique_ptr< OutputData< double > > IntensityDataFunctions::createRearrangedDataSet	(	const OutputData< double > &	data,
		int	n
	)

Returns new object with input data rotated by n*90 deg counterclockwise (n > 0) or clockwise (n < 0) Axes are swapped if the data is effectively rotated by 90 or 270 degrees Applicable to 2D arrays only.

Definition at line 102 of file IntensityDataFunctions.cpp.

{
    if (data.getRank() != 2)
        throw Exceptions::LogicErrorException("IntensityDataFunctions::rotateDataByN90Deg()"
                                              " -> Error! Works only on two-dimensional data");
    n = (4 + n % 4) % 4;
    if (n == 0)
        return std::unique_ptr<OutputData<double>>(data.clone());
    std::unique_ptr<OutputData<double>> output(new OutputData<double>());
 
    // swapping axes if necessary
    const IAxis& x_axis = data.getAxis(0);
    const IAxis& y_axis = data.getAxis(1);
    output->addAxis(n == 2 ? x_axis : y_axis);
    output->addAxis(n == 2 ? y_axis : x_axis);
 
    // creating index mapping
    std::function<void(std::vector<int>&)> index_mapping;
    if (n == 2) {
        const int end_bin_x = static_cast<int>(x_axis.size()) - 1;
        const int end_bin_y = static_cast<int>(y_axis.size()) - 1;
        index_mapping = [end_bin_x, end_bin_y](std::vector<int>& inds) {
            inds[0] = end_bin_x - inds[0];
            inds[1] = end_bin_y - inds[1];
        };
    } else {
        const size_t rev_axis_i = n % 3;
        const size_t end_bin = data.getAxis(rev_axis_i).size() - 1;
        index_mapping = [rev_axis_i, end_bin](std::vector<int>& inds) {
            const int tmp_index = inds[rev_axis_i];
            inds[rev_axis_i] = inds[rev_axis_i ^ 1];
            inds[rev_axis_i ^ 1] = static_cast<int>(end_bin) - tmp_index;
        };
    }
 
    for (size_t index = 0, size = data.getAllocatedSize(); index < size; ++index) {
        std::vector<int> axis_inds = data.getAxesBinIndices(index);
        index_mapping(axis_inds);
        size_t output_index = output->toGlobalIndex(
            {static_cast<unsigned>(axis_inds[0]), static_cast<unsigned>(axis_inds[1])});
        (*output)[output_index] = data[index];
    }
    return output;
}

References OutputData< T >::clone(), OutputData< T >::getAllocatedSize(), OutputData< T >::getAxesBinIndices(), OutputData< T >::getAxis(), OutputData< T >::getRank(), and IAxis::size().

Here is the call graph for this function:

createClippedDataSet()

std::unique_ptr< OutputData< double > > IntensityDataFunctions::createClippedDataSet	(	const OutputData< double > &	origin,
		double	x1,
		double	y1,
		double	x2,
		double	y2
	)

Returns new IntensityData objects which axes clipped to represent the specified rectangle.

Definition at line 148 of file IntensityDataFunctions.cpp.

{
    if (origin.getRank() != 2)
        throw Exceptions::LogicErrorException("IntensityDataFunctions::createClippedData()"
                                              " -> Error! Works only on two-dimensional data");
 
    std::unique_ptr<OutputData<double>> result(new OutputData<double>);
    for (size_t i_axis = 0; i_axis < origin.getRank(); i_axis++) {
        const IAxis& axis = origin.getAxis(i_axis);
        IAxis* new_axis;
        if (i_axis == 0)
            new_axis = axis.createClippedAxis(x1, x2);
        else
            new_axis = axis.createClippedAxis(y1, y2);
        result->addAxis(*new_axis);
        delete new_axis;
    }
    result->setAllTo(0.0);
 
    OutputData<double>::const_iterator it_origin = origin.begin();
    OutputData<double>::iterator it_result = result->begin();
    while (it_origin != origin.end()) {
        double x = origin.getAxisValue(it_origin.getIndex(), 0);
        double y = origin.getAxisValue(it_origin.getIndex(), 1);
        if (result->getAxis(0).contains(x) && result->getAxis(1).contains(y)) {
            *it_result = *it_origin;
            ++it_result;
        }
        ++it_origin;
    }
 
    return result;
}

References OutputData< T >::begin(), IAxis::createClippedAxis(), OutputData< T >::end(), OutputData< T >::getAxis(), OutputData< T >::getAxisValue(), and OutputData< T >::getRank().

Here is the call graph for this function:

createOutputDatafrom2DArray()

std::unique_ptr< OutputData< double > > IntensityDataFunctions::createOutputDatafrom2DArray

(

const std::vector< std::vector< double >> &

array_2d

)

Creates OutputData from a 2D Array.

Definition at line 268 of file IntensityDataFunctions.cpp.

{
    std::unique_ptr<OutputData<double>> result(new OutputData<double>);
    size_t nrows = array_2d.size();
    size_t ncols = array_2d[0].size();
 
    result->addAxis("x", nrows, 0.0, double(nrows));
    result->addAxis("y", ncols, 0.0, double(ncols));
    std::vector<unsigned> axes_indices(2);
    for (unsigned row = 0; row < nrows; row++) {
        for (unsigned col = 0; col < ncols; col++) {
            axes_indices[0] = row;
            axes_indices[1] = col;
            size_t global_index = result->toGlobalIndex(axes_indices);
            (*result)[global_index] = array_2d[row][col];
        }
    }
 
    return result;
}

Referenced by createFFT().

createFFT()

std::unique_ptr< OutputData< double > > IntensityDataFunctions::createFFT

(

const OutputData< double > &

data

)

Creates Fourier Transform (OutputData format) of intensity map (OutputData format).

Definition at line 291 of file IntensityDataFunctions.cpp.

{
    auto array_2d = IntensityDataFunctions::create2DArrayfromOutputData(data);
    auto fft_array_2d = IntensityDataFunctions::FT2DArray(array_2d);
    return IntensityDataFunctions::createOutputDatafrom2DArray(fft_array_2d);
}

References create2DArrayfromOutputData(), createOutputDatafrom2DArray(), and FT2DArray().

Here is the call graph for this function: