Skip to content

Commit a4103fc

Browse files
committed
change documentation location to applications.
1 parent 1c8735c commit a4103fc

4 files changed

Lines changed: 29 additions & 24 deletions

File tree

docs/applications/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ Applications index:
88
- [CookieboxCalibration][extra.applications.CookieboxCalibration]
99
- [Grating](grating.md)
1010
- [Grating2DCalibration][extra.applications.Grating2DCalibration]
11+
- [XCCA](xcca.md)

docs/applications/xcca.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# X-ray cross-correlation analysis (XCCA)
2+
This is a toolbox containing classes to easily compute
3+
the averaged angular cross-correlation.
4+
5+
## Angular cross-correlation
6+
7+
::: extra.applications.xcca.AngularCorrelator
8+
9+
::: extra.applications.xcca.AveragedAngularCorrelation
10+
options:
11+
inherited_members: false
12+
13+
::: extra.applications.xcca.AveragedAngularCorrelationMasked
14+
options:
15+
inherited_members: false
16+
17+
## Incremental variance
18+
19+
::: extra.applications.xcca._CumulativeVarianceBase
20+
21+
::: extra.applications.xcca.CumulativeVariance
22+
options:
23+
inherited_members: false
24+
25+
::: extra.applications.xcca.CumulativeVarianceMasked
26+
options:
27+
inherited_members: false

docs/changelog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ Added:
5757
- [TOFAnalogResponse][extra.applications.TOFAnalogResponse] can deconvolve the Auger-Meitner
5858
and photon line if the flag `deconvolve` is set to True.
5959
summary about a pulse pattern (!435).
60+
- [XCCA](applications/xcca.md) Toolbox for the computation of X-ray cross-correlation analysis related quantities.
6061

6162
Fixed:
6263

docs/utilities.md

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -29,27 +29,3 @@ else.
2929
## Fitting functions
3030

3131
::: extra.utils.fit_gaussian
32-
33-
## Incremental variance
34-
35-
::: extra.utils.xcca._CumulativeVarianceBase
36-
37-
::: extra.utils.xcca.CumulativeVariance
38-
options:
39-
inherited_members: false
40-
41-
::: extra.utils.xcca.CumulativeVarianceMasked
42-
options:
43-
inherited_members: false
44-
45-
## Angular cross-correlation (XCCA)
46-
47-
::: extra.utils.xcca.AngularCorrelator
48-
49-
::: extra.utils.xcca.AveragedAngularCorrelation
50-
options:
51-
inherited_members: false
52-
53-
::: extra.utils.xcca.AveragedAngularCorrelationMasked
54-
options:
55-
inherited_members: false

0 commit comments

Comments
 (0)