ConvolutionDetectorResolution.cpp

Go to the documentation of this file.

// ************************************************************************** //
//
//  BornAgain: simulate and fit scattering at grazing incidence
//
//! @file      Device/Resolution/ConvolutionDetectorResolution.cpp
//! @brief     Implements class ConvolutionDetectorResolution.
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
// ************************************************************************** //
 
#include "Device/Resolution/ConvolutionDetectorResolution.h"
#include "Device/Resolution/Convolve.h"
 
ConvolutionDetectorResolution::ConvolutionDetectorResolution(cumulative_DF_1d res_function_1d)
    : m_dimension(1), m_res_function_1d(res_function_1d)
{
    setName("ConvolutionDetectorResolution");
}
 
ConvolutionDetectorResolution::ConvolutionDetectorResolution(
    const IResolutionFunction2D& p_res_function_2d)
    : m_dimension(2), m_res_function_1d(0)
{
    setName("ConvolutionDetectorResolution");
    setResolutionFunction(p_res_function_2d);
}
 
ConvolutionDetectorResolution::~ConvolutionDetectorResolution() = default;
 
ConvolutionDetectorResolution::ConvolutionDetectorResolution(
    const ConvolutionDetectorResolution& other)
{
    m_dimension = other.m_dimension;
    m_res_function_1d = other.m_res_function_1d;
    if (other.mp_res_function_2d)
        setResolutionFunction(*other.mp_res_function_2d);
    setName(other.getName());
}
 
ConvolutionDetectorResolution* ConvolutionDetectorResolution::clone() const
{
    return new ConvolutionDetectorResolution(*this);
}
 
std::vector<const INode*> ConvolutionDetectorResolution::getChildren() const
{
    return std::vector<const INode*>() << mp_res_function_2d;
}
 
void ConvolutionDetectorResolution::applyDetectorResolution(
    OutputData<double>* p_intensity_map) const
{
    if (p_intensity_map->getRank() != m_dimension) {
        throw Exceptions::RuntimeErrorException(
            "ConvolutionDetectorResolution::applyDetectorResolution() -> Error! "
            "Intensity map must have same dimension as detector resolution function.");
    }
    switch (m_dimension) {
    case 1:
        apply1dConvolution(p_intensity_map);
        break;
    case 2:
        apply2dConvolution(p_intensity_map);
        break;
    default:
        throw Exceptions::LogicErrorException(
            "ConvolutionDetectorResolution::applyDetectorResolution() -> Error! "
            "Class ConvolutionDetectorResolution must be initialized with dimension 1 or 2.");
    }
}
 
void ConvolutionDetectorResolution::setResolutionFunction(const IResolutionFunction2D& resFunc)
{
    mp_res_function_2d.reset(resFunc.clone());
    registerChild(mp_res_function_2d.get());
}
 
void ConvolutionDetectorResolution::apply1dConvolution(OutputData<double>* p_intensity_map) const
{
    if (m_res_function_1d == 0)
        throw Exceptions::LogicErrorException(
            "ConvolutionDetectorResolution::apply1dConvolution() -> Error! "
            "No 1d resolution function present for convolution of 1d data.");
    if (p_intensity_map->getRank() != 1)
        throw Exceptions::LogicErrorException(
            "ConvolutionDetectorResolution::apply1dConvolution() -> Error! "
            "Number of axes for intensity map does not correspond to the dimension of the map.");
    const IAxis& axis = p_intensity_map->getAxis(0);
    // Construct source vector from original intensity map
    std::vector<double> source_vector = p_intensity_map->getRawDataVector();
    size_t data_size = source_vector.size();
    if (data_size < 2)
        return; // No convolution for sets of zero or one element
    // Construct kernel vector from resolution function
    if (axis.size() != data_size)
        throw Exceptions::LogicErrorException(
            "ConvolutionDetectorResolution::apply1dConvolution() -> Error! "
            "Size of axis for intensity map does not correspond to size of data in the map.");
    double step_size = std::abs(axis[0] - axis[axis.size() - 1]) / (data_size - 1);
    double mid_value = axis[axis.size() / 2]; // because Convolve expects zero at midpoint
    std::vector<double> kernel;
    for (size_t index = 0; index < data_size; ++index) {
        kernel.push_back(getIntegratedPDF1d(axis[index] - mid_value, step_size));
    }
    // Calculate convolution
    std::vector<double> result;
    Convolve().fftconvolve(source_vector, kernel, result);
    // Truncate negative values that can arise because of finite precision of Fourier Transform
    std::for_each(result.begin(), result.end(), [](double& val) { val = std::max(0.0, val); });
    // Populate intensity map with results
    p_intensity_map->setRawDataVector(result);
}
 
void ConvolutionDetectorResolution::apply2dConvolution(OutputData<double>* p_intensity_map) const
{
    if (mp_res_function_2d == 0)
        throw Exceptions::LogicErrorException(
            "ConvolutionDetectorResolution::apply2dConvolution() -> Error! "
            "No 2d resolution function present for convolution of 2d data.");
    if (p_intensity_map->getRank() != 2)
        throw Exceptions::LogicErrorException(
            "ConvolutionDetectorResolution::apply2dConvolution() -> Error! "
            "Number of axes for intensity map does not correspond to the dimension of the map.");
    const IAxis& axis_1 = p_intensity_map->getAxis(0);
    const IAxis& axis_2 = p_intensity_map->getAxis(1);
    size_t axis_size_1 = axis_1.size();
    size_t axis_size_2 = axis_2.size();
    if (axis_size_1 < 2 || axis_size_2 < 2)
        return; // No 2d convolution for 1d data
    // Construct source vector array from original intensity map
    std::vector<double> raw_source_vector = p_intensity_map->getRawDataVector();
    std::vector<std::vector<double>> source;
    size_t raw_data_size = raw_source_vector.size();
    if (raw_data_size != axis_size_1 * axis_size_2)
        throw Exceptions::LogicErrorException(
            "ConvolutionDetectorResolution::apply2dConvolution() -> Error! "
            "Intensity map data size does not match the product of its axes' sizes");
    for (auto it = raw_source_vector.begin(); it != raw_source_vector.end(); it += axis_size_2) {
        std::vector<double> row_vector(it, it + axis_size_2);
        source.push_back(row_vector);
    }
    // Construct kernel vector from resolution function
    std::vector<std::vector<double>> kernel;
    kernel.resize(axis_size_1);
    double mid_value_1 = axis_1[axis_size_1 / 2]; // because Convolve expects zero at midpoint
    double mid_value_2 = axis_2[axis_size_2 / 2]; // because Convolve expects zero at midpoint
    double step_size_1 = std::abs(axis_1[0] - axis_1[axis_size_1 - 1]) / (axis_size_1 - 1);
    double step_size_2 = std::abs(axis_2[0] - axis_2[axis_size_2 - 1]) / (axis_size_2 - 1);
    for (size_t index_1 = 0; index_1 < axis_size_1; ++index_1) {
        double value_1 = axis_1[index_1] - mid_value_1;
        std::vector<double> row_vector;
        row_vector.resize(axis_size_2, 0.0);
        for (size_t index_2 = 0; index_2 < axis_size_2; ++index_2) {
            double value_2 = axis_2[index_2] - mid_value_2;
            double z_value = getIntegratedPDF2d(value_1, step_size_1, value_2, step_size_2);
            row_vector[index_2] = z_value;
        }
        kernel[index_1] = row_vector;
    }
    // Calculate convolution
    std::vector<std::vector<double>> result;
    Convolve().fftconvolve(source, kernel, result);
    // Populate intensity map with results
    std::vector<double> result_vector;
    for (size_t index_1 = 0; index_1 < axis_size_1; ++index_1) {
        for (size_t index_2 = 0; index_2 < axis_size_2; ++index_2) {
            double value = result[index_1][index_2];
            result_vector.push_back(value);
        }
    }
    // Truncate negative values that can arise because of finite precision of Fourier Transform
    std::for_each(result_vector.begin(), result_vector.end(),
                  [](double& val) { val = std::max(0.0, val); });
    for (auto it = p_intensity_map->begin(); it != p_intensity_map->end(); ++it)
        (*it) = result_vector[it.getIndex()];
}
 
double ConvolutionDetectorResolution::getIntegratedPDF1d(double x, double step) const
{
    double halfstep = step / 2.0;
    double xmin = x - halfstep;
    double xmax = x + halfstep;
    ASSERT(m_res_function_1d != nullptr);
    return m_res_function_1d(xmax) - m_res_function_1d(xmin);
}
 
double ConvolutionDetectorResolution::getIntegratedPDF2d(double x, double step_x, double y,
                                                         double step_y) const
{
    double halfstepx = step_x / 2.0;
    double halfstepy = step_y / 2.0;
    double xmin = x - halfstepx;
    double xmax = x + halfstepx;
    double ymin = y - halfstepy;
    double ymax = y + halfstepy;
    double result =
        mp_res_function_2d->evaluateCDF(xmax, ymax) - mp_res_function_2d->evaluateCDF(xmax, ymin)
        - mp_res_function_2d->evaluateCDF(xmin, ymax) + mp_res_function_2d->evaluateCDF(xmin, ymin);
    return result;
}