From 17b598da3fbfbcdc9d749c6291f234fef5417b56 Mon Sep 17 00:00:00 2001 From: Paullo9 Date: Sat, 31 Oct 2026 01:18:46 +0100 Subject: [PATCH] docs: list the public Parallax and Ptychography types in DocC topics CuboParallax: the streamed preprocessing result, stack retention, the aberration fit options, results and method, the physical shift, the basis convention and the highpass behaviour now sit in the Preprocessing and Aberrations groups. CuboPtycho: a new Preparation group (preparation options, prepared result, scan geometry, origins, padding, shift, amplitudes), the precision, error normalisation and position correction under Processing, and an Errors group with MixedstateZeroPixelError. PtychographyPreparationOptions and PreparedPtychography were missing too and are listed. Fixes #33 Done: every top-level public type of both modules is in a Topics group. Next: none for this issue. Co-Authored-By: Claude Opus 5.5 --- .../CuboParallax.docc/CuboParallax.md | 10 ++++++++++ .../CuboPtycho/CuboPtycho.docc/CuboPtycho.md | 19 ++++++++++++++++++- 2 files changed, 28 insertions(+), 1 deletion(-) diff --git a/Sources/CuboParallax/CuboParallax.docc/CuboParallax.md b/Sources/CuboParallax/CuboParallax.docc/CuboParallax.md index a157090..6350b6f 100644 --- a/Sources/CuboParallax/CuboParallax.docc/CuboParallax.md +++ b/Sources/CuboParallax/CuboParallax.docc/CuboParallax.md @@ -55,12 +55,22 @@ stack, shifts and probe angles as separate calls. Defaults are py4DSTEM's; the p - ``ParallaxPreprocessing`` - ``ParallaxPreprocessingResult`` +- ``ParallaxStreamedPreprocessingResult`` +- ``ParallaxStackRetention`` ### Aberrations - ``ParallaxAberrationFitter`` - ``ParallaxAberrationTerm`` +- ``ParallaxAberrationFitMethod`` +- ``ParallaxLowOrderAberrationOptions`` +- ``ParallaxAberrationFitResult`` +- ``ParallaxHigherOrderAberrationOptions`` +- ``ParallaxHigherOrderAberrationFitResult`` +- ``ParallaxPhysicalShift`` +- ``ParallaxBasisConvention`` - ``ParallaxAberrationCorrection`` +- ``ParallaxHighpassBehavior`` - ``ParallaxCorrectionResult`` ### Depth sectioning and subpixel upsampling diff --git a/Sources/CuboPtycho/CuboPtycho.docc/CuboPtycho.md b/Sources/CuboPtycho/CuboPtycho.docc/CuboPtycho.md index 030ab18..0d73d2d 100644 --- a/Sources/CuboPtycho/CuboPtycho.docc/CuboPtycho.md +++ b/Sources/CuboPtycho/CuboPtycho.docc/CuboPtycho.md @@ -8,18 +8,35 @@ CPU ptychography preprocessing, probe construction and single-slice, mixed-state - -### Processing +### Preparation - ``PtychographyPreparation`` +- ``PtychographyPreparationOptions`` +- ``PreparedPtychography`` +- ``PtychographyScanGeometry`` +- ``PtychographyOrigins`` +- ``PtychographyPadding`` +- ``PtychographyShift`` +- ``PtychographyAmplitudes`` + +### Processing + - ``PtychographyProbe`` - ``PtychographyAberrationTerm`` - ``SingleslicePtychography`` - ``MixedstatePtychography`` - ``MultislicePtychography`` +- ``PtychographyPrecision`` +- ``PtychographyErrorNormalization`` +- ``PtychographyPositionCorrection`` - ``PtychographyStack`` - ``PtychographyArray`` - ``PtychographyPosition`` + +### Errors + - ``PtychographyError`` +- ``MixedstateZeroPixelError`` ### Supported scope