xcal

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 xcal
      • Option 1: Clean install from dev_scripts
      • Option 2: Manual install
  • Demos
    • Running Included Demo Scripts
  • Advanced Examples
    • List of Examples
      • Tutorial 01: Model-Based Spectral Calibration using LEAP
        • X-ray System Setup
        • A. Simulate multi-energy dataset using LEAP projector
        • B. Spectral Calibration
      • Tutorial 02: Model-Based Spectral Calibration using MBIRJAX
        • X-ray System Setup
        • A. Simulate multi-energy dataset using MBIRJAX projector
        • B. Spectral Calibration
      • Tutorial 03: Implementing an interpolation module for an X-ray component to allow gradient descent
        • Introduction
        • A. Interpolation Model of Transmission Source
        • A3. Usage of Transmission Source
      • B. An Example of Estimating Target Thickness.
        • B1. Data Simulation
        • B2. Estimation
      • Tutorial 04: Implementing an analytical module for an X-ray component to allow gradient descent
        • What You Will Need
        • What You Will Expect
        • A1. Background
        • A2. Step-by-Step Implementation
      • B. An Example of Estimating Filter Thickness
  • API reference
    • xcal
      • 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()
    • xcal.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()
    • xcal.phantom
      • generate_circle_masks()
      • detect_hough_circles()
      • segment_object()
  • Credits
    • XCAL Publication
    • XCAL Development Team
    • XCAL Sponsors
    • Citation

Developer Guide

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

© Copyright 2022-2023, Xcal Development Team.

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