Fitting in the GUI

This tutorial gives a brief overview of new fitting functionality in the GUI, introduced in Release-1.6.0 (June, 2016).

Please note, that fitting in the GUI is in beta state and will be changed significantly in the forthcoming releases. The goal of this tutorial is to help users get started, so we could collect their feedback and adapt the fitting interface to their actual needs.

In the future the following tutorial will be revised to reflect the actual status of the fitting in the GUI.

As a first example, this tutorial will focus on fitting data simulated with BornAgain itself. More complex fitting examples will be considered in coming releases. This tutorial is organized as follows:

1) Preparing data to fit

Let's construct a simple sample - a two-layer system (air, substrate), with cylindrical particles sitting on top of substrate. The height and radius of cylindrical particles are both set to 5 nm.

For the next step we switch to the Simulation View and simply run the simulation using the Default GISAS Instrument.

As soon as the simulation is complete, the interface automatically switches to JobView, which displays the simulated intensity map. This result can be saved as a file called in BornAgain ASCII format (*.int). This file will be later used to import "real data" for the fitting.

2) Importing the "real" data

Switch to the Import View. At the beginning it is empty since there are no real data samples loaded yet. Push the "Import" button and select the file you've created earlier.

The data will be loaded into BornAgain and presented in the Import Data view as shown below.

3) Setting the fit  up.

 It is now time to setup our first fitting job. Switch back to the Simulation View. In the "Select Real Data" field select the name of the real dataset you've just imported. Now, the data selection box states, as shown below, that an instrument "Default GISAS" will be used together with the sample "example01", which represents the multilayer with cylinders that we've constructed in 1), in order to fit the dataset "real_data". Click on the "Run Simulation" button to start the simulation.

Once the simulation is complete, the display is once again switched to the JobView mode. Our current job - "job2" - is now ready for fitting. Use the selector in the bottom right corner to switch type of activity from "Job View Activity" to "Fitting Activity" (indicated with the green arrow in the figure below).

In this view the following elements are visible

  • (1) An intensity map of our "real" dataset.
  • (2) A simulated intensity map of the job itself 
  • (3) A relative difference map between (1) and (2)
  • (4) A plot showing how the fit is progressing
  • (5) A sample parameter tuning widget
  • (6) A window to display fitting parameters
  • (7) The presentation selector, which allows to switch quickly between views from current "Fit Data" to standard "Color Map"

As you may see, the relative difference map (3) shows that there is actually no any difference between "real" and "simulated" data. This is normal, since our "real" data was generated using the same sample/instrument settings as job2, which was used for fitting. Or, in other words, at this point no fitting is required - our sample parameters perfectly describe the "real" data. In the following paragraph we are going to change it.

3) Setting the fit up (cont.)

Using the parameter tuning widget on the right we set new values for two sample parameters: cylinder radius and cylinder height. This leads to an automatic re-simulation and update of the views: the simulated intensity map has changed and doesn't coincide with the "real" data map anymore. The relative difference map also shows a huge difference.

This will be the initial conditions of our fitting. The real data was simulated using values for the cylinder's height = radius = 5 nm. The simulated intensity map is obtained for the cylinder's height = radius = 10 nm. We are going to define two fit parameters for cylinder's radius and height .Our final goal is to find the original values, i.e. height=radius=5 nm.

To create the fit parameters, drag-and-drop "radius" and "height" from the parameter tuning widget to the widget below for fit parameters (indicated by the green arrow in the figure below).

Every fit parameters have the following fields

  • Fit parameter name
  • Fit parameter type (limited, free, fixed, etc)
  • Fit parameter starting value
  • Fit parameter limits
  • A long string showing to which sample parameter the given fit parameter is linked

Define fit parameter limits to min = 3 nm, max = 15 nm and starting value = 10 nm.

4) Running the fit

Push the "Run" button at the bottom of the "Fit Parameters" view. The fitting should start. Using the slider at the bottom area one can change the plotting update's rate. The plot below shows the view after the fitting was completed. The green histograms in the lower right corner shows the fit progress as a value of chi2 versus number of fit iterations.