Skip to main content
Ctrl+K
RAT  documentation - Home
  • Home
  • Installation
  • User Guide
  • Examples
  • API Reference
  • Home
  • Installation
  • User Guide
  • Examples
  • API Reference

Section Navigation

  • MATLAB API Reference
    • Project Class
      • Parameters Class
      • Resolutions Class
      • Backgrounds Class
      • Data Class
      • Layers Class
      • Custom File Class
      • Contrasts Class
    • Controls Class
    • RAT Entry Functions
    • Target Functions (Low Level API)
    • Minimisers
      • Simplex
      • Differential Evolution
      • Nested Sampling
      • DREAM
      • General Minimiser Utilities
    • Plotting
    • Utilities
  • Python API Reference
    • Run
    • Project
    • Controls
    • ClassList
    • Models
    • Events
    • Examples
    • Plotting
    • Enums
    • RAT Core
    • Inputs
    • Outputs
    • Wrappers
  • API Reference
  • Python API Reference

Python API Reference#

User API#

  • Run
    • run()
  • Project
    • Project
  • Controls
    • Controls
  • ClassList
    • ClassList
  • Models
    • AbsorptionLayer
    • Background
    • Contrast
    • ContrastWithRatio
    • CustomFile
    • Data
    • DomainContrast
    • Layer
    • Parameter
    • ProtectedParameter
    • Resolution
  • Events
    • clear()
    • get_event_callback()
    • notify()
    • register()
  • Examples
    • DSPC_custom_XY()
    • DSPC_custom_layers()
    • DSPC_data_background()
    • DSPC_function_background()
    • DSPC_standard_layers()
    • absorption()
    • domains_custom_XY()
    • domains_custom_layers()
  • Plotting
    • LivePlot
    • plot_chain()
    • plot_contour()
    • plot_corner()
    • plot_hists()
    • plot_one_hist()
    • plot_ref_sld()
  • Enums
    • BackgroundActions
    • BoundHandling
    • Calculations
    • Display
    • Geometries
    • Hydration
    • Languages
    • LayerModels
    • Parallel
    • Priors
    • Procedures
    • RATEnum
    • Strategies
    • TypeOptions

Developer API#

  • RAT Core
    • EventTypes
    • RATMain()
    • makeSLDProfileXY()
  • Inputs
    • FileHandles
    • append_data_background()
    • check_indices()
    • get_python_handle()
    • make_controls()
    • make_data_present()
    • make_input()
    • make_problem()
    • make_resample()
  • Outputs
    • BayesResults
    • CalculationResults
    • ConfidenceIntervals
    • ContrastParams
    • DreamOutput
    • DreamParams
    • NestedSamplerOutput
    • PredictionIntervals
    • Results
    • get_field_string()
    • make_results()
  • Wrappers
    • DylibWrapper
    • MatlabWrapper
    • start_matlab()
On this page
  • User API
  • Developer API

© Copyright 2022-2025, ISIS Neutron and Muon Source.

Created using Sphinx 7.4.7.

Built with the PyData Sphinx Theme 0.15.2.