ProfileHelper Class Reference

Collaboration diagram for ProfileHelper:

Public Member Functions
	ProfileHelper (const ProcessedSample &sample)
	~ProfileHelper ()
std::vector< complex_t >	calculateProfile (const std::vector< double > &z_values) const
std::pair< double, double >	defaultLimits () const

Private Attributes
std::vector< complex_t >	m_materialdata
std::vector< double >	m_zlimits
std::vector< double >	m_sigmas

Detailed 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 31 of file ProfileHelper.h.

Constructor & Destructor Documentation

ProfileHelper()

ProfileHelper::ProfileHelper

(

const ProcessedSample &

sample

)

Definition at line 26 of file ProfileHelper.cpp.

{
    auto N = sample.numberOfSlices();
    m_materialdata.reserve(N);
    if (N > 1) {
        m_zlimits.reserve(N - 1);
        m_sigmas.reserve(N - 1);
    }
    auto& slices = sample.averageSlices();
    for (size_t i = 0; i < N; ++i) {
        m_materialdata.push_back(slices[i].material().materialData());
        if (i + 1 < N) {
            m_zlimits.push_back(sample.sliceBottomZ(i));
            if (auto p_roughness = sample.bottomRoughness(i)) {
                m_sigmas.push_back(p_roughness->getSigma());
            } else {
                m_sigmas.push_back(0.0);
            }
        }
    }
}

References ProcessedSample::averageSlices(), ProcessedSample::bottomRoughness(), m_materialdata, m_sigmas, m_zlimits, ProcessedSample::numberOfSlices(), and ProcessedSample::sliceBottomZ().

Here is the call graph for this function:

~ProfileHelper()

ProfileHelper::~ProfileHelper ( )

default

Member Function Documentation

calculateProfile()

std::vector< complex_t > ProfileHelper::calculateProfile

(

const std::vector< double > &

z_values

)

const

Definition at line 51 of file ProfileHelper.cpp.

{
    complex_t top_value = m_materialdata.size() ? m_materialdata[0] : 0.0;
    std::vector<complex_t> result(z_values.size(), top_value);
    for (size_t i = 0; i < m_zlimits.size(); ++i) {
        auto sld_diff = m_materialdata[i + 1] - m_materialdata[i];
        for (size_t j = 0; j < z_values.size(); ++j) {
            auto arg = (z_values[j] - m_zlimits[i]);
            auto t = Transition(arg, m_sigmas[i]);
            result[j] += sld_diff * t;
        }
    }
    return result;
}

References m_materialdata, m_sigmas, m_zlimits, and anonymous_namespace{ProfileHelper.cpp}::Transition().

Referenced by MaterialProfile().

Here is the call graph for this function:

defaultLimits()

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

(

)

const

Definition at line 66 of file ProfileHelper.cpp.

{
    if (m_zlimits.size() < 1)
        return {0.0, 0.0};
    double interface_span = m_zlimits.front() - m_zlimits.back();
    double default_margin = interface_span > 0.0 ? interface_span / 20.0 : 10.0;
    double top_margin = m_sigmas.front() > 0.0 ? 5.0 * m_sigmas.front() : default_margin;
    double bottom_margin = m_sigmas.back() > 0.0 ? 5.0 * m_sigmas.back() : default_margin;
    double z_min = m_zlimits.back() - bottom_margin;
    double z_max = m_zlimits.front() + top_margin;
    return {z_min, z_max};
}

References m_sigmas, and m_zlimits.

Referenced by DefaultMaterialProfileLimits().

Member Data Documentation

m_materialdata

std::vector<complex_t> ProfileHelper::m_materialdata

private

Definition at line 41 of file ProfileHelper.h.

Referenced by calculateProfile(), and ProfileHelper().

m_zlimits

std::vector<double> ProfileHelper::m_zlimits

private

Definition at line 42 of file ProfileHelper.h.

Referenced by calculateProfile(), defaultLimits(), and ProfileHelper().

m_sigmas

std::vector<double> ProfileHelper::m_sigmas

private

Definition at line 43 of file ProfileHelper.h.

Referenced by calculateProfile(), defaultLimits(), and ProfileHelper().

---

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

• /home/www/ba/Core/Computation/ProfileHelper.h
• /home/www/ba/Core/Computation/ProfileHelper.cpp