move specific functions from V3 chx_generic_fn to specific modules
Open
Nobody has claimed this yet.
V3
- Dominant language
- Jupyter Notebook
- Stars
- 8
- Forks
- 12
- Avg merge
- 2h 53m
- Merged PRs (30d)
- 6
Description
If we do this, they become easier to find for a common library and are seen to by a wider audience. We should keep the docstring attributes to @yugangzhang.
Stopped for now because this is starting to seem like a V3 problem.
Table of functions and where they can go
| Function | Move to | Comments |
|---|---|---|
| sgolay2d | _commonspeckle. or skbeam.core.utils | |
| apply_mask | _commonspeckle or skbeam.core.roi | |
| get_max_countc | _commonspeckle or skbeam.core.roi | roi has some of these functions, but for frames. same function is in chx_speckle* |
high level plotting functions that may be generally useful to set aside
show_img
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
Start by reading the V3 chx_generic_fn module and the listed destinations, including _commonspeckle, skbeam.core.utils, and skbeam.core.roi. Compare the locations of sgolay2d, apply_mask, and get_max_countc, while preserving the @yugangzhang docstring attribution; the issue notes that this work is currently stopped and may belong in V3.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100