diff --git a/hugo/content/py/sim/depthprobe/index.md b/hugo/content/py/sim/depthprobe/index.md index 14ed496a2516e12bad231be42fef77bf6fde066c..a4de5b4b72d58056bba181950bfe6f1bafcb4f0a 100644 --- a/hugo/content/py/sim/depthprobe/index.md +++ b/hugo/content/py/sim/depthprobe/index.md @@ -1,15 +1,34 @@ +++ -title = "Depth-probe" +title = "Depth probe" weight = 50 +++ -# Depth-probe simulation tutorial +## Depth probe simulation -Depth-probe simulation is an auxiliary simulation type, which helps to visualize +Depth probe simulation is an auxiliary simulation type, which helps to visualize the total intensity in dependence on the beam incidence angle and the position in the sample. -## Example +To set up and run a simulation, use +```python +import bornagain as ba +scan = ... +sample = ... +z_axis = ba.FixedBinAxis("z", nz, z_min, z_max) +simulation = ba.DepthprobeSimulation(scan, sample, z_axis) +# ... set options +result = simulation.simulate() +``` + +For the constructor arguments, see sections [scan]({{% ref-py "instr/scan" %}}), +[sample]({{% ref-py "sample" %}}). + +For optional settings, see [simulation options]({{% ref-py "sim/options" %}}). + +For the return type of function `simulate()`, +see [SimulationResult]({{% ref-py "result/simulation-result" %}}). + +### Example We consider a neutron resonator, composed of one Ti/Pt bilayer. @@ -24,7 +43,4 @@ as function of depth and incident angle $\alpha_i$. {{< figscg src="/img/auto/varia/DepthProbe.png" width="500" class="center">}} - -## Script - {{< highlightfile file="Examples/varia/DepthProbe.py" >}}