Skip to content

docs: list the public Parallax and Ptychography types in DocC topics #50

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

Merged
Paullo9 merged 1 commit into from
Oct 31, 2026
Merged

docs: list the public Parallax and Ptychography types in DocC topics #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions Sources/CuboParallax/CuboParallax.docc/CuboParallax.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
19 changes: 18 additions & 1 deletion Sources/CuboPtycho/CuboPtycho.docc/CuboPtycho.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,35 @@ CPU ptychography preprocessing, probe construction and single-slice, mixed-state

- <doc:Preparing-a-reconstruction>

### 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

Expand Down
Loading