Skip to content

v1.4.0

Latest
Latest
Compare
Choose a tag to compare
@leofang leofang released this 24 Feb 18:03
· 28 commits to master since this release
v1.4.0
03c9b0b

The new release v1.4.0 contains a number of new features (some are experimental, see below) and bug fixes.

As a kind reminder, users of this software should cite our papers (DOI: 10.1109/NYSDS.2018.8538964; another in preparation). While this is not a mandatory requirement as per our software license, it does offer a strong incentive and justification for us to seek support for maintaining and enhancing the software.

On the frontend:

  • Support both HXN and CSX databrokers (#65):
    • A new check "Assoc. scans" is added next to the main scan number. An input string like 1234-1236, 1238 can be resolved to 1234, 1235, 1236, 1238 as expected. The associate scan numbers are memorized during shutdown. (#87)
    • For CSX experiments, the dark/flat scans associated with the main scan can corbe set in "Assoc. scans" for pre-processing scan data and visualization.
    • To access CSX databroker, csxtools v0.1.15+ is required.
    • Internally, a set of APIs is defined in nsls2ptycho/core/databroker_api.py for databroker access. This allows future extension to support other beamlines. (#10)
  • The "RESET" button in the ROI window can be used to reset all parameters and ROIs now. (#81)
  • Fix startup error when databroker is not present on HXN/CSX machines. (#86)
  • Fix red ROIs sometimes cannot be re-selected. (#78)
  • Fix the parameters in the ROI window being mistakenly memorized. (#79)
  • Fix an error when the red ROI's dimensions are odd numbers. (#82)
  • Fix the limitation for Bragg input fields.
  • Other internal fixes, cleanups, and refactoring (#64, #83, #85, #87)

On the backend:

  • Add two new solvers mADMM & PM (NSLS-II/ptycho#44):
    • This is currently an experimental feature and will be stabilized in the next release (v1.5.0).
    • To use them in the GUI, follow the steps below:
      1. Select "DM" as the algorithm in the "Reconstruction parameters" tab
      2. Switch to the "Advanced option 1" tab
      3. For mADMM, set “DM ver.” to be 8; for PM, set it to be 9.
      4. To switch between "Poisson" and "Gaussian", set it in the "ML mode".
      5. To change the weight "lambda" for mADMM, set it in the "ML weight".
    • Users of the new solvers are advised to cite New J. Phys. 22 023035 (2020).
  • Support necessary changes in the frontend (NSLS-II/ptycho#48)
Assets 2
Loading