Rename parameters to more general/accurate/interprettable names
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 160
- Forks
- 113
- Avg merge
- 12d 15h
- Merged PRs (30d)
- 1
Description
A number of parameters have names that could be improved. With the next major release breaking backwards compatibility, it could be an opportune time to make these changes.
Where possible, old function names should remain (maybe tagged as deprecated for removal in 5.0?) so that other libraries, e.g. SIRF, can update at a more convenient time.
This issue was spun off from a discussion in #422.
Variables to be renamed: (TODO, update this list with PLS and others)
- HKEM
sigma_m->prior image intensity Gaussian scaling - HKEM
sigma_dm->prior image distance Gaussian scaling - HKEM
sigma_p->current estimate intensity Gaussian scaling - HKEM
sigma_dp->current distance intensity Gaussian scaling - HKEM
number of neighbours->neighbourhood diameter - HKEM
number of non-zero feature elements->feature vector length
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 with the discussion in #422 and the HKEM parameter list in this issue. Determine the full rename scope, including the TODO items such as PLS, and how existing function names should remain available or be deprecated. Done means the agreed parameters have accurate names and the compatibility approach is documented and implemented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- backend-api-design
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100