ConvolutionDetectorResolution Class Reference

Description

Convolutes the intensity in 1 or 2 dimensions with a resolution function.

Limitation: this class assumes that the data points are evenly distributed on each axis

Definition at line 31 of file ConvolutionDetectorResolution.h.

Inheritance diagram for ConvolutionDetectorResolution:

Collaboration diagram for ConvolutionDetectorResolution:

Public Types
using	cumulative_DF_1d = double(*)(double)

Public Member Functions
	ConvolutionDetectorResolution (const IResolutionFunction2D &p_res_function_2d)
	Constructor taking a 2 dimensional resolution function as argument. More...
	ConvolutionDetectorResolution (cumulative_DF_1d res_function_1d)
	Constructor taking a 1 dimensional resolution function as argument. More...
	~ConvolutionDetectorResolution () override
void	applyDetectorResolution (Datafield *p_intensity_map) const override
	Convolve given intensities with the encapsulated resolution. More...
void	checkNodeArgs () const
	Raises exception if a parameter value is invalid. More...
std::string	className () const final
	Returns the class name, to be hard-coded in each leaf class that inherits from INode. More...
ConvolutionDetectorResolution *	clone () const override
const IResolutionFunction2D *	getResolutionFunction2D () const
std::vector< const INode * >	nodeChildren () const override
	Returns all children. More...
std::vector< const INode * >	nodeOffspring () const
	Returns all descendants. More...
virtual std::vector< ParaMeta >	parDefs () const
	Returns the parameter definitions, to be hard-coded in each leaf class. More...
virtual void	transferToCPP ()
	Used for Python overriding of clone (see swig/tweaks.py) More...

Protected Member Functions
	ConvolutionDetectorResolution (const ConvolutionDetectorResolution &other)

Protected Attributes
std::vector< double >	m_P

Private Member Functions
void	apply1dConvolution (Datafield *p_intensity_map) const
void	apply2dConvolution (Datafield *p_intensity_map) const
double	getIntegratedPDF1d (double x, double step) const
double	getIntegratedPDF2d (double x, double step_x, double y, double step_y) const
void	setResolutionFunction (const IResolutionFunction2D &resFunc)

Private Attributes
size_t	m_rank
cumulative_DF_1d	m_res_function_1d
std::unique_ptr< IResolutionFunction2D >	m_res_function_2d

Member Typedef Documentation

cumulative_DF_1d

using ConvolutionDetectorResolution::cumulative_DF_1d = double (*)(double)

Definition at line 33 of file ConvolutionDetectorResolution.h.

Constructor & Destructor Documentation

ConvolutionDetectorResolution() [1/3]

ConvolutionDetectorResolution::ConvolutionDetectorResolution

(

cumulative_DF_1d

res_function_1d

)

Constructor taking a 1 dimensional resolution function as argument.

Definition at line 22 of file ConvolutionDetectorResolution.cpp.

    : m_rank(1)
    , m_res_function_1d(res_function_1d)
{
}

Referenced by clone().

ConvolutionDetectorResolution() [2/3]

ConvolutionDetectorResolution::ConvolutionDetectorResolution

(

const IResolutionFunction2D &

p_res_function_2d

)

Constructor taking a 2 dimensional resolution function as argument.

Definition at line 28 of file ConvolutionDetectorResolution.cpp.

    : m_rank(2)
    , m_res_function_1d(nullptr)
{
    setResolutionFunction(p_res_function_2d);
}

References setResolutionFunction().

Here is the call graph for this function:

~ConvolutionDetectorResolution()

ConvolutionDetectorResolution::~ConvolutionDetectorResolution ( )

overridedefault

ConvolutionDetectorResolution() [3/3]

ConvolutionDetectorResolution::ConvolutionDetectorResolution ( const ConvolutionDetectorResolution &  other )

protected

Definition at line 38 of file ConvolutionDetectorResolution.cpp.

{
    m_rank = other.m_rank;
    m_res_function_1d = other.m_res_function_1d;
    if (other.m_res_function_2d)
        setResolutionFunction(*other.m_res_function_2d);
}

References m_rank, m_res_function_1d, m_res_function_2d, and setResolutionFunction().

Here is the call graph for this function:

Member Function Documentation

apply1dConvolution()

void ConvolutionDetectorResolution::apply1dConvolution ( Datafield *  p_intensity_map ) const

private

Definition at line 83 of file ConvolutionDetectorResolution.cpp.

{
    ASSERT(m_res_function_1d == nullptr);
    if (p_intensity_map->rank() != 1)
        throw std::runtime_error(
            "ConvolutionDetectorResolution::apply1dConvolution() -> Error! "
            "Number of axes for intensity map does not correspond to the dimension of the map.");
    const IAxis& axis = p_intensity_map->axis(0);
    // Construct source vector from original intensity map
    std::vector<double> source_vector = p_intensity_map->flatVector();
    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 std::runtime_error(
            "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
    for (double& e : result)
        e = std::max(0.0, e);
    // Populate intensity map with results
    p_intensity_map->setVector(result);
}

References ASSERT, Datafield::axis(), Convolve::fftconvolve(), Datafield::flatVector(), getIntegratedPDF1d(), m_res_function_1d, Datafield::rank(), Datafield::setVector(), and IAxis::size().

Referenced by applyDetectorResolution().

Here is the call graph for this function:

apply2dConvolution()

void ConvolutionDetectorResolution::apply2dConvolution ( Datafield *  p_intensity_map ) const

private

Definition at line 116 of file ConvolutionDetectorResolution.cpp.

{
    ASSERT(m_res_function_2d);
    if (p_intensity_map->rank() != 2)
        throw std::runtime_error(
            "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->axis(0);
    const IAxis& axis_2 = p_intensity_map->axis(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->flatVector();
    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 std::runtime_error(
            "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);
        }
    }
    ASSERT(axis_size_1 * axis_size_2 == p_intensity_map->size());
    for (size_t i = 0; i < p_intensity_map->size(); ++i) {
        size_t i0 = p_intensity_map->frame().projectedIndex(i, 0);
        size_t i1 = p_intensity_map->frame().projectedIndex(i, 1);
        (*p_intensity_map)[i] = std::max(0.0, result[i0][i1]);
    }
}

References ASSERT, Datafield::axis(), Convolve::fftconvolve(), Datafield::flatVector(), Datafield::frame(), getIntegratedPDF2d(), m_res_function_2d, Frame::projectedIndex(), Datafield::rank(), Datafield::size(), and IAxis::size().

Referenced by applyDetectorResolution().

Here is the call graph for this function:

applyDetectorResolution()

void ConvolutionDetectorResolution::applyDetectorResolution ( Datafield *  p_intensity_map ) const

overridevirtual

Convolve given intensities with the encapsulated resolution.

Implements IDetectorResolution.

Definition at line 57 of file ConvolutionDetectorResolution.cpp.

{
    if (p_intensity_map->rank() != m_rank) {
        throw std::runtime_error(
            "ConvolutionDetectorResolution::applyDetectorResolution() -> Error! "
            "Intensity map must have same dimension as detector resolution function.");
    }
    switch (m_rank) {
    case 1:
        apply1dConvolution(p_intensity_map);
        break;
    case 2:
        apply2dConvolution(p_intensity_map);
        break;
    default:
        throw std::runtime_error(
            "ConvolutionDetectorResolution::applyDetectorResolution() -> Error! "
            "Class ConvolutionDetectorResolution must be initialized with dimension 1 or 2.");
    }
}

References apply1dConvolution(), apply2dConvolution(), m_rank, and Datafield::rank().

Here is the call graph for this function:

checkNodeArgs()

void INode::checkNodeArgs ( ) const

inherited

Raises exception if a parameter value is invalid.

Definition at line 27 of file INode.cpp.

{
    size_t nP = m_P.size();
    if (parDefs().size() != nP) {
        std::cerr << "BUG in class " << className() << std::endl;
        std::cerr << "#m_P = " << nP << std::endl;
        std::cerr << "#PDf = " << parDefs().size() << std::endl;
        for (const ParaMeta& pm : parDefs())
            std::cerr << "  PDf: " << pm.name << std::endl;
        ASSERT(0);
    }
    ASSERT(parDefs().size() == nP);
    for (size_t i = 0; i < nP; ++i) {
        const ParaMeta pm = parDefs()[i];
 
        RealLimits limits = RealLimits::limitless();
        if (pm.vMin == -INF) {
            ASSERT(pm.vMax == +INF);
            // nothing to do
        } else if (pm.vMax == +INF) {
            ASSERT(pm.vMin == 0);
            limits = RealLimits::nonnegative();
        } else {
            limits = RealLimits::limited(pm.vMin, pm.vMax);
        }
        limits.check(pm.name, m_P[i]);
    }
}

References ASSERT, RealLimits::check(), INode::className(), INF, RealLimits::limited(), RealLimits::limitless(), INode::m_P, ParaMeta::name, RealLimits::nonnegative(), INode::parDefs(), ParaMeta::vMax, and ParaMeta::vMin.

Referenced by BarGauss::BarGauss(), BarLorentz::BarLorentz(), Bipyramid4::Bipyramid4(), Box::Box(), CantellatedCube::CantellatedCube(), Cone::Cone(), ConstantBackground::ConstantBackground(), CosineRippleBox::CosineRippleBox(), CosineRippleGauss::CosineRippleGauss(), CosineRippleLorentz::CosineRippleLorentz(), Cylinder::Cylinder(), DistributionCosine::DistributionCosine(), DistributionGate::DistributionGate(), DistributionGaussian::DistributionGaussian(), DistributionLogNormal::DistributionLogNormal(), DistributionLorentz::DistributionLorentz(), DistributionTrapezoid::DistributionTrapezoid(), Dodecahedron::Dodecahedron(), EllipsoidalCylinder::EllipsoidalCylinder(), FootprintGauss::FootprintGauss(), FootprintSquare::FootprintSquare(), FuzzySphere::FuzzySphere(), GaussSphere::GaussSphere(), HemiEllipsoid::HemiEllipsoid(), HollowSphere::HollowSphere(), HorizontalCylinder::HorizontalCylinder(), Icosahedron::Icosahedron(), LongBoxGauss::LongBoxGauss(), LongBoxLorentz::LongBoxLorentz(), PlatonicOctahedron::PlatonicOctahedron(), PlatonicTetrahedron::PlatonicTetrahedron(), Prism3::Prism3(), Prism6::Prism6(), Profile1DCauchy::Profile1DCauchy(), Profile1DCosine::Profile1DCosine(), Profile1DGate::Profile1DGate(), Profile1DGauss::Profile1DGauss(), Profile1DTriangle::Profile1DTriangle(), Profile1DVoigt::Profile1DVoigt(), Profile2DCauchy::Profile2DCauchy(), Profile2DCone::Profile2DCone(), Profile2DGate::Profile2DGate(), Profile2DGauss::Profile2DGauss(), Profile2DVoigt::Profile2DVoigt(), Pyramid2::Pyramid2(), Pyramid3::Pyramid3(), Pyramid4::Pyramid4(), Pyramid6::Pyramid6(), RotationEuler::RotationEuler(), RotationX::RotationX(), RotationY::RotationY(), RotationZ::RotationZ(), SawtoothRippleBox::SawtoothRippleBox(), SawtoothRippleGauss::SawtoothRippleGauss(), SawtoothRippleLorentz::SawtoothRippleLorentz(), Sphere::Sphere(), Spheroid::Spheroid(), TruncatedCube::TruncatedCube(), TruncatedSphere::TruncatedSphere(), and TruncatedSpheroid::TruncatedSpheroid().

Here is the call graph for this function:

className()

std::string ConvolutionDetectorResolution::className ( ) const

inlinefinalvirtual

Returns the class name, to be hard-coded in each leaf class that inherits from INode.

Implements INode.

Definition at line 44 of file ConvolutionDetectorResolution.h.

{ return "ConvolutionDetectorResolution"; }

clone()

ConvolutionDetectorResolution * ConvolutionDetectorResolution::clone ( ) const

overridevirtual

Implements IDetectorResolution.

Definition at line 47 of file ConvolutionDetectorResolution.cpp.

{
    return new ConvolutionDetectorResolution(*this);
}

References ConvolutionDetectorResolution().

Here is the call graph for this function:

getIntegratedPDF1d()

double ConvolutionDetectorResolution::getIntegratedPDF1d ( double  x, double  step  ) const

private

Definition at line 178 of file ConvolutionDetectorResolution.cpp.

{
    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);
}

References ASSERT, and m_res_function_1d.

Referenced by apply1dConvolution().

getIntegratedPDF2d()

double ConvolutionDetectorResolution::getIntegratedPDF2d ( double  x, double  step_x, double  y, double  step_y  ) const

private

Definition at line 187 of file ConvolutionDetectorResolution.cpp.

{
    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 =
        m_res_function_2d->evaluateCDF(xmax, ymax) - m_res_function_2d->evaluateCDF(xmax, ymin)
        - m_res_function_2d->evaluateCDF(xmin, ymax) + m_res_function_2d->evaluateCDF(xmin, ymin);
    return result;
}

References m_res_function_2d.

Referenced by apply2dConvolution().

getResolutionFunction2D()

const IResolutionFunction2D * ConvolutionDetectorResolution::getResolutionFunction2D ( ) const

inline

Definition at line 68 of file ConvolutionDetectorResolution.h.

{
    return m_res_function_2d.get();
}

References m_res_function_2d.

nodeChildren()

std::vector< const INode * > ConvolutionDetectorResolution::nodeChildren ( ) const

overridevirtual

Returns all children.

Reimplemented from INode.

Definition at line 52 of file ConvolutionDetectorResolution.cpp.

{
    return std::vector<const INode*>() << m_res_function_2d;
}

References m_res_function_2d.

nodeOffspring()

std::vector< const INode * > INode::nodeOffspring ( ) const

inherited

Returns all descendants.

Definition at line 61 of file INode.cpp.

{
    std::vector<const INode*> result;
    result.push_back(this);
    for (const auto* child : nodeChildren()) {
        for (const auto* p : child->nodeOffspring())
            result.push_back(p);
    }
    return result;
}

References INode::nodeChildren().

Here is the call graph for this function:

parDefs()

virtual std::vector<ParaMeta> INode::parDefs ( ) const

inlinevirtualinherited

Returns the parameter definitions, to be hard-coded in each leaf class.

Reimplemented in ConstantBackground, GaussSphere, FuzzySphere, RotationEuler, RotationZ, RotationY, RotationX, Crystal, Layer, HexagonalLattice2D, SquareLattice2D, BasicLattice2D, LayerRoughness, TruncatedSpheroid, TruncatedSphere, TruncatedCube, Spheroid, Sphere, SawtoothRippleLorentz, SawtoothRippleGauss, SawtoothRippleBox, Pyramid6, Pyramid4, Pyramid3, Pyramid2, Prism6, Prism3, PlatonicTetrahedron, PlatonicOctahedron, LongBoxLorentz, LongBoxGauss, Icosahedron, HorizontalCylinder, HollowSphere, HemiEllipsoid, EllipsoidalCylinder, Dodecahedron, Cylinder, CosineRippleLorentz, CosineRippleGauss, CosineRippleBox, Cone, CantellatedCube, Box, Bipyramid4, BarLorentz, BarGauss, Profile2DVoigt, Profile2DCone, Profile2DGate, Profile2DGauss, Profile2DCauchy, Profile1DVoigt, Profile1DCosine, Profile1DTriangle, Profile1DGate, Profile1DGauss, Profile1DCauchy, MisesGaussPeakShape, MisesFisherGaussPeakShape, LorentzFisherPeakShape, GaussFisherPeakShape, IsotropicLorentzPeakShape, IsotropicGaussPeakShape, ParticleLayout, InterferenceTwin, InterferenceRadialParaCrystal, InterferenceHardDisk, Interference2DSuperLattice, Interference2DParaCrystal, Interference1DLattice, DistributionTrapezoid, DistributionCosine, DistributionLogNormal, DistributionGaussian, DistributionLorentz, DistributionGate, ResolutionFunction2DGaussian, PolFilter, FootprintSquare, and FootprintGauss.

Definition at line 51 of file INode.h.

{ return {}; }

Referenced by INode::checkNodeArgs(), and IFormFactor::pythonConstructor().

setResolutionFunction()

void ConvolutionDetectorResolution::setResolutionFunction ( const IResolutionFunction2D &  resFunc )

private

Definition at line 78 of file ConvolutionDetectorResolution.cpp.

{
    m_res_function_2d.reset(resFunc.clone());
}

References IResolutionFunction2D::clone(), and m_res_function_2d.

Referenced by ConvolutionDetectorResolution().

Here is the call graph for this function:

transferToCPP()

virtual void ICloneable::transferToCPP ( )

inlinevirtualinherited

Used for Python overriding of clone (see swig/tweaks.py)

Definition at line 32 of file ICloneable.h.

Member Data Documentation

m_P

std::vector<double> INode::m_P

protectedinherited

Definition at line 63 of file INode.h.

Referenced by IFootprintFactor::IFootprintFactor(), INode::checkNodeArgs(), IProfile1D::pythonConstructor(), IProfile2D::pythonConstructor(), IFormFactor::pythonConstructor(), Profile1DVoigt::pythonConstructor(), and Profile2DVoigt::pythonConstructor().

m_rank

size_t ConvolutionDetectorResolution::m_rank

private

Definition at line 63 of file ConvolutionDetectorResolution.h.

Referenced by ConvolutionDetectorResolution(), and applyDetectorResolution().

m_res_function_1d

cumulative_DF_1d ConvolutionDetectorResolution::m_res_function_1d

private

Definition at line 64 of file ConvolutionDetectorResolution.h.

Referenced by ConvolutionDetectorResolution(), apply1dConvolution(), and getIntegratedPDF1d().

m_res_function_2d

std::unique_ptr<IResolutionFunction2D> ConvolutionDetectorResolution::m_res_function_2d

private

Definition at line 65 of file ConvolutionDetectorResolution.h.

Referenced by ConvolutionDetectorResolution(), apply2dConvolution(), getIntegratedPDF2d(), getResolutionFunction2D(), nodeChildren(), and setResolutionFunction().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Device/Resolution/ConvolutionDetectorResolution.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Device/Resolution/ConvolutionDetectorResolution.cpp