Skip to content

Angular correlation code adde to extra.utils #485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TimBerberich wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Angular correlation code adde to extra.utils #485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d3195ef
Adds application.xcca a toolbox for X-ray cross-correlation analysis.
TimBerberich Jun 1, 2026
6fe1175
removed unused variable
TimBerberich Jun 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/applications/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ Applications index:
- [CookieboxCalibration][extra.applications.CookieboxCalibration]
- [Grating](grating.md)
- [Grating2DCalibration][extra.applications.Grating2DCalibration]
- [XCCA](xcca.md)
27 changes: 27 additions & 0 deletions docs/applications/xcca.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# X-ray cross-correlation analysis (XCCA)
This is a toolbox containing classes to easily compute
the averaged angular cross-correlation.

## Angular cross-correlation

::: extra.applications.xcca.AngularCorrelator

::: extra.applications.xcca.AveragedAngularCorrelation
options:
inherited_members: false

::: extra.applications.xcca.AveragedAngularCorrelationMasked
options:
inherited_members: false

## Incremental variance

::: extra.applications.xcca._CumulativeVarianceBase

::: extra.applications.xcca.CumulativeVariance
options:
inherited_members: false

::: extra.applications.xcca.CumulativeVarianceMasked
options:
inherited_members: false
1 change: 1 addition & 0 deletions docs/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ Added:
- [TOFAnalogResponse][extra.applications.TOFAnalogResponse] can deconvolve the Auger-Meitner
and photon line if the flag `deconvolve` is set to True.
summary about a pulse pattern (!435).
- [XCCA](applications/xcca.md) Toolbox for the computation of X-ray cross-correlation analysis related quantities.

Fixed:

Expand Down
Loading