The crystfel_utils Module

CrystFEL utilities.

This module contains Python reimplementations of some functions from the CrystFEL software package.

load_crystfel_geometry(filename)[source]

Loads a CrystFEL geometry file.

This function is a reimplementation of the get_detector_geometry_2 function from CrystFEL. It reads information from a CrystFEL geometry file.

For a full documentation of the CrystFEL geometry format, see the relevant man page.

The function returns a dictionary with the geometry information.

  • The CrystFEL geometry file uses a key/value language. The keys in the returned dictionary match the keys in the geometry file.
  • The dictionary values store the corresponding values.
  • The code of this function is currently synchronized with the code of the function ‘get_detector_geometry_2’ in CrystFEL at commit 41a8fa9819010.
Parameters:filename (str) – the absolute or relative path to a CrystFEL geometry file.
Returns:a dictionary with the geometry information loaded from the file.
Return type:Dict[str, Any]