This page was generated from the notebook domains_custom_layers.ipynb found in
the Python-RAT repository.
Download notebook.
Note
To get the output project and results from this example in your Python session, run:
from RATapi.examples import domains_custom_layers
project, results = domains_custom_layers()
[1]:
import pathlib
from IPython.display import Code
import RATapi as RAT
from RATapi.models import Parameter
Analysing Domains Samples Using Custom Layers Models#
For custom models, all the work with calculating the reflectivity from the different domains is done within the custom model itself. To do this, there is an additional input into the custom model file which denotes the domain to be calculated:
The final ‘domain’ input is always either 0 or 1, denoting which domain is being calculated. Then, within the custom model, we can calculate the layers structure for whichever domain structure is required in this pass through the function:
We will make a simple example of a permalloy layer on silicon, which has spin up and spin down domains, each with different SLDs
We start by setting up the project:
[2]:
problem = RAT.Project(calculation="domains", model="custom layers", geometry="substrate/liquid")
# Make some parameters
parameter_list = [
Parameter(name="Alloy Thickness", min=100.0, value=150.0, max=200.0, fit=True),
Parameter(name="Alloy SLD up", min=9.0e-6, value=11.0e-6, max=13.0e-6, fit=True),
Parameter(name="Alloy SLD down", min=5.0e-6, value=7.0e-6, max=10.0e-6, fit=True),
Parameter(name="Alloy Roughness", min=5.0, value=7.0, max=11.0, fit=True),
Parameter(name="Gold Thickness", min=100.0, value=150.0, max=200.0, fit=True),
Parameter(name="Gold SLD", min=4.0e-6, value=4.5e-6, max=5.0e-6, fit=True),
Parameter(name="Gold Roughness", min=5.0, value=7.0, max=11.0, fit=True)
]
problem.parameters.extend(parameter_list)
# Set the bulk SLD
problem.bulk_in.set_fields(0, name="Silicon", value=2.073e-6, max=1.0)
# Add the custom file
problem.custom_files.append(name="Alloy domains", filename="alloy_domains.py", language="python", path=pathlib.Path.cwd().resolve(),
)
# Make a contrast
problem.contrasts.append(
name="D2O Contrast",
data="Simulation",
background="Background 1",
bulk_in="Silicon",
bulk_out="SLD D2O",
scalefactor="Scalefactor 1",
resolution="Resolution 1",
resample=False,
domain_ratio="Domain Ratio 1",
model=["Alloy domains"],
)
print(problem)
Calculation: ---------------------------------------------------------------------------------------
domains
Model: ---------------------------------------------------------------------------------------------
custom layers
Geometry: ------------------------------------------------------------------------------------------
substrate/liquid
Parameters: ----------------------------------------------------------------------------------------
+-------+---------------------+-------+---------+---------+------+
| index | name | min | value | max | fit |
+-------+---------------------+-------+---------+---------+------+
| 0 | Substrate Roughness | 1.0 | 3.0 | 5.0 | True |
| 1 | Alloy Thickness | 100.0 | 150.0 | 200.0 | True |
| 2 | Alloy SLD up | 9e-06 | 1.1e-05 | 1.3e-05 | True |
| 3 | Alloy SLD down | 5e-06 | 7e-06 | 1e-05 | True |
| 4 | Alloy Roughness | 5.0 | 7.0 | 11.0 | True |
| 5 | Gold Thickness | 100.0 | 150.0 | 200.0 | True |
| 6 | Gold SLD | 4e-06 | 4.5e-06 | 5e-06 | True |
| 7 | Gold Roughness | 5.0 | 7.0 | 11.0 | True |
+-------+---------------------+-------+---------+---------+------+
Bulk In: -------------------------------------------------------------------------------------------
+-------+---------+-----+-----------+-----+-------+
| index | name | min | value | max | fit |
+-------+---------+-----+-----------+-----+-------+
| 0 | Silicon | 0.0 | 2.073e-06 | 1.0 | False |
+-------+---------+-----+-----------+-----+-------+
Bulk Out: ------------------------------------------------------------------------------------------
+-------+---------+---------+----------+----------+-------+
| index | name | min | value | max | fit |
+-------+---------+---------+----------+----------+-------+
| 0 | SLD D2O | 6.2e-06 | 6.35e-06 | 6.35e-06 | False |
+-------+---------+---------+----------+----------+-------+
Scalefactors: --------------------------------------------------------------------------------------
+-------+---------------+------+-------+------+-------+
| index | name | min | value | max | fit |
+-------+---------------+------+-------+------+-------+
| 0 | Scalefactor 1 | 0.02 | 0.23 | 0.25 | False |
+-------+---------------+------+-------+------+-------+
Domain Ratios: -------------------------------------------------------------------------------------
+-------+----------------+-----+-------+-----+-------+
| index | name | min | value | max | fit |
+-------+----------------+-----+-------+-----+-------+
| 0 | Domain Ratio 1 | 0.4 | 0.5 | 0.6 | False |
+-------+----------------+-----+-------+-----+-------+
Background Parameters: -----------------------------------------------------------------------------
+-------+--------------------+-------+-------+-------+-------+
| index | name | min | value | max | fit |
+-------+--------------------+-------+-------+-------+-------+
| 0 | Background Param 1 | 1e-07 | 1e-06 | 1e-05 | False |
+-------+--------------------+-------+-------+-------+-------+
Backgrounds: ---------------------------------------------------------------------------------------
+-------+--------------+----------+--------------------+
| index | name | type | source |
+-------+--------------+----------+--------------------+
| 0 | Background 1 | constant | Background Param 1 |
+-------+--------------+----------+--------------------+
Resolution Parameters: -----------------------------------------------------------------------------
+-------+--------------------+------+-------+------+-------+
| index | name | min | value | max | fit |
+-------+--------------------+------+-------+------+-------+
| 0 | Resolution Param 1 | 0.01 | 0.03 | 0.05 | False |
+-------+--------------------+------+-------+------+-------+
Resolutions: ---------------------------------------------------------------------------------------
+-------+--------------+----------+--------------------+
| index | name | type | source |
+-------+--------------+----------+--------------------+
| 0 | Resolution 1 | constant | Resolution Param 1 |
+-------+--------------+----------+--------------------+
Custom Files: --------------------------------------------------------------------------------------
+-------+---------------+------------------+---------------+----------+------------------------------------------------------------------------------+
| index | name | filename | function name | language | path |
+-------+---------------+------------------+---------------+----------+------------------------------------------------------------------------------+
| 0 | Alloy domains | alloy_domains.py | alloy_domains | python | /opt/actions-runner/_work/RAT-Docs/RAT-Docs/source/python_examples/notebooks |
+-------+---------------+------------------+---------------+----------+------------------------------------------------------------------------------+
Data: ----------------------------------------------------------------------------------------------
+-------+------------+------+------------+------------------+
| index | name | data | data range | simulation range |
+-------+------------+------+------------+------------------+
| 0 | Simulation | [] | [] | [0.005, 0.7] |
+-------+------------+------+------------+------------------+
Contrasts: -----------------------------------------------------------------------------------------
+-------+--------------+------------+--------------+-------------------+---------+----------+---------------+--------------+----------+----------------+---------------+
| index | name | data | background | background action | bulk in | bulk out | scalefactor | resolution | resample | domain ratio | model |
+-------+--------------+------------+--------------+-------------------+---------+----------+---------------+--------------+----------+----------------+---------------+
| 0 | D2O Contrast | Simulation | Background 1 | add | Silicon | SLD D2O | Scalefactor 1 | Resolution 1 | False | Domain Ratio 1 | Alloy domains |
+-------+--------------+------------+--------------+-------------------+---------+----------+---------------+--------------+----------+----------------+---------------+
In the project, we are using a custom function which we have called ‘alloy_domains’:
[3]:
Code("alloy_domains.py")
[3]:
def alloy_domains(params, bulkIn, bulkOut, contrast, domain):
"""Simple custom model for testing incoherent summing.
Simple two layer of permalloy / gold, with up/down domains.
"""
# Split up the parameters
subRough = params[0]
alloyThick = params[1]
alloySLDup = params[2]
alloySLDdn = params[3]
alloyRough = params[4]
goldThick = params[5]
goldSLD = params[6]
goldRough = params[7]
# Make the layers
alloyUp = [alloyThick, alloySLDup, alloyRough]
alloyDn = [alloyThick, alloySLDdn, alloyRough]
gold = [goldThick, goldSLD, goldRough]
# Make the model depending on which domain we are looking at
if domain == 0:
output = [alloyUp, gold]
else:
output = [alloyDn, gold]
return output, subRough
Note that the main difference between this and a ‘normal’ custom function is the extra ‘domain’ input, which we then use to select which domain we compute using the ‘if / else’ instruction at the end of the function
To run this, we make a controls block as usual, and send it to RAT.
[4]:
controls = RAT.Controls()
problem, results = RAT.run(problem, controls)
RAT.plotting.plot_ref_sld(problem, results)
Starting RAT ───────────────────────────────────────────────────────────────────────────────────────────────────────────
Elapsed time is 0.004 seconds
Finished RAT ───────────────────────────────────────────────────────────────────────────────────────────────────────────
