File: _index.md

package info (click to toggle)
bornagain 23.0-6
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 103,956 kB
  • sloc: cpp: 423,131; python: 40,997; javascript: 11,167; awk: 630; sh: 356; ruby: 173; xml: 130; makefile: 45; ansic: 24
file content (31 lines) | stat: -rw-r--r-- 797 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
+++
title = "Off-specular"
weight = 30
+++

## Off-specular scattering simulation

To set up and run a simulation with off-specular scattering, use
```python
import bornagain as ba
scan = ...
sample = ...
detector = ba.OffspecDetector(...)
simulation = ba.OffspecSimulation(scan, sample, detector)
# ... set options
result = simulation.simulate()
```

Supported scan types: grazing angle scan, wavelength scan.

For the constructor arguments, see sections [scan](/ref/instr/scan),
[sample](/ref/sample), and [OffspecDetector](/ref/instr/det/offspec).

For optional settings, see [simulation options](/ref/sim/setup/options).

For the return type of function `simulate()`,
see [Datafield](/ref/data/datafield).

##### Examples

* [basic off-specular simulation](/ref/sim/class/offspec/ex/index.md)