Profile functors

Added in version 0.9.1.

This module is a collection of functors to calculate scattering length density (SLD) profiles for multilayer samples.

escape.scattering.profile.profile_sld0(z: FunctorLike, ml: multilayer_obj, source: source_obj = None, name: str = 'SLD profile', notes: str = '') → cplx_functor_obj

Method which returns a functor to calculate scattering length density profile of the multilayer ml. z - indicates Z-axis values and can be a variable or a functor

The Z axis is perpendicular to the sample surface and is directed inward with the starting point on the sample surface.

Added in version 0.9.1.

Parameters:

z: FunctorLike

Represents z-axis value

ml: multilayer_obj

Sample description object

source: source_obj, optional

Source object (default None).

name: str, optional

Profile name.

notes: str, optional

User notes for the object.

Returns:

functor_obj instance

escape.scattering.profile.profile_sldm(z: FunctorLike, ml: multilayer_obj, source: source_obj = None, name: str = 'SLDm profile', notes: str = '') → functor_obj

Method which returns a functor to calculate scattering length density profile of the multilayer ml. z - indicates Z-axis values and can be a variable or a functor

The Z axis is perpendicular to the sample surface and is directed inward with the starting point on the sample surface.

Added in version 0.9.8.

Parameters:

z: FunctorLike

Represents z-axis value

ml: multilayer_obj

Sample description object

source: source_obj, optional

Source object (default None).

name: str, optional

Profile name.

notes: str, optional

User notes for the object.

Returns:

functor_obj instance