User API

Here is a list of classes grouped in several categories to create the sample, describe scattering geometry, run the simulation and perform fitting.

• Simulation
  List of classes to run simulations
  • Beam
    List of classes to describe the beam, and its footprint in the sample plane
  • Detector
    List of classes to describe detectors
    • Detector masks
• Samples
  List of classes to describe scattering sample
• Materials
  Classes to describe magnetic and non-magnetic materials
• Form factors
  List of form factors available
  • Hard particles
    Three-dimenensional particle shapes
  • Soft particles
    Three-dimenensional particle models with smoothly decaying scattering-length distribution
  • Ripples
    Ripples, for modelling gratings
• Distribution, decay, and interference functions
  
  • Interference functions
  • Fourier-space decay functions
  • Fourier-space distribution functions
  • Parameter distributions
• Tools
  Different tools mainly to deal with intensity data
• Input and output
  Various routines to write intensity data on disk and to import user data.
• Fitting
  Fitting routines

Here is a list of additional classes from internal API.

• Simulation and instrument internals
  
• Samples internals
  
• Materials internals
  
• Form factors internals
  
• Distribution function internals
• Tools internals
  
• Input/output internals
  
• Fitting internals