Layer#

class EasyReflectometry.sample.layer.Layer(material, thickness, roughness, name='EasyLayer', interface=None)[source]#

Bases: BaseObj

assign_material(material)[source]#

Assign a material to the layer interface

classmethod default(interface=None)[source]#

Default constructor for the reflectometry layer.

Returns

Default layer container

Return type

Layer

classmethod from_pars(material, thickness, roughness, name='EasyLayer', interface=None)[source]#

Constructor of a reflectometry layer where the parameters are known.

Parameters

  • material (EasyReflectometry.material.Material) – The material that makes up the layer

  • thickness (float) – Layer thickness in angstrom

  • roughness (float) – Layer roughness in angstrom

Returns

Layer container

Return type

Layer

property uid: int#

UID from the borg map

Type

return

Return type

int

user_data: dict#
class EasyReflectometry.sample.layer.LayerApm(chemical_structure, thickness, solvent, solvation, area_per_molecule, roughness, name='EasyLayerApm', interface=None)[source]#

Bases: Layer

The LayerApm class allows a layer to be defined in terms of some chemical structure (given as a chemical formula) and area per molecule.

area_per_molecule: ClassVar[Parameter]#
as_dict(skip=[])[source]#

Custom as_dict method to skip necessary things.

Return type

dict

Returns

Cleaned dictionary.

property chemical_structure: str#

Chemical structure

Type

return

Return type

str

classmethod default(interface=None)[source]#

Default constructor for layer defined from chemical structure and area per molecule.

Parameters

interface – Interface object, defaults to None

Return type

LayerApm

Returns

Layer with correct structure

classmethod from_pars(chemical_structure, thickness, solvent, solvation, area_per_molecule, roughness, name='EasyLayerApm', interface=None)[source]#

Constructor for a layer described with the area per molecule, where the parameters are known.

Parameters

  • chemical_structure (str) – Chemical formula for the material in the layer

  • thickness (float) – Layer thickness

  • solvent (Material) – Solvent present in material

  • solvation (float) – Fraction of solvent present

  • area_per_molecule (float) – Area per molecule for the chemical material

  • roughness (float) – Upper roughness on the layer

  • name (str) – Identifier, defaults to EasyLayerApm

  • interface – Interface object, defaults to None

Return type

LayerApm

Returns

Layer with correct structure

property solvation: Parameter#

Solvation fraction.

Type

return

Return type

Parameter

property solvent: Material#

Solvent material

Type

return

Return type

Material

user_data: dict#