pygid Documentation

Welcome to the pygid documentation!

pygid is a Python-based package for fast conversion of 2D detector images into reciprocal (Cartesian and polar) coordinates. It focuses on grazing-incidence geometry but can also be used for transmission (SAXS/WAXS) experiments.

Key features include:

• Conversion of area detector images to Cartesian, polar, and pseudopolar coordinates.

• Support for grazing-incidence and transmission geometries.

• Radial and azimuthal profiling.

• Batch processing and metadata management.

• Simulation of GIWAXS peak positions using CIF files (pygidSIM).

• Saves results in NXsas (NeXus) format.

• Reusable coordinate maps for multiple images.

• Plotting and several interpolation techniques.

Outline

• Quick Start
  • How to use
• Tutorials
  • Tutorial 1: Experimental Parameters
  • Tutorial 2: Coordinate Maps and Intensity Corrections
  • Tutorial 3: Raw Image Loading
  • Tutorial 4: Two-Dimensional Conversion Functions
  • Tutorial 5: Line Profiles
  • Tutorial 6: Experimental and Sample Metadata
  • Tutorial 7: Angular scans
  • Tutorial 8. Batch Processing
  • Tutorial 9: GID pattern simulation
  • Tutorial 10. Transmission Geometry and GISAXS
  • Tutorial 11. Operations with Saved Data
• File Format
  • Data format