Skip to content

Commit

Permalink
Merge pull request #2411 from EdgarGF93/update_changelog
Browse files Browse the repository at this point in the history
changelog: fiber features
  • Loading branch information
kif authored Jan 30, 2025
2 parents ed9001b + b4f1f9f commit ef9cb95
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions doc/source/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,27 @@ Change-log of versions
* available in Python, Cython & OpenCL
* `Performances charts for sigma-clip & median filter <https://github.com/silx-kit/pyFAI/blob/main/doc/source/usage/tutorial/AzimuthalFilter.ipynb>`_.

- New FiberIntegrator class for grazing-incidence/fiber scattering data (former fiber/gi methods in a new API)

* FiberIntegrator located in ``pyFAI.integrator.fiber``
* Usage tutorial in `doc/source/usage/tutorial/FiberGrazingIncidence.ipynb` or https://www.silx.org/doc/pyFAI/dev/usage/tutorial/FiberGrazingIncidence.html
* `integrate2d_grazing_incidence` method to display qIP - qOOP patterns. New API with minimum inputs
* `integrate1d_grazing_incidence` method to perform qIP or qOOP slices. New API with minimum inputs
* Corrected equations to handle `incident_angle` and `tilt_angle` parameters
* 8 possible `sample_orientation` (1-8), to rotate and flip the qIP-qOOP maps (or other units)
* `integrate2d_polar` to represent the polar angle (arctan(qOOP/qIP)) versus the q modulus
* `integrate1d_polar` to integrate the polar angle map (vertical or horizontal)
* `integrate2d_exitangles` to reshape the diffraction pattern into horizontal and vertical exit angles, with the origin in the sample horizon
* `integrate1d_exitangles` to perform an integration across one of the exit angles
* Faster calculation with `numexpr` package formulas

- New MultiGeometryFiber in `pyFAI.multi_geometry`

* Analog to MultiGeometry class.
* Instead of taking a list of AzimuthalIntegrators, it takes a list of FiberIntegrators
* Access to integrate1d and integrate2d grazing_incidence/fiber methods
* New tutorial of usage in doc/source/usage/tutorial/MultiGeometry/MultiGeometryFiber.ipynb`

- Tool to rebin 2d-result into 1d-result (`pyFAI.containers.rebin1d`)
- Several bug-fixes & better code coverage
- Supports python 3.8 .. 3.13. The GIL-free version on python 3.13 is untested
Expand Down

0 comments on commit ef9cb95

Please sign in to comment.