Welcome to xpdtools’s documentation!

This project holds data processing tools and command line interfaces for processing data from images to integrated intensities and atomic pair distribution functions. The tools are put together via a streamz pipeline.

Installation

xpdtools is installable via the conda package manager. If you don’t have Anaconda (or miniconda) installed please follow the instructions from Data Carpentry.

With Anaconda or miniconda please enter into a terminal (on Windows Anaconda ships with a dedicated command prompt) and type

conda install xpdtools -c conda-forge

and follow the prompts. This will install the xpdtools software and all of its dependencies.

Please check that the software is installed by typing in the terminal (in any directory), image_to_iq -- --help. This should display a help description of how to use the image_to_iq command line interface.

Quickstart

To use the command line interface (CLI) type image_to_iq <poni_file> <image_file>. For more information about CLI options image_to_iq -- --help will provide the help information.

Note that you will need pyFAI calibration files (.poni files) which are generated via pyFAI-calib. For most usages the pyFAI calibration is pyFAI-calib -D Perkin -w <wavelength> -c Ni <calibration_img>. Please see pyFAI’s documentation and see our docs for how to use pyFAI.

Contents:

• Tips and Tricks
  • Weak Scattering and Air Scattering
  • Median vs. Mean masking
• xpdtools package
  • Subpackages
    • xpdtools.cli package
      • Submodules
      • xpdtools.cli.process_tiff module
      • Module contents
    • xpdtools.pipelines package
      • Submodules
      • xpdtools.pipelines.raw_pipeline module
      • Module contents
  • Submodules
  • xpdtools.calib module
    • img_calibration()
  • xpdtools.dev_utils module
  • xpdtools.shim module
    • PDFGetterShim
  • xpdtools.tools module
    • binned_outlier()
    • call_stream_element()
    • check_in()
    • check_kwargs()
    • decomp()
    • fq_getter()
    • generate_binner()
    • generate_map_bin()
    • ignore_streamz_input()
    • load_geo()
    • map_to_binner()
    • mask_img()
    • move_center()
    • nu_fq_getter()
    • nu_pdf_getter()
    • overlay_mask()
    • pdf_getter()
    • pluck_check()
    • polarization_correction()
    • progress_decorator()
    • splay_tuple()
    • sq_getter()
    • z_score_image()
  • Module contents

Indices and tables

• Index

• Module Index

• Search Page