Initial doc changes - #102
Draft
cliulucien wants to merge 8 commits into
Draft
cliulucien wants to merge 8 commits into
cliulucien wants to merge 8 commits into
Conversation
cliulucien
marked this pull request as draft
September 23, 2026 09:58
…tyLab.py into initial_doc_changes
…ot faimliar with FPM.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up issues noticed during documentation review
ExperimentalData.py
binData()updates the ptychogram but does not refresh derived detector/data quantities via_setData(). It may also need to update the effective detector pixel sizedxdafter binning, depending on the intended convention.relative_intensity()is documented as comparing a frame to the brightest one, but the implementation normalizes bymean + 2 * stdinstead of the maximum intensity.Reconstruction.py
initializeObject()andinitializeProbe()and may deserve cleanup.expand_npsminload_probe()is currently unused. Determine whether this is legacy API or an unfinished feature._center_probe_angle(): np.squeeze(self.probe)[0]becomes 1D for single-mode probes but 2D for multi-mode probes.saveResults(): Use context managers consistently for FPM and probe-stack output to ensure HDF5 files are closed.I objectandI probestore amplitudes (abs) rather than intensities (abs**2).