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.
To compute the total wave intensity as function of $\alpha_\text{i}$ and z, use
import bornagain as ba
scan = ...
sample = ...
z_axis = ba.EquiDivision("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, sample.
For optional settings, see simulation options.
For the return type of function simulate(),
see Datafield.
The constructor takes an optional flags argument
simulation = ba.DepthprobeSimulation(scan, sample, z_axis, flags)
Flags may designate a partial beam
ba.ZDirection_None # = 0, may be ommitted: total field
ba.ZDirection_Reflected # reflected beam only
ba.ZDirection_Transmitted # transmitted beam only
or/and a property of the simulated wave field
ba.WaveProperty_Intensity # = 0, may be ommitted: intensity, |psi|^2
ba.WaveProperty_Modulus # modulus of wave amplitude, |psi|
ba.WaveProperty_Phase # phase of wave amplitude, arg(psi), in rad
To combine flags from each of these groups, combine them with the “or” operator:
flags = ba.ZDirection_Reflected | ba.WaveProperty_Modulus