Welcome to xypattern’s documentation!

xypattern is a simple small library to handle x-y patterns, such as those collected with x-ray diffraction or Raman spectroscopy.

Features

• Load and save patterns from/to various file formats (.xy, .chi, .fxye)

• Apply scaling, offset, and smoothing to patterns

• Background subtraction (manual or automatic)

• Pattern manipulation (limiting, extending, deleting ranges)

• Mathematical operations (addition, subtraction, multiplication)

• Pattern transformation (x-axis transformation)

• Pattern rebinning

• Pattern serialization to/from dictionaries

Contents:

• Installation
  • Requirements
  • Development Installation
• Usage
  • Reading a file
  • Using a background pattern
  • Automatic background subtraction
  • Pattern manipulation
  • Scale and stitch multiple patterns
  • Pattern serialization
• API Reference
  • Pattern
  • Auto Background
  • Combine
  • Utilities
• Contributing
  • Setting up the development environment
  • Running tests
  • Code style
  • Submitting changes
• Changelog
  • 1.2.3 (2025-09-26)
  • 1.2.2 (2025-03-20)
  • 1.2.1 (2025-03-20)
  • 1.2.0 (2025-03-04)
  • 1.1.2 (2024-03-14)
  • 1.1.1 (2024-03-13)
  • 1.1.0 (2024-03-13)
  • 1.0.5 (2013-11-14)
  • 1.0.4 (2023-11-13)
  • 1.0.3 (2023-11-13)
  • 1.0.2 (2023-10-14)
  • 1.0.1 (2023-10-14)
  • 1.0.0 (2023-10-13)

Indices and tables

• Index

• Module Index

• Search Page