class EasyReflectometry.sample.assemblies.gradient_layer.GradientLayer

Bases: BaseAssembly

A set of discrete gradient layers changing from the front to the back material. The front layer is where the neutron beam starts in, it has an index of 0.

__init__(front_material, back_material, thickness, roughness, discretisation_elements=10, name='EasyGradienLayer', interface=None)

Constructor.

Parameters:

• front_material (Material) – Material of front of the layer

• back_material (Material) – Material of back of the layer

• thickness (float) – Thicknkess of the layer

• roughness (float) – Roughness of the layer

• discretisation_elements (int) – Number of discrete layers

• name (str) – Name for gradient layer, defaults to ‘EasyGradienLayer’.

• interface – Calculator interface, defaults to None.

classmethod default(name='EasyGradientLayer', interface=None)

Default instance for a gradient layer object. The default is air to deuterium.

Parameters:

• name (str) – Name for gradient layer, defaults to ‘EasyGradienLayer’.

• interface – Calculator interface, defaults to None.

Return type:

GradientLayer

classmethod from_pars(front_material, back_material, thickness, roughness, discretisation_elements, name='EasyGradientLayer', interface=None)

Instance for the gradient layer where the parameters are known, front is facing the neutron beam.

Parameters:

• front_material (Material) – Material of front of the layer

• back_material (Material) – Material of back of the layer

• thickness (float) – Thicknkess of the layer

• roughness (float) – Roughness of the layer

• discretisation_elements (int) – Number of dicrete layers

• name (str) – Name for gradient layer

Return type:

GradientLayer

property thickness: float

Get the thickness of the gradient layer in Angstrom.

property roughness: float

Get the Roughness of the gradient layer in Angstrom.

user_data: dict

layers: LayerCollection

Layers in the assembly.

as_dict(skip=None)

Cleaned dictionary. Custom as_dict method to skip generated layers.

Return type:

dict