swigAPI Namespace Reference

Functions
std::pair< double, double >	defaultMaterialProfileLimits (const MultiLayer &multilayer)
	Get default z limits for generating a material profile. More...
std::vector< double >	generateZValues (int n_points, double z_min, double z_max)
std::vector< complex_t >	materialProfileSLD (const MultiLayer &multilayer, int n_points, double z_min, double z_max)
	Calculate average material profile for given multilayer. More...

Detailed Description

Functions that are only used in the swig *.i files

Function Documentation

defaultMaterialProfileLimits()

std::pair< double, double > swigAPI::defaultMaterialProfileLimits

(

const MultiLayer &

multilayer

)

Get default z limits for generating a material profile.

Definition at line 43 of file MultiLayerFuncs.cpp.

{
    SimulationOptions options;
    options.setUseAvgMaterials(true);
    ProcessedSample sample(multilayer, options);
    ProfileHelper helper(sample);
    return helper.defaultLimits();
}

References ProfileHelper::defaultLimits(), and SimulationOptions::setUseAvgMaterials().

Here is the call graph for this function:

generateZValues()

std::vector< double > swigAPI::generateZValues	(	int	n_points,
		double	z_min,
		double	z_max
	)

Definition at line 20 of file MultiLayerFuncs.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 materialProfileSLD().

materialProfileSLD()

std::vector< complex_t > swigAPI::materialProfileSLD	(	const MultiLayer &	multilayer,
		int	n_points,
		double	z_min,
		double	z_max
	)

Calculate average material profile for given multilayer.

Definition at line 32 of file MultiLayerFuncs.cpp.

{
    SimulationOptions options;
    options.setUseAvgMaterials(true);
    ProcessedSample sample(multilayer, options);
    ProfileHelper helper(sample);
    std::vector<double> z_values = generateZValues(n_points, z_min, z_max);
    return helper.calculateProfile(z_values);
}

References ProfileHelper::calculateProfile(), generateZValues(), and SimulationOptions::setUseAvgMaterials().

Here is the call graph for this function: