.. xcal documentation master file, created by
   sphinx-quickstart on Thu Dec  1 22:51:42 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

XCAL -- Calibrate X-ray System Spectrum
========================================
XCAL provides a comprehensive solution for X-ray system spectral estimation, leveraging calibration data with known materials and dimensions. Key features and benefits include:

- **Parametric-Based Method**: Utilizes a parametric approach to accurately estimate X-ray system spectrum.

- **Flexibility Across X-Ray Systems**: Designed to be adaptable, the software can be employed with a wide range of X-ray systems, accommodating different parameters and constraints.

- **Built on PyTorch**: Incorporates PyTorch for automatic differentiation, facilitating the use of standard optimization algorithms for more efficient and accurate estimations.

- **Ease of Use**: While focusing on technical robustness, XCAL also aims to provide a user-friendly interface and comprehensive documentation, making it accessible to a broad audience.

Target Audience
----------------

The software is intended for:

- Medical imaging and radiology professionals seeking precise spectral estimation of X-ray systems.
- Industrial users who rely on X-ray technology for material analysis and quality control.


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. toctree::
   :hidden:
   :maxdepth: 5
   :caption: User Guide

   overview
   install
   demo
   examples
   api
   credits

.. toctree::
   :hidden:
   :maxdepth: 5
   :caption: Developer Guide

   docs