gui2::MaterialProfile Namespace Reference

Collection of methods borrowed from BornAgain for material profile calculations. More...

Functions
DAREFLCORE_EXPORT std::vector< complex_t >	CalculateProfile (const multislice_t &multilayer, int n_points, double z_min, double z_max)
	Calculate average material profile for given multilayer. More...
DAREFLCORE_EXPORT std::pair< double, double >	DefaultMaterialProfileLimits (const multislice_t &multilayer)
	Get default z limits for generating a material profile. More...
DAREFLCORE_EXPORT std::vector< double >	GenerateZValues (int n_points, double z_min, double z_max)
	Generate z values (equidistant) for use in MaterialProfile. More...

Detailed Description

Collection of methods borrowed from BornAgain for material profile calculations.

Function Documentation

CalculateProfile()

std::vector< complex_t > gui2::MaterialProfile::CalculateProfile	(	const multislice_t &	multilayer,
		int	n_points,
		double	z_min,
		double	z_max
	)

Calculate average material profile for given multilayer.

Definition at line 22 of file materialprofile.cpp.

{
    auto baSlices = Utils::createBornAgainSlices(multilayer);
    ProfileHelper helper(baSlices);
    std::vector<double> z_values = GenerateZValues(n_points, z_min, z_max);
    return helper.calculateProfile(z_values);
}

References gui2::ProfileHelper::calculateProfile(), gui2::Utils::createBornAgainSlices(), and GenerateZValues().

Referenced by gui2::SpecularToySimulation::sld_profile().

Here is the call graph for this function:

DefaultMaterialProfileLimits()

std::pair< double, double > gui2::MaterialProfile::DefaultMaterialProfileLimits

(

const multislice_t &

multilayer

)

Get default z limits for generating a material profile.

Definition at line 32 of file materialprofile.cpp.

{
    auto baSlices = Utils::createBornAgainSlices(multilayer);
    ProfileHelper helper(baSlices);
    return helper.defaultLimits();
}

References gui2::Utils::createBornAgainSlices(), and gui2::ProfileHelper::defaultLimits().

Referenced by gui2::SpecularToySimulation::sld_profile().

Here is the call graph for this function:

GenerateZValues()

std::vector< double > gui2::MaterialProfile::GenerateZValues	(	int	n_points,
		double	z_min,
		double	z_max
	)

Generate z values (equidistant) for use in MaterialProfile.

Definition at line 39 of file materialprofile.cpp.

{
    std::vector<double> result;
    if (n_points < 1)
        return result;
    double step = n_points > 1 ? (z_max - z_min) / (n_points - 1) : 0.0;
    for (int i = 0; i < n_points; ++i) {
        result.push_back(z_min + i * step);
    }
    return result;
}

Referenced by CalculateProfile().