Skip to content

RegisterQD v1.0.0 API review#55

Merged
kdw503 merged 9 commits into
masterfrom
dwk/mng
May 26, 2026
Merged

RegisterQD v1.0.0 API review#55
kdw503 merged 9 commits into
masterfrom
dwk/mng

Conversation

@kdw503
Copy link
Copy Markdown
Member

@kdw503 kdw503 commented May 26, 2026

Summary

  • Breaking: rotation_gridsearch SD is now a keyword argument; positional callers must update to ; SD=mySD
  • Non-breaking: qsmooth(img) defaults output eltype to float(eltype(img)) instead of hardcoded Float32; default_minrot accepts AbstractArray directly; removed always-erroring deprecated stubs for old qd_rigid/qd_affine signatures; documented thresh defaults and minwidth_rot/minwidth_mat subspace semantics
  • Bumped to v1.0.0; updated compat and CI; fixed pre-existing RegisterCore/RegisterMismatch v1 compatibility breaks

Test plan

  • Pkg.test("RegisterQD") passes (34 tests across 6 test sets; gridsearch tests are slow, ~3–4 min)
  • Test.detect_ambiguities(RegisterQD) returns 0
  • Confirm rotation_gridsearch(...; SD=mySD) keyword form works and old positional form raises MethodError

🤖 Generated with Claude Code

kdw503 and others added 9 commits May 26, 2026 11:58
- Replace removed `indmin_mismatch` with `argmin_mismatch` (RegisterCore v1
  renamed it following Julia's indmin→argmin convention)
- Replace deprecated 3-arg `ratio(nd, thresh, fillval)` with keyword form
  `ratio(nd, thresh; fillval=fillval)` (7 sites)
- Replace deprecated `mismatch0` with `mismatch_zeroshift` (3 sites)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
SD was the 6th positional argument with a default, inconsistent with qd_rigid
and qd_affine where SD is a keyword. Callers using `rotation_gridsearch(...,
SD=mySD)` got UndefKeywordError.

Moves SD after the semicolon; updates the docstring and gridsearch test.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Version 1.0.0
- CenterIndexedArrays, RegisterCore, RegisterDeformation, RegisterMismatch all
  bumped to v1 compat
- Julia LTS floor raised to 1.10
- CI: use julia-actions/setup-julia@v2, min version matrix entry, codecov v5
  with token secret
- TagBot: switch to TAGBOT_TOKEN secret

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
The convenience overload `qsmooth(img)` previously hardcoded `Float32` as the
compute/output eltype. It now defaults to `float(eltype(img))`, so Float64
images stay Float64. Users who need a specific eltype can still call
`qsmooth(Float32, img)` explicitly.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Old-signature callers now get a MethodError pointing at the real
signatures instead of a hand-written ErrorException.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
qd_affine uses thresh=0.5x (stricter overlap) vs the 0.1x default in
qd_translate and qd_rigid because affine's extra degrees of freedom
make degenerate low-overlap solutions more likely. Add an explanatory
comment at the default and document the default value in the
qd_affine and qd_translate docstrings (qd_rigid already had it).

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Callers can now pass an image directly instead of wrapping it in
CartesianIndices(img). No dispatch ambiguity: the existing
CartesianIndices method is strictly more specific.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
These keyword names encode meaningful subspace distinctions: minwidth_rot
controls rotation-parameter resolution only (not translation), and
minwidth_mat controls linear-map-parameter resolution only. Both are
combined internally with a fixed translation minwidth via vcat. Added
explanatory notes to the qd_rigid and qd_affine_fine docstrings to make
this clear and distinguish from the full-space minwidth in qd_translate.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@kdw503 kdw503 closed this May 26, 2026
@kdw503 kdw503 reopened this May 26, 2026
@kdw503 kdw503 merged commit 9265118 into master May 26, 2026
4 of 8 checks passed
@kdw503 kdw503 deleted the dwk/mng branch May 26, 2026 19:34
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.

1 participant