SASVIEW(1)

✨ NAME ✨

okay bestie, this is sasview(1) β€” the manual page for SasView, and we're about to make you a whole expert πŸ’–

🌸 DESCRIPTION 🌸

SasView is software for the analysis of Small-Angle Scattering (SAS) data. that's the whole vibe, that's the assignment.

What does she do with it though? She takes analytic functions that describe different types of material microstructure and fits them to your experimental data, so you can figure out the shape, the size, and the degree of ordering. literally the glow-up of your data πŸ¦‹

And she doesn't stop there, no ma'am. SasView also ships with tools for calculating:

  • scattering length densities
  • slit sizes
  • resolution
  • fringe thicknesses/d-spacings
  • the (Porod) invariant (aka 'total scattering')
  • distance distribution functions

periodt. πŸ’…


πŸ’– SASVIEW USER DOCUMENTATION πŸ’–

NOTE: on Windows, hit [Alt]-[Cursor left] to bounce back to the previous page πŸ‘ˆ

The menu bar sitting at the top of the SasView window is your gateway to the extra features of the program. think of it as the little door to Narnia, except it's Unix and it's scattering data.

πŸ“ File

The File option is how you load data into SasView for analysis, or save the work you've been doing. protect your progress bestie, always.

Data can be loaded in a few different ways:

  • one file at a time
  • by selecting multiple files
  • by loading an entire folder of files β€” and in that case, SasView will attempt to make an intelligent guess as to what to load, based on the file formats it recognises in the folder! (yes she's guessing. yes it's usually right. no cap.)

A SasView session can also be saved and reloaded as an 'Analysis' β€” that's an individual model fit or invariant calculation, etc β€” or as a 'Project', which is everything you have done since starting your SasView session. the whole main character arc, preserved 😭

πŸ¦‹ Edit

The Edit option lets you:

  • undo/redo your recent changes
  • copy and paste parameters between SasView analysis windows
  • copy parameters from a SasView analysis window to the Clipboard as either tab-delimited text (compatible with Microsoft Excel) or LaTex-wrapped text
  • generate a summary 'Report' of the most recent analysis performed
  • reset parameter values in the P(r) Inversion analysis page

πŸ’œ View

The View option lets you:

  • show the Batch Fitting Results Panel if it has been closed
  • show/hide the Data Explorer Panel
  • show/hide the Toolbar of icons below the Menu Bar
  • select the default location that SasView looks in for data to analyse β€” the SasView installation directory, the initial default, or a custom folder. NB: any change only takes effect when SasView is restarted πŸ”
  • change the default assignment of categories (Shapes, Shape-independent, Structure Factor) for fitting model functions

🌈 Tools

The Tools option provides access to a comprehensive range of tools and utilities. see tools for more information πŸ‘€

πŸ‘‘

Window

The Window option lets you select which SasView windows are visible. that's it, that's the power move.

πŸ”₯ Analysis

The Analysis option is the whole point, honestly β€” it gives you access to the key functionality of SasView:

  • Model Fitting
  • P(r) Inversion
  • Invariant Analysis
  • Correlation Function Analysis (SasView 4.1 and later)

See analysis for more information.

🧚 Fitting

The Fitting option lets you:

  • create a new FitPage
  • change optimiser (under Fit Options)
  • view fit parameter correlations, distributions, and convergence traces (under Fit Results)
  • create/edit a Plugin Model

Additional functionality is available under this menu option during particular types of model fitting, including:

  • setting up a Constrained or Simultaneous Fit
  • combining a Batch Fit (an obscure capability) πŸ™ˆ
  • setting up Chain Fitting

πŸŽ€ Help

The Help option gives you access to:

  • this help documentation
  • a tutorial on using SasView (in pdf format)
  • information on how to acknowledge SasView in publications
  • information about the version of SasView you are using
  • the marketplace
  • a check to see if there is a more recent version of SasView
NOTE: This help document was last changed by Steve King, 10Oct2016 πŸ“…

πŸ’« Fitting & Other Analyses πŸ’«

NOTE: on Windows, hit [Alt]-[Cursor left] to return to the previous page πŸ‘ˆ

⭐ Tools & Utilities ⭐

NOTE: on Windows, hit [Alt]-[Cursor left] to return to the previous page πŸ‘ˆ

🫢 Working with SasView 🫢

NOTE: on Windows, hit [Alt]-[Cursor left] to return to the previous page πŸ‘ˆ

πŸ“ Tutorials πŸ“

NOTE: on Windows, hit [Alt]-[Cursor left] to return to the previous page πŸ‘ˆ
  • Getting Started with Sasview
  • Old Tutorial

πŸ‘‘ DEVELOPER DOCUMENTATION πŸ‘‘

NOTE: on Windows, hit [Alt]-[Cursor left] to return to the previous page πŸ‘ˆ

πŸ“– Contents πŸ“–

okay bestie, buckle UP πŸ’– this is the full map of every single module in the tree, and yes we are listing literally all of them, because that's the vibe. no skimming, no "etc.", we don't do that here. 🌈

  • src
  • src package

πŸ“¦ Subpackages

  • src.sas package
    • Subpackages
      • src.sas.sascalc package

πŸ§ͺ src.sas.sascalc package

  • Subpackages
    • src.sas.sascalc.calculator package
      • Subpackages
        • src.sas.sascalc.calculator.c_extensions package
      • Module contents
      • Submodules
        • src.sas.sascalc.calculator.BaseComponent module
        • src.sas.sascalc.calculator.instrument module
        • src.sas.sascalc.calculator.kiessig_calculator module
        • src.sas.sascalc.calculator.resolution_calculator module
        • src.sas.sascalc.calculator.sas_gen module
        • src.sas.sascalc.calculator.slit_length_calculator module
    • Module contents
    • src.sas.sascalc.corfunc package
      • Submodules
        • src.sas.sascalc.corfunc.corfunc_calculator module
        • src.sas.sascalc.corfunc.transform_thread module
      • Module contents
    • src.sas.sascalc.data_util package
      • Submodules
        • src.sas.sascalc.data_util.calcthread module
        • src.sas.sascalc.data_util.err1d module
        • src.sas.sascalc.data_util.formatnum module
        • src.sas.sascalc.data_util.nxsunit module
        • src.sas.sascalc.data_util.odict module
        • src.sas.sascalc.data_util.ordereddict module
        • src.sas.sascalc.data_util.ordereddicttest module
        • src.sas.sascalc.data_util.pathutils module
        • src.sas.sascalc.data_util.qsmearing module
        • src.sas.sascalc.data_util.registry module
        • src.sas.sascalc.data_util.uncertainty module
        • src.sas.sascalc.data_util.uniquelist module
      • Module contents
    • src.sas.sascalc.dataloader package
      • Subpackages
        • src.sas.sascalc.dataloader.readers package
          • Submodules
            • src.sas.sascalc.dataloader.readers.IgorReader module
            • src.sas.sascalc.dataloader.readers.abs_reader module
            • src.sas.sascalc.dataloader.readers.anton_paar_saxs_reader module
            • src.sas.sascalc.dataloader.readers.ascii_reader module
            • src.sas.sascalc.dataloader.readers.associations module
            • src.sas.sascalc.dataloader.readers.cansas_constants module
            • src.sas.sascalc.dataloader.readers.cansas_reader module
            • src.sas.sascalc.dataloader.readers.cansas_reader_HDF5 module
            • src.sas.sascalc.dataloader.readers.danse_reader module
            • src.sas.sascalc.dataloader.readers.hfir1d_reader module
            • src.sas.sascalc.dataloader.readers.nexus_reader module
            • src.sas.sascalc.dataloader.readers.red2d_reader module
            • src.sas.sascalc.dataloader.readers.sesans_reader module
            • src.sas.sascalc.dataloader.readers.tiff_reader module
            • src.sas.sascalc.dataloader.readers.xml_reader module
          • Module contents
      • Submodules
        • src.sas.sascalc.dataloader.data_info module
        • src.sas.sascalc.dataloader.loader module
        • src.sas.sascalc.dataloader.manipulations module
      • Module contents
    • src.sas.sascalc.file_converter package
      • Subpackages
      • Submodules
        • src.sas.sascalc.file_converter.bsl_loader module
        • src.sas.sascalc.file_converter.cansas_writer module
        • src.sas.sascalc.file_converter.nxcansas_writer module
        • src.sas.sascalc.file_converter.otoko_loader module
        • src.sas.sascalc.file_converter.red2d_writer module
      • Module contents
    • src.sas.sascalc.fit package
      • Submodules
        • src.sas.sascalc.fit.AbstractFitEngine module
        • src.sas.sascalc.fit.BumpsFitting module
        • src.sas.sascalc.fit.Loader module
        • src.sas.sascalc.fit.MultiplicationModel module
        • src.sas.sascalc.fit.expression module
        • src.sas.sascalc.fit.pluginmodel module
      • Module contents
    • src.sas.sascalc.invariant package
      • Submodules
        • src.sas.sascalc.invariant.invariant module
        • src.sas.sascalc.invariant.invariant_mapper module
      • Module contents
    • src.sas.sascalc.pr package
      • Subpackages
        • src.sas.sascalc.pr.c_extensions package
          • Module contents
        • src.sas.sascalc.pr.fit package
          • Submodules
            • src.sas.sascalc.pr.fit.AbstractFitEngine module
            • src.sas.sascalc.pr.fit.BumpsFitting module
            • src.sas.sascalc.pr.fit.Loader module
            • src.sas.sascalc.pr.fit.expression module
          • Module contents
      • Submodules
        • src.sas.sascalc.pr.distance_explorer module
        • src.sas.sascalc.pr.invertor module
        • src.sas.sascalc.pr.num_term module
      • Module contents
    • src.sas.sascalc.realspace package
      • Submodules
        • src.sas.sascalc.realspace.VolumeCanvas module
      • Module contents
    • src.sas.sascalc.simulation package
      • Submodules
        • src.sas.sascalc.simulation.setup module
      • Module contents
  • Module contents

πŸ–ΌοΈ src.sas.sasgui package

  • Subpackages
    • src.sas.sasgui.guiframe package
      • Subpackages
        • src.sas.sasgui.guiframe.local_perspectives package
          • Subpackages
            • src.sas.sasgui.guiframe.local_perspectives.data_loader package
              • Submodules
              • src.sas.sasgui.guiframe.local_perspectives.data_loader.data_loader module
              • src.sas.sasgui.guiframe.local_perspectives.data_loader.load_thread module
              • Module contents
            • src.sas.sasgui.guiframe.local_perspectives.plotting package
              • Submodules
              • src.sas.sasgui.guiframe.local_perspectives.plotting.AnnulusSlicer module
              • src.sas.sasgui.guiframe.local_perspectives.plotting.Arc module
              • src.sas.sasgui.guiframe.local_perspectives.plotting.AzimutSlicer module
              • src.sas.sasgui.guiframe.local_perspectives.plotting.BaseInteractor module
              • src.sas.sasgui.guiframe.local_perspectives.plotting.Edge module
              • src.sas.sasgui.guiframe.local_perspectives.plotting.Plotter1D module
              • src.sas.sasgui.guiframe.local_perspectives.plotting.Plotter2D module
              • src.sas.sasgui.guiframe.local_perspectives.plotting.SectorSlicer module
              • src.sas.sasgui.guiframe.local_perspectives.plotting.SimplePlot module
              • src.sas.sasgui.guiframe.local_perspectives.plotting.SlicerParameters module
              • src.sas.sasgui.guiframe.local_perspectives.plotting.appearanceDialog module
              • src.sas.sasgui.guiframe.local_perspectives.plotting.binder module
              • src.sas.sasgui.guiframe.local_perspectives.plotting.boxMask module
              • src.sas.sasgui.guiframe.local_perspectives.plotting.boxSlicer module
              • src.sas.sasgui.guiframe.local_perspectives.plotting.boxSum module
              • src.sas.sasgui.guiframe.local_perspectives.plotting.detector_dialog module
              • src.sas.sasgui.guiframe.local_perspectives.plotting.graphAppearance module
              • src.sas.sasgui.guiframe.local_perspectives.plotting.masking module
              • src.sas.sasgui.guiframe.local_perspectives.plotting.plotting module
              • src.sas.sasgui.guiframe.local_perspectives.plotting.profile_dialog module
              • src.sas.sasgui.guiframe.local_perspectives.plotting.sector_mask module
              • src.sas.sasgui.guiframe.local_perspectives.plotting.slicerpanel module
              • Module contents
          • Module contents
      • Submodules
        • src.sas.sasgui.guiframe.CategoryInstaller module
        • src.sas.sasgui.guiframe.CategoryManager module
        • src.sas.sasgui.guiframe.aboutbox module
        • src.sas.sasgui.guiframe.acknowledgebox module
        • src.sas.sasgui.guiframe.config module
        • src.sas.sasgui.guiframe.custom_pstats module
        • src.sas.sasgui.guiframe.customdir module
        • src.sas.sasgui.guiframe.dataFitting module
        • src.sas.sasgui.guiframe.data_manager module
        • src.sas.sasgui.guiframe.data_panel module
        • src.sas.sasgui.guiframe.data_processor module
        • src.sas.sasgui.guiframe.data_state module
        • src.sas.sasgui.guiframe.documentation_window module
        • src.sas.sasgui.guiframe.dummyapp module
        • src.sas.sasgui.guiframe.events module
        • src.sas.sasgui.guiframe.gui_manager module
        • src.sas.sasgui.guiframe.gui_statusbar module
        • src.sas.sasgui.guiframe.gui_style module
        • src.sas.sasgui.guiframe.gui_toolbar module
        • src.sas.sasgui.guiframe.panel_base module
        • src.sas.sasgui.guiframe.pdfview module
        • src.sas.sasgui.guiframe.plugin_base module
        • src.sas.sasgui.guiframe.proxy module
        • src.sas.sasgui.guiframe.report_dialog module
        • src.sas.sasgui.guiframe.startup_configuration module
        • src.sas.sasgui.guiframe.utils module
      • Module contents
    • src.sas.sasgui.perspectives package
      • Subpackages
        • src.sas.sasgui.perspectives.calculator package
          • Submodules
            • src.sas.sasgui.perspectives.calculator.aperture_editor module
            • src.sas.sasgui.perspectives.calculator.calculator module
            • src.sas.sasgui.perspectives.calculator.calculator_widgets module
            • src.sas.sasgui.perspectives.calculator.collimation_editor module
            • src.sas.sasgui.perspectives.calculator.console module
            • src.sas.sasgui.perspectives.calculator.data_editor module
            • src.sas.sasgui.perspectives.calculator.data_operator module
            • src.sas.sasgui.perspectives.calculator.density_panel module
            • src.sas.sasgui.perspectives.calculator.detector_editor module
            • src.sas.sasgui.perspectives.calculator.gen_scatter_panel module
            • src.sas.sasgui.perspectives.calculator.image_viewer module
            • src.sas.sasgui.perspectives.calculator.kiessig_calculator_panel module
            • src.sas.sasgui.perspectives.calculator.load_thread module
            • src.sas.sasgui.perspectives.calculator.model_editor module
            • src.sas.sasgui.perspectives.calculator.pyconsole module
            • src.sas.sasgui.perspectives.calculator.resolcal_thread module
            • src.sas.sasgui.perspectives.calculator.resolution_calculator_panel module
            • src.sas.sasgui.perspectives.calculator.sample_editor module
            • src.sas.sasgui.perspectives.calculator.sld_panel module
            • src.sas.sasgui.perspectives.calculator.slit_length_calculator_panel module
            • src.sas.sasgui.perspectives.calculator.source_editor module
          • Module contents
        • src.sas.sasgui.perspectives.corfunc package
          • Submodules
            • src.sas.sasgui.perspectives.corfunc.corfunc module
            • src.sas.sasgui.perspectives.corfunc.corfunc_panel module
            • src.sas.sasgui.perspectives.corfunc.corfunc_state module
            • src.sas.sasgui.perspectives.corfunc.plot_labels module
          • Module contents
        • src.sas.sasgui.perspectives.file_converter package
          • Submodules
            • src.sas.sasgui.perspectives.file_converter.converter_panel module
            • src.sas.sasgui.perspectives.file_converter.converter_widgets module
            • src.sas.sasgui.perspectives.file_converter.file_converter module
            • src.sas.sasgui.perspectives.file_converter.frame_select_dialog module
            • src.sas.sasgui.perspectives.file_converter.meta_panels module
          • Module contents
        • src.sas.sasgui.perspectives.fitting package
          • Subpackages
          • Submodules
            • src.sas.sasgui.perspectives.fitting.basepage module
            • src.sas.sasgui.perspectives.fitting.batchfitpage module
            • src.sas.sasgui.perspectives.fitting.console module
            • src.sas.sasgui.perspectives.fitting.fit_thread module
            • src.sas.sasgui.perspectives.fitting.fitpage module
            • src.sas.sasgui.perspectives.fitting.fitpanel module
            • src.sas.sasgui.perspectives.fitting.fitproblem module
            • src.sas.sasgui.perspectives.fitting.fitting module
            • src.sas.sasgui.perspectives.fitting.fitting_widgets module
            • src.sas.sasgui.perspectives.fitting.gpu_options module
            • src.sas.sasgui.perspectives.fitting.hint_fitpage module
            • src.sas.sasgui.perspectives.fitting.model_thread module
            • src.sas.sasgui.perspectives.fitting.models module
            • src.sas.sasgui.perspectives.fitting.pagestate module
            • src.sas.sasgui.perspectives.fitting.report_dialog module
            • src.sas.sasgui.perspectives.fitting.resultpanel module
            • src.sas.sasgui.perspectives.fitting.simfitpage module
            • src.sas.sasgui.perspectives.fitting.utils module
          • Module contents
        • src.sas.sasgui.perspectives.invariant package
          • Submodules
            • src.sas.sasgui.perspectives.invariant.invariant module
            • src.sas.sasgui.perspectives.invariant.invariant_details module
            • src.sas.sasgui.perspectives.invariant.invariant_panel module
            • src.sas.sasgui.perspectives.invariant.invariant_state module
            • src.sas.sasgui.perspectives.invariant.invariant_widgets module
            • src.sas.sasgui.perspectives.invariant.report_dialog module
          • Module contents
        • src.sas.sasgui.perspectives.pr package
          • Submodules
            • src.sas.sasgui.perspectives.pr.explore_dialog module
            • src.sas.sasgui.perspectives.pr.inversion_panel module
            • src.sas.sasgui.perspectives.pr.inversion_state module
            • src.sas.sasgui.perspectives.pr.pr module
            • src.sas.sasgui.perspectives.pr.pr_thread module
            • src.sas.sasgui.perspectives.pr.pr_widgets module
          • Module contents
        • src.sas.sasgui.perspectives.simulation package
          • Submodules
            • src.sas.sasgui.perspectives.simulation.ShapeAdapter module
            • src.sas.sasgui.perspectives.simulation.ShapeParameters module

okay so picking up right where we left off in the developer docs, here's the rest of the module lineup bestie πŸ—ΊοΈβœ¨

  • src.sas.sasgui.perspectives.simulation.SimCanvas module
  • src.sas.sasgui.perspectives.simulation.simulation module
  • Module contents
  • Module contents

then we got the src.sas.sasgui.plottools package, which is literally the moment πŸ’…

  • src.sas.sasgui.plottools package
    • Submodules
      • src.sas.sasgui.plottools.BaseInteractor module
      • src.sas.sasgui.plottools.LabelDialog module
      • src.sas.sasgui.plottools.LineModel module
      • src.sas.sasgui.plottools.PlotPanel module
      • src.sas.sasgui.plottools.PropertyDialog module
      • src.sas.sasgui.plottools.RangeDialog module
      • src.sas.sasgui.plottools.SimpleFont module
      • src.sas.sasgui.plottools.SizeDialog module
      • src.sas.sasgui.plottools.TextDialog module
      • src.sas.sasgui.plottools.arrow3d module
      • src.sas.sasgui.plottools.binder module
      • src.sas.sasgui.plottools.canvas module
      • src.sas.sasgui.plottools.config module
      • src.sas.sasgui.plottools.convert_units module
      • src.sas.sasgui.plottools.fitDialog module
      • src.sas.sasgui.plottools.fittings module
      • src.sas.sasgui.plottools.plottable_interactor module
      • src.sas.sasgui.plottools.plottables module
      • src.sas.sasgui.plottools.toolbar module
      • src.sas.sasgui.plottools.transform module

and then we got these four "Module contents" moments, no cap:

  • Module contents
  • Module contents
  • Module contents
  • Module contents
  • genindex
  • modindex
  • search

πŸ‘‘ AUTHOR πŸ‘‘

The SasView Project

2017, The SasView Project


peace out bestie, this was SASVIEW(1) version 4.1, dated Oct 30, 2017 πŸ’…βœ¨πŸ¦‹