NIST Scan Framework Documentation

• Introduction
• Installing the NIST scan framework
• Creating scan experiments
  • Getting Started with Scans
    • Creating a 1D Scan
    • Creating a Scan Model
  • Processing and handling of scan data
    • Generating statistics and mutating datasets
    • Performing fits
    • Avoiding bad fits: fit validations
    • Custom handling of fits
    • Setting fit guesses in the GUI
  • Core scan features
    • Pausing, resuming, & early termination
    • Passes
    • Broadcast, Persist, and Save
    • Current Scan Namespace
    • Monitoring Histograms
    • Profiling
  • Relative scan ranges and auto tracking
    • Relative scan ranges
    • Auto-tracking
  • Time & frequency scans
    • Time scans
    • Frequency scans
    • Time/frequency scans
  • Performing multiple measurements
    • Multiple measurements without models
    • Multiple measurements when using models
  • Performing calculations
  • Running warmup points
  • Monitor histograms
  • 2D Scans
    • The calculate_dim0 Callback
    • Example 2D Scan
  • Lost ion detection and reloading
    • Lost Ion Re-Loading
• Using models for data processing
  • Getting stated with models
    • Namespaces
    • Re-Binding
    • Broadcast, Persist, & Save
    • Dataset Mirroring
  • Configuring fits
  • Validating fitted parameters
    • The three types of validators
    • Validation Methods
  • Formatting the appearance of plots
  • Accessing the scan inside a scan model
  • Creating Histograms
    • Binning multiple values at once
    • Binning Continuous Values
    • Plots
• Scans references and API docs
  • Callbacks
    • User Callbacks
    • Extension Callbacks
  • Methods Available to a Scan
    • User Interface Methods
    • User Helper Methods
    • Extension Interface Methods
  • Scan configuration
  • Applets
    • Current scan applet
    • Count monitor applet
    • Current histogram applet
    • Current aggregate histogram applet
    • Current scan applet for the ARTIQ browser
    • Current sub-scan applet (for 2D scans)
    • Current sub-scan applet (For 2D scans, no fits)
  • Full API documentation for scans
    • scans.scan module
    • scans.extensions module
    • scans.loading_interface module
    • Scan Architecture
• Models reference and API docs
  • Datasets
    • current_scan namespace
    • current_scan.fits namespace
    • current_scan.plots namespace
    • current_hist namespace
  • Configurations reference
    • Datset configurations
    • Fitting configurations
    • Fit validation configurations
    • Plotting configurations
    • Enabling/disabling features
  • Checking the state of a scan model
  • Full API documentation for models
    • models.model module
    • models.scan_model module
    • models.hist_model module
    • models.fit_model module
    • models.time_model module
    • models.freq_model module
    • models.time_freq_model module
• Curve fitting
  • Full API documentation for curve fitting
    • analysis.curvefits module
• Applets
  • Full API documentation for applets
    • applets.plot module
    • applets.plot_hist module
    • applets.plot_hist_ntrace_white module
    • applets.plot_xy module
    • applets.plot_xy_ntrace_white module