ProfileHelper Class Reference

Description

Object that can generate the material profile of a sample as a function of depth.

The generated profile contains the complex SLD for SLD materials and the parameters delta and beta for refractive index materials

Definition at line 34 of file ProfileHelper.h.

Collaboration diagram for ProfileHelper:

Public Member Functions
	ProfileHelper (const SliceStack &stack)
	~ProfileHelper ()=default
std::vector< complex_t >	calculateProfile (const std::vector< double > &z_values) const
std::pair< double, double >	defaultLimits () const

Private Attributes
const SliceStack &	m_stack

Constructor & Destructor Documentation

ProfileHelper()

ProfileHelper::ProfileHelper

(

const SliceStack &

stack

)

Definition at line 38 of file ProfileHelper.cpp.

    : m_stack(stack)
{
}

~ProfileHelper()

ProfileHelper::~ProfileHelper ( )

default

Member Function Documentation

calculateProfile()

std::vector< complex_t > ProfileHelper::calculateProfile

(

const std::vector< double > &

z_values

)

const

Definition at line 46 of file ProfileHelper.cpp.

{
    const complex_t top_value = !m_stack.empty() ? m_stack.at(0).material().materialData() : 0.0;
    std::vector<complex_t> result(z_values.size(), top_value);
    for (size_t i = 1; i < m_stack.size(); ++i) {
        const Slice& slice = m_stack.at(i);
        const Slice& sliceAbove = m_stack.at(i - 1);
        const complex_t sld_diff =
            slice.material().materialData() - sliceAbove.material().materialData();
        for (size_t j = 0; j < z_values.size(); ++j) {
            const double arg = (z_values[j] - slice.zTop());
            const LayerRoughness* roughness = slice.topRoughness();
            const double t = Transition(arg, roughness ? roughness->sigma() : 0);
            result[j] += sld_diff * t;
        }
    }
    return result;
}

References m_stack, Slice::material(), Material::materialData(), LayerRoughness::sigma(), Slice::topRoughness(), and Slice::zTop().

Referenced by swigAPI::materialProfileSLD().

Here is the call graph for this function:

defaultLimits()

std::pair< double, double > ProfileHelper::defaultLimits

(

)

const

Definition at line 65 of file ProfileHelper.cpp.

{
    if (m_stack.size() < 2)
        return {0.0, 0.0};
    double interface_span = m_stack.front().zBottom() - m_stack.back().zTop();
    double default_margin = interface_span > 0.0 ? interface_span / 20.0 : 10.0;
    const LayerRoughness* topRoughness = m_stack.at(1).topRoughness();
    const LayerRoughness* bottomRoughness = m_stack.back().topRoughness();
 
    double top_margin =
        topRoughness && topRoughness->sigma() > 0 ? 5.0 * topRoughness->sigma() : default_margin;
    double bottom_margin = bottomRoughness && bottomRoughness->sigma() > 0
                               ? 5.0 * bottomRoughness->sigma()
                               : default_margin;
    double z_min = m_stack.back().zTop() - bottom_margin;
    double z_max = m_stack.front().zBottom() + top_margin;
    return {z_min, z_max};
}

References m_stack, and LayerRoughness::sigma().

Referenced by swigAPI::defaultMaterialProfileLimits().

Here is the call graph for this function:

Member Data Documentation

m_stack

const SliceStack& ProfileHelper::m_stack

private

Definition at line 43 of file ProfileHelper.h.

Referenced by calculateProfile(), and defaultLimits().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Resample/Slice/ProfileHelper.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Resample/Slice/ProfileHelper.cpp