xspec

User Guide

  • Overview and Introduction
    • User Inputs
    • Key Features and Strengths
      • Based on a Parametric Model
      • Separable Model: Source, Filter, and Scintillator
      • Enables Joint Parameter Estimation
      • Modular Design
  • Installation
    • Step 1: Clone repository
    • Step 2: Install xspec
      • Option 1: Clean install from dev_scripts
      • Option 2: Manual install
  • Getting Started/Tutorial
    • 0. Jupyter Notebooks Tutorials
      • Example Dependencies
    • 1. Total X-ray System Response
      • Examples: Spectral Models
        • (LTT) Configure Source Model using class: Reflection_Source
        • (Spekpy) Configure Source Model using class: Reflection_Source
        • Configure Filter Model using class: Filter
        • Configure Scintillatro Model using class: Scintillator
        • Customizing X-ray System Components Classes
    • 2. Forward Modeling
      • How to get A?
      • Examples: Forward Matrix
        • Homogenous object detection tools
        • Forward Matrix Calculation with a Custom Forward Projector
    • 3. Estimate System Parameters by Solving Inverse Problem
      • Examples: Spectral Estimation
        • Simulated Datasets with different source voltages and same filters
        • Spectral Estimation with 3 different voltages
  • API reference
    • xspec
      • Estimate
        • Estimate.add_data()
        • Estimate.fit()
        • Estimate.get_spec_models()
        • Estimate.get_spectra()
        • Estimate.get_params()
        • Estimate.get_all_estimates()
      • Material
      • calc_forward_matrix()
      • get_filter_response()
      • get_scintillator_response()
    • xspec.models
      • Base_Spec_Model
        • Base_Spec_Model.set_spectrum()
        • Base_Spec_Model.forward()
        • Base_Spec_Model.set_params()
        • Base_Spec_Model.get_params()
      • Reflection_Source
        • Reflection_Source.set_src_spec_list()
        • Reflection_Source.forward()
      • Transmission_Source
        • Transmission_Source.set_src_spec_list()
        • Transmission_Source.forward()
      • Filter
        • Filter.forward()
      • Scintillator
        • Scintillator.forward()
    • xspec.phantom
      • generate_circle_masks()
      • detect_hough_circles()
      • segment_object()
  • Demos
    • Running Included Demo Scripts
  • Credits
    • XSPEC Development Team
    • XSPEC Sponsors
    • Distribution Statement
    • Citation
  • References

Developer Guide

  • Build documentation with Sphinx
    • Build HTML locally
xspec
  • Search

© Copyright 2022-2023, XSpec Development Team.

Built with Sphinx using a theme provided by Read the Docs.