Skip to content

Initial doc changes - #102

Draft
cliulucien wants to merge 9 commits into
PtyLab:mainfrom
cliulucien:initial_doc_changes
Draft

cliulucien wants to merge 9 commits into
PtyLab:mainfrom
cliulucien:initial_doc_changes

Conversation

@cliulucien

@cliulucien cliulucien commented Sep 23, 2026 •

Copy link
Copy Markdown

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 size dxd after binning, depending on the intended convention.
  • relative_intensity() is documented as comparing a frame to the brightest one, but the implementation normalizes by mean + 2 * std instead of the maximum intensity.

Reconstruction.py

  • force behavior differs between initializeObject() and initializeProbe() and may deserve cleanup.
  • expand_npsm in load_probe() is currently unused. Determine whether this is legacy API or an unfinished feature.
  • Check _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 object and I probe store amplitudes (abs) rather than intensities (abs**2).

@cliulucien
cliulucien marked this pull request as draft September 23, 2026 09:58
@ShantanuKodgirwar

ShantanuKodgirwar commented Sep 24, 2026 •

Copy link
Copy Markdown
Contributor

HI @cliulucien, looks like some serious bugs. If you see them, please report it separately under issues and if you fix those, please do so with a separate PR tagging those issues.

Integrated intensity of each measurement frame.

maxProbePower (float):
Maximum integrated-amplitude scale derived from the ptychogram.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't very clear sounding to me. Can we rephrase?

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants