[v2][_commonspeckle] two time correlation function for image input data is broken
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 8
- Forks
- 12
- Avg merge
- 2h 53m
- Merged PRs (30d)
- 6
Description
pyCHX.chx_correlation.two_time_corr don't edit unless needed now by CHX
pyCHX._v2.chx_correlation.two_time_corr is equivalent to what is found in sckit-beam. This function is unique in that it allows for a mult-tau - like calcuation of the two-time autocorrelation function.
This function used in a CSX environment runs into a IndexError exception. All the other basic functions that are simliar between sckit-beam and pyCHX work as expected.
- need to diff these two library functions to see if there is a difference in the code
- identify fix and fix
pyCHX._v2.chx_correlation.two_time_corr.
As discussed with @afluerasu, @yugangzhang 's code here is unique and is nice to keep. Paper pending. Note that xi-cam is using this function in skbeam.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare pyCHX._v2.chx_correlation.two_time_corr with the equivalent scikit-beam function first, then reproduce the IndexError with CSX image input data. Identify the difference and update only pyCHX._v2.chx_correlation.two_time_corr; leave pyCHX.chx_correlation.two_time_corr unchanged unless needed. Done means the function no longer raises IndexError and retains its intended mult-tau-like two-time autocorrelation behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100