libcrystfel index page

Abstract

This is the internal documentation for CrystFEL. Unless you are looking at the code, writing new programs or fixing bugs, you should not need to read this. You might use the information here when reading the code or to better understand how the software works, or refer to it when creating a new program within the suite.

API revision 18.

Coding standards

Please see the section on coding standards for CrystFEL's coding style rules (including libcrystfel and the core CrystFEL programs).

API documentation

• The image structure and image data file handling
• Handling reflection data:
  • Reflection list structure
  • Reflection list utility functions
• Unit cells:
  • Unit cell structure
  • Unit cell utility functions
• Crystal structure
• Geometry of diffraction (prediction/partiality calculations)
• Peak search
  • Main peak search functions
  • The peakfinder8 algorithm
• Image (noise) filters
• Point group symmetry
• Mathematical constructions:
  • Integer matrices
  • Rational numbers (including rational matrices)
• Top-level indexing system
• Prediction refinement
• Integration of reflections
• Contents of geometry files
• Detector geometry descriptions
• Radiation spectrum object
• Stream format for indexing/integration results
• Colour scale
• Thread pool
• Miscellaneous utility functions